colour_visuals.VisualPlanckianLocus

class colour_visuals.VisualPlanckianLocus(method: Literal['CIE 1931', 'CIE 1960 UCS', 'CIE 1976 UCS'] | str = 'CIE 1931', labels: Sequence | None = None, mireds: bool = False, colour: ArrayLike | None = None, opacity: float = 1, thickness: float = 1)

Bases: MixinPropertyColour, MixinPropertyMethod, MixinPropertyOpacity, MixinPropertyThickness, Visual

Create a Planckian Locus visual.

Parameters:

• method (Literal['CIE 1931', 'CIE 1960 UCS', 'CIE 1976 UCS'] | str) – Planckian Locus method.

• labels (Sequence | None) – Array of labels used to customise which iso-temperature lines will be drawn along the Planckian Locus. Passing an empty array will result in no iso-temperature lines being drawn.

• mireds (bool) – Whether to use micro reciprocal degrees for the iso-temperature lines.

• colour (ArrayLike | None) – Colour of the visual, if None, the colour is computed from the visual geometry.

• opacity (float) – Opacity of the visual.

• thickness (float) – Thickness of the visual lines.

Attributes

• method

• labels

• mireds

• colour

• opacity

• thickness

Methods

• __init__()

• update()

Examples

>>> import os
>>> from colour.utilities import suppress_stdout
>>> from wgpu.gui.auto import WgpuCanvas
>>> with suppress_stdout():
...     canvas = WgpuCanvas(size=(960, 540))
...     scene = gfx.Scene()
...     scene.add(
...         gfx.Background(
...             None, gfx.BackgroundMaterial(np.array([0.18, 0.18, 0.18]))
...         )
...     )
...     visual = VisualPlanckianLocus()
...     camera = gfx.PerspectiveCamera(50, 16 / 9)
...     camera.show_object(visual, up=np.array([0, 0, 1]), scale=1.25)
...     scene.add(visual)
...     if os.environ.get("CI") is None:
...         gfx.show(scene, camera=camera, canvas=canvas)

__init__(method: Literal['CIE 1931', 'CIE 1960 UCS', 'CIE 1976 UCS'] | str = 'CIE 1931', labels: Sequence | None = None, mireds: bool = False, colour: ArrayLike | None = None, opacity: float = 1, thickness: float = 1) → None

Parameters:

• method (Literal['CIE 1931', 'CIE 1960 UCS', 'CIE 1976 UCS'] | str)

• labels (Sequence | None)

• mireds (bool)

• colour (ArrayLike | None)

• opacity (float)

• thickness (float)

Return type:

None

property labels: Sequence | None

Getter and setter property for the labels.

Parameters:

value – Value to set the labels with.

Returns:

Labels.

Return type:

str

property mireds: bool

Getter and setter property for the mireds state.

Parameters:

value – Value to set the mireds state with.

Returns:

Mireds state.

Return type:

bool

update() → None

Update the visual.

Return type:

None