napari.components.Dims

class napari.components.Dims(*, ndim: int = 2, ndisplay: Literal[2, 3] = 2, last_used: int = 0, range: Tuple[Tuple[float, float, float], …] = (), current_step: Tuple[int, …] = (), order: Tuple[int, …] = (), axis_labels: Tuple[str, …] = ())[source]

Bases: napari.utils.events.evented_model.EventedModel

Dimensions object modeling slicing and displaying.

Parameters

  • ndim (int) – Number of dimensions.

  • ndisplay (int) – Number of displayed dimensions.

  • last_used (int) – Dimension which was last used.

  • range (tuple of 3-tuple of float) – List of tuples (min, max, step), one for each dimension. In a world coordinates space.

  • current_step (tuple of int) – Tuple the slider position for each dims slider, in slider coordinates.

  • order (tuple of int) – Tuple of ordering the dimensions, where the last dimensions are rendered.

  • axis_labels (tuple of str) – Tuple of labels for each dimension.

ndim

Number of dimensions.

Type

int

ndisplay

Number of displayed dimensions.

Type

int

last_used

Dimension which was last used.

Type

int

range

List of tuples (min, max, step), one for each dimension. In a world coordinates space.

Type

tuple of 3-tuple of float

current_step

Tuple the slider position for each dims slider, in slider coordinates.

Type

tuple of int

order

Tuple of ordering the dimensions, where the last dimensions are rendered.

Type

tuple of int

axis_labels

Tuple of labels for each dimension.

Type

tuple of str

nsteps

Number of steps available to each slider. These are calculated from the range.

Type

tuple of int

point

List of floats setting the current value of the range slider when in POINT mode, one for each dimension. In a world coordinates space. These are calculated from the current_step and range.

Type

tuple of float

displayed

List of dimensions that are displayed. These are calculated from the order and ndisplay.

Type

tuple of int

not_displayed

List of dimensions that are not displayed. These are calculated from the order and ndisplay.

Type

tuple of int

displayed_order

Order of only displayed dimensions. These are calculated from the displayed dimensions.

Type

tuple of int

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

property displayed

Dimensions that are displayed.

Type

Tuple

Return type

Tuple[int, …]

property displayed_order

Order of only displayed dimensions.

Type

Tuple

Return type

Tuple[int, …]

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

property not_displayed

Dimensions that are not displayed.

Type

Tuple

Return type

Tuple[int, …]

property nsteps

Number of slider steps for each dimension.

Type

Tuple of int

Return type

Tuple[int, …]

property point

Value of each dimension.

Type

Tuple of float

Return type

Tuple[int, …]

reset()[source]

Reset dims values to initial states.

set_axis_label(axis, label)[source]

Sets a new axis label for the given axis.

Parameters

  • axis (int) – Dimension index

  • label (str) – Given label

set_current_step(axis, value)[source]

Sets the slider step at which to slice this dimension.

The position of the slider in world coordinates gets calculated from the current_step of the slider.

Parameters

  • axis (int) – Dimension index.

  • value (int or float) – Value of the point.

set_point(axis, value)[source]

Sets point to slice dimension in world coordinates.

The desired point gets transformed into an integer step of the slider and stored in the current_step.

Parameters

  • axis (int) – Dimension index.

  • value (int or float) – Value of the point.

set_range(axis, _range)[source]

Sets the range (min, max, step) for a given dimension.

Parameters

  • axis (int) – Dimension index.

  • _range (tuple) – Range specified as (min, max, step).

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