napari.utils.CyclicLabelColormap#

class napari.utils.CyclicLabelColormap(colors, display_name: str | None = None, *, name: str = 'custom', interpolation: Literal[ColormapInterpolationMode.ZERO] = ColormapInterpolationMode.ZERO, controls: Array = None, use_selection: bool = False, selection: int = 0, background_value: int = 0, seed: float = 0.5)[source]#

Bases: LabelColormapBase

Color cycle with a background value.

colors#

Colors to be used for mapping. For values above the number of colors, the colors will be cycled.

Type:

ColorArray

use_selection#

Whether map only selected label. If True only selected label will be mapped to not transparent color.

Type:

bool

selection#

The selected label.

Type:

int

background_value#

Which value should be treated as a background and mapped to transparent color.

Type:

int

interpolation#

required by implementation, please do not set value

Type:

Literal[‘zero’]

seed#

seed used for random color generation. Used for reproducibility. It will be removed in the future release.

Type:

float

Inherited-members:

Methods

construct([_fields_set])

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.

copy(*[, include, exclude, update, deep])

Duplicate a model, optionally choose which fields to include, exclude and change.

dict(*[, include, exclude, by_alias, ...])

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

enums_as_values([as_values])

Temporarily override how enums are retrieved.

from_orm(obj)

json(*[, include, exclude, by_alias, ...])

Generate a JSON representation of the model, include and exclude arguments as per dict().

map(values)

Map values to colors.

parse_file(path, *[, content_type, ...])

parse_obj(obj)

parse_raw(b, *[, content_type, encoding, ...])

reset()

Reset the state of the model to default values.

schema([by_alias, ref_template])

schema_json(*[, by_alias, ref_template])

shuffle(seed)

Shuffle the colormap colors.

update(values[, recurse])

Update a model in place.

update_forward_refs(**localns)

Try to update ForwardRefs on fields based on this Model, globalns and localns.

validate(value)

Attributes

colorbar

events

Details

map(values: ndarray | integer | int) ndarray[source]#

Map values to colors.

Parameters:

values (np.ndarray or int) – Values to be mapped.

Returns:

but with the last dimension of size 4 Mapped colors.

Return type:

np.ndarray of the same shape as values,

shuffle(seed: int)[source]#

Shuffle the colormap colors.

Parameters:

seed (int) – Seed for the random number generator.