napari.components.Camera

class napari.components.Camera(*, center: Tuple[float, float, float] = (0.0, 0.0, 0.0), zoom: float = 1.0, angles: Tuple[float, float, float] = (0.0, 0.0, 90.0), perspective: float = 0, interactive: bool = True)[source]

Bases: napari.utils.events.evented_model.EventedModel

Camera object modeling position and view of the camera.

center

Center of rotation for the camera. In 2D viewing the last two values are used.

Type

3-tuple

zoom

Scale from canvas pixels to world pixels.

Type

float

angles

Euler angles of camera in 3D viewing (rx, ry, rz), in degrees. Only used during 3D viewing. Note that Euler angles’s intrinsic degeneracy means different sets of Euler angles may lead to the same view.

Type

3-tuple

perspective

Perspective (aka “field of view” in vispy) of the camera (if 3D).

Type

float

interactive

If the camera interactivity is enabled or not.

Type

bool

Methods

calculate_nd_up_direction(ndim, dims_displayed)

Calculate the nD up direction vector of the camera.

calculate_nd_view_direction(ndim, dims_displayed)

Calculate the nD view direction vector of the camera.

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().

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])

set_view_direction(view_direction[, ...])

Set camera angles from direction vectors.

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

events

up_direction

3D direction vector pointing up on the canvas.

view_direction

3D view direction vector of the camera.

Details

calculate_nd_up_direction(ndim: int, dims_displayed: Tuple[int]) → Optional[numpy.ndarray][source]

Calculate the nD up direction vector of the camera.

Parameters

  • ndim (int) – Number of dimensions in which to embed the 3D view vector.

  • dims_displayed (Tuple[int]) – Dimensions in which to embed the 3D view vector.

Returns

up_direction_nd – nD view direction vector as an (ndim, ) ndarray

Return type

np.ndarray

calculate_nd_view_direction(ndim: int, dims_displayed: Tuple[int]) → numpy.ndarray[source]

Calculate the nD view direction vector of the camera.

Parameters

  • ndim (int) – Number of dimensions in which to embed the 3D view vector.

  • dims_displayed (Tuple[int]) – Dimensions in which to embed the 3D view vector.

Returns

view_direction_nd – nD view direction vector as an (ndim, ) ndarray

Return type

np.ndarray

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model

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

copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) → Model

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

Parameters

  • include – fields to include in new model

  • exclude – fields to exclude from new model, as with values this takes precedence over include

  • update – 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 – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny

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

enums_as_values(as_values: bool = 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: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode

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().

reset()

Reset the state of the model to default values.

set_view_direction(view_direction: Tuple[float, float, float], up_direction: Tuple[float, float, float] = (0, - 1, 0))[source]

Set camera angles from direction vectors.

Both the view direction and the up direction are specified in 3D scene coordinates, the world coordinate system for three currently displayed dimensions.

The provided up direction must not be parallel to the provided view direction. The provided up direction does not need to be orthogonal to the view direction. The final up direction will be a vector orthogonal to the view direction, aligned with the provided up direction.

Parameters

  • view_direction (3-tuple of float) – The desired view direction vector in 3D scene coordinates, the world coordinate system for three currently displayed dimensions.

  • up_direction (3-tuple of float) – A direction vector which will point upwards on the canvas. Defaults to (0, -1, 0) unless the view direction is parallel to the y-axis, in which case will default to (-1, 0, 0).

property up_direction: Tuple[float, float, float]

3D direction vector pointing up on the canvas.

Up direction is calculated from the Euler angles and returned as a 3-tuple. This direction is in 3D scene coordinates, the world coordinate system for three currently displayed dimensions.

update(values: Union[napari.utils.events.evented_model.EventedModel, dict], recurse: bool = True) → None

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.

  • recurse (bool) – If True, recursively update fields that are EventedModels. Otherwise, just update the immediate fields of this EventedModel, which is useful when the declared field type (e.g. Union) can have different realized types with different fields.

classmethod update_forward_refs(**localns: Any) → None

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

property view_direction: Tuple[float, float, float]

3D view direction vector of the camera.

View direction is calculated from the Euler angles and returned as a 3-tuple. This direction is in 3D scene coordinates, the world coordinate system for three currently displayed dimensions.

previous

napari.components

next

napari.components.Dims