SBColorSchemePerOccupancy#

This class describes a color scheme based on atoms’ occupancy.

Please refer to samson.SBNodeColorScheme.

See also

SAMSON SDK: SBDColorSchemePerOccupancy

class samson.SBColorSchemePerOccupancy(*args, **kwargs)#

Bases: SBNodeColorScheme

This class describes a color scheme based on atoms’ occupancy.

Overloaded function.

  1. __init__(self: samson.SBColorSchemePerOccupancy) -> None

  2. __init__(self: samson.SBColorSchemePerOccupancy, nodeIndexer: samson.SBNodeIndexer, colorPalette: samson.SBPalette = None) -> None

Constructs the color scheme for nodeIndexer with the given colorPalette.

Parameters:

  • nodeIndexer (samson.SBNodeIndexer) – A indexer of nodes to which the color scheme is applied

  • colorPalette (samson.SBPalette, default=None) –

    A color palette.

    If None, then the default color palette associated with this color scheme will be used.

getDefaultMaximumValue(self: samson.SBColorSchemePerOccupancy) → SBDQuantityType<SBDQuantityUnitType<SBDQuantityUnitSystemSI,0,0,0,0,0,0,0,0,0,0,0,0,0,0>,double>#

Returns the default maximum value for the attribute bounds determined when constructing the color scheme based on the input node indexer

getDefaultMinimumValue(self: samson.SBColorSchemePerOccupancy) → SBDQuantityType<SBDQuantityUnitType<SBDQuantityUnitSystemSI,0,0,0,0,0,0,0,0,0,0,0,0,0,0>,double>#

Returns the default minimum value for the attribute bounds determined when constructing the color scheme based on the input node indexer

getMaximumValue(self: samson.SBColorSchemePerOccupancy) → SBDQuantityType<SBDQuantityUnitType<SBDQuantityUnitSystemSI,0,0,0,0,0,0,0,0,0,0,0,0,0,0>,double>#

Returns the current maximum value for the attribute bounds used for colorization

getMinimumValue(self: samson.SBColorSchemePerOccupancy) → SBDQuantityType<SBDQuantityUnitType<SBDQuantityUnitSystemSI,0,0,0,0,0,0,0,0,0,0,0,0,0,0>,double>#

Returns the current minimum value for the attribute bounds used for colorization

setMaximumValue(self: samson.SBColorSchemePerOccupancy, arg0: SBDQuantityType<SBDQuantityUnitType<SBDQuantityUnitSystemSI, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>, double>) → None#

Sets the current maximum value for the attribute bounds used for colorization

setMinimumValue(self: samson.SBColorSchemePerOccupancy, arg0: SBDQuantityType<SBDQuantityUnitType<SBDQuantityUnitSystemSI, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>, double>) → None#

Sets the current minimum value for the attribute bounds used for colorization