napari.utils.Colormap¶

class napari.utils.Colormap(colors, *, name: str = 'custom', interpolation: napari.utils.colormaps.colormap.ColormapInterpolationMode = <ColormapInterpolationMode.LINEAR: 'linear'>, controls: napari.utils.events.custom_types.Array = None)[source]¶

Bases: napari.utils.events.evented_model.EventedModel

Colormap that relates intensity values to colors.

colors¶

Data used in the colormap.

Type: array, shape (N, 4)

name¶

Name of the colormap.

Type: str

controls¶

Control points of the colormap.

Type: array, shape (N,) or (N+1,)

interpolation¶

Colormap interpolation mode, either ‘linear’ or ‘zero’. If ‘linear’, ncontrols = ncolors (one color per control point). If ‘zero’, ncontrols = ncolors+1 (one color per bin).

Type: str

Methods

Attributes

asdict()¶: Convert a model to a dictionary.

classmethod construct(_fields_set=None, **values)¶

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

Return type: Model

copy(*, include=None, exclude=None, update=None, deep=False)¶

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

Parameters

include (Union[ForwardRef, ForwardRef]) – fields to include in new model
exclude (Union[ForwardRef, ForwardRef]) – fields to exclude from new model, as with values this takes precedence over include
update (DictStrAny) – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep (bool) – set to True to make a deep copy of the model

Return type

Model

Returns

new model instance

dict(*, include=None, exclude=None, by_alias=False, skip_defaults=None, exclude_unset=False, exclude_defaults=False, exclude_none=False)¶

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

Return type: DictStrAny

json(*, include=None, exclude=None, by_alias=False, skip_defaults=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=None, **dumps_kwargs)¶

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

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

Return type: unicode

update(values)¶

Update a model in place.

Parameters: values (dict, napari.utils.events.EventedModel) – Values to update the model with. If an EventedModel is passed it is first converted to a dictionary. The keys of this dictionary must be found as attributes on the current model.

classmethod update_forward_refs(**localns)¶

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

Return type: None