ColorPaletteSequential

This class is a base class for sequential color palettes.

See also

SAMSON API: SBDColorPaletteSequential

class samson.DataModel.Color.ColorPaletteSequential(*args, **kwargs)

Bases: samson.DataModel.Color.ColorPalette

This class is a base class for sequential color palettes.

Overloaded function.

  1. __init__(self: samson.DataModel.Color.ColorPaletteSequential) -> None

Default constructor

  1. __init__(self: samson.DataModel.Color.ColorPaletteSequential, hue1: int, hue2: int, chroma1: int, maximumChroma: int, chroma2: int, luminance1: int, luminance2: int, chromaPower: float, luminancePower: float, name: str) -> None

Constructs a sequential color palette with the given parameters

  1. __init__(self: samson.DataModel.Color.ColorPaletteSequential, otherColorPalette: samson.DataModel.Color.ColorPaletteSequential) -> None

Constructs a sequential color palette based on the given sequential color palette

class ColorPaletteType(self: samson.DataModel.Color.ColorPalette.ColorPaletteType, value: int) → None

Bases: pybind11_builtins.pybind11_object

Members:

Custom : An undefined type - a custom color palette which does not fall into any of other categories

Qualitative : A qualitative color palette type - for coding categorical information, i.e., where no particular ordering of categories is available and every color should receive the same perceptual weight.

Sequential : A sequential color palette type - for coding ordered/numeric information, i.e., going from high to low (or vice versa).

Diverging : A diverging color palette type - for coding ordered/numeric information around a central neutral value, i.e., where colors diverge from neutral to two extremes.

FlexibleDiverging : A flexible diverging color palette type - for coding ordered/numeric information around a central neutral value, i.e., where colors diverge from neutral to two extremes.

Custom = <ColorPaletteType.Custom: 0>
Diverging = <ColorPaletteType.Diverging: 3>
FlexibleDiverging = <ColorPaletteType.FlexibleDiverging: 4>
Qualitative = <ColorPaletteType.Qualitative: 1>
Sequential = <ColorPaletteType.Sequential: 2>
property name
property value
clone(self: samson.DataModel.Color.ColorPalette) → samson.DataModel.Color.ColorPalette

Returns a copy of the color palette

getColor(self: samson.DataModel.Color.ColorPalette, arg0: float) → samson.DataModel.Type.Color

Returns SBColor based on the palette and an intensity value value which should be in the range [0.0, 1.0]

getColorInPaletteColorSpace(self: samson.DataModel.Color.ColorPalette, arg0: float) → List[float]

Returns color coordinates in this palette’s color space for the given intensity value value which should be in the range [0.0, 1.0]

getColorVector(self: samson.DataModel.Color.ColorPalette, arg0: float) → List[float]

Returns RGB color in a float vector based on the palette and an intensity value value which should be in the range [0.0, 1.0]

static getValueAlongLinearTrajectory(y1: float, y2: float, power: float, x: float) → float

Returns a value along the linear trajectory

static getValueAlongTriangularTrajectory(y1: float, ymax: float, y2: float, power: float, x: float) → float

Returns a value along the triangular trajectory

setChroma(self: samson.DataModel.Color.ColorPaletteSequential, chroma1: int, maximumChroma: int, chroma2: int, chromaPower: float = 1.0) → None
setHue(self: samson.DataModel.Color.ColorPaletteSequential, hue1: int, hue2: int) → None
setLuminance(self: samson.DataModel.Color.ColorPaletteSequential, luminance1: int, luminance2: int, luminancePower: float = 1.0) → None
Custom = <ColorPaletteType.Custom: 0>
Diverging = <ColorPaletteType.Diverging: 3>
FlexibleDiverging = <ColorPaletteType.FlexibleDiverging: 4>
Qualitative = <ColorPaletteType.Qualitative: 1>
Sequential = <ColorPaletteType.Sequential: 2>
property chroma1
property chroma2
property chromaPower
property hue1
property hue2
property isSerializable

Returns true when the class is serializable

property luminance1
property luminance2
property luminancePower
property maximumChroma
property name

The color palette’s name

property reverseFlag

The reverse flag - whether the color palette is mirrored or not

property type

The color palette’s type