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. As with Python’s range and slice, max is not included.
current_step (tuple of int) – Tuple of 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.
-
range
¶ List of tuples (min, max, step), one for each dimension. In a world coordinates space. As with Python’s range and slice, max is not included.
- 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
andrange
.- Type
tuple of float
-
displayed
¶ List of dimensions that are displayed. These are calculated from the
order
andndisplay
.- Type
tuple of int
-
not_displayed
¶ List of dimensions that are not displayed. These are calculated from the
order
andndisplay
.- Type
tuple of int
-
displayed_order
¶ Order of only displayed dimensions. These are calculated from the
displayed
dimensions.- Type
tuple of int
Methods
asdict
()Convert a model to a dictionary.
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)- rtype
Model
json
(*[, include, exclude, by_alias, …])Generate a JSON representation of the model, include and exclude arguments as per dict().
parse_file
(path, *[, content_type, …])- rtype
Model
parse_obj
(obj)- rtype
Model
parse_raw
(b, *[, content_type, encoding, …])- rtype
Model
reset
()Reset dims values to initial states.
schema
([by_alias, ref_template])- rtype
DictStrAny
schema_json
(*[, by_alias, ref_template])- rtype
unicode
set_axis_label
(axis, label)Sets a new axis label for the given axis.
set_current_step
(axis, value)Sets the slider step at which to slice this dimension.
set_point
(axis, value)Sets point to slice dimension in world coordinates.
set_range
(axis, _range)Sets the range (min, max, step) for a given dimension.
update
(values)Update a model in place.
update_forward_refs
(**localns)Try to update ForwardRefs on fields based on this Model, globalns and localns.
validate
(value)- rtype
Model
Attributes
Dimensions that are displayed.
Order of only displayed dimensions.
events
Dimensions that are not displayed.
Number of slider steps for each dimension.
Value of each dimension.
Details
-
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 modelexclude (
Union
[ForwardRef
,ForwardRef
]) – fields to exclude from new model, as with values this takes precedence over includeupdate (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
-
enums_as_values
(as_values=True)¶ Temporarily override how enums are retrieved.
- Parameters
as_values (bool, optional) – Whether enums should be shown as values (or as enum objects), by default True
-
json
(*, include=None, exclude=None, by_alias=False, skip_defaults=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=None, models_as_dict=True, **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
nsteps
¶ Number of slider steps for each dimension.
-
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.
-
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.
-
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