napari utilities

napari_threedee.utils.napari_utils

get_napari_visual(viewer, layer)

Get the visual class for a given layer

PARAMETER	DESCRIPTION
viewer	The napari viewer object
layer	The napari layer object for which to find the visual.

RETURNS	DESCRIPTION
visual	The napari visual class for the layer.

Source code in src/napari_threedee/utils/napari_utils.py

def get_napari_visual(viewer, layer):
    """Get the visual class for a given layer

    Parameters
    ----------
    viewer
        The napari viewer object
    layer
        The napari layer object for which to find the visual.

    Returns
    -------
    visual
        The napari visual class for the layer.
    """
    visual = viewer.window._qt_window._qt_viewer.layer_to_visual[layer]

    return visual

get_vispy_layer_node(viewer: napari.Viewer, layer)

Get the vispy node associated with a layer

Source code in src/napari_threedee/utils/napari_utils.py

def get_vispy_layer_node(viewer: napari.Viewer, layer):
    """Get the vispy node associated with a layer"""
    napari_visual = get_napari_visual(viewer, layer)

    if isinstance(layer, Image):
        return napari_visual._layer_node.get_node(3)
    elif isinstance(layer, Points):
        return napari_visual.node

get_vispy_root_node(viewer: napari.Viewer, layer)

Get the vispy node at the root of the scene graph.

This is the node that layers are added to.

Source code in src/napari_threedee/utils/napari_utils.py

def get_vispy_root_node(viewer: napari.Viewer, layer):
    """Get the vispy node at the root of the scene graph.

    This is the node that layers are added to.
    """
    qt_viewer = viewer.window._qt_window._qt_viewer
    return qt_viewer.canvas.view.scene

get_mouse_position_in_displayed_dimensions(event) -> np.ndarray

Get the position under the mouse in scene (displayed world) coordinates.

PARAMETER	DESCRIPTION
event	The mouse event.

RETURNS	DESCRIPTION
click_dir_data_3d	The click direction in displayed data coordiantes TYPE: ndarray

Source code in src/napari_threedee/utils/napari_utils.py

def get_mouse_position_in_displayed_dimensions(event) -> np.ndarray:
    """Get the position under the mouse in scene (displayed world) coordinates.

    Parameters
    ----------
    event
        The mouse event.

    Returns
    -------
    click_dir_data_3d : np.ndarray
        The click direction in displayed data coordiantes
    """
    click_position_world = event.position
    return np.asarray(click_position_world)[list(event.dims_displayed)]

get_view_direction_in_displayed_dimensions(event) -> np.ndarray

Get the view direction under the mouse in scene (displayed world) coordinates.

PARAMETER	DESCRIPTION
event	napari mouse event.

Source code in src/napari_threedee/utils/napari_utils.py

def get_view_direction_in_displayed_dimensions(event) -> np.ndarray:
    """Get the view direction under the mouse in scene (displayed world) coordinates.

    Parameters
    ----------
    event: Event
        napari mouse event.
    """
    view_direction_world = event.view_direction
    return np.asarray(view_direction_world)[list(event.dims_displayed)]

get_mouse_position_in_displayed_layer_data_coordinates(layer, event) -> Tuple[np.ndarray, np.ndarray]

Get the mouse click position and direction in layer data displayed coordinates.

PARAMETER	DESCRIPTION
layer	The layer to convert the coordinates to. TYPE: Layer
event	The mouse event.

RETURNS	DESCRIPTION
click_position_data_3d	The click position in displayed data coordinates. TYPE: ndarray
click_dir_data_3d	The click direction in displayed data coordiantes TYPE: ndarray

Source code in src/napari_threedee/utils/napari_utils.py

def get_mouse_position_in_displayed_layer_data_coordinates(layer, event) -> Tuple[np.ndarray, np.ndarray]:
    """Get the mouse click position and direction in layer data displayed coordinates.

    Parameters
    ----------
    layer : napari.layers.Layer
        The layer to convert the coordinates to.
    event
        The mouse event.

    Returns
    -------
    click_position_data_3d : np.ndarray
        The click position in displayed data coordinates.
    click_dir_data_3d : np.ndarray
        The click direction in displayed data coordiantes
    """
    click_position_world = event.position
    click_position_data_3d = np.asarray(
        layer._world_to_displayed_data(
            click_position_world,
            event.dims_displayed
        )
    )
    click_dir_data_3d = np.asarray(
        layer._world_to_displayed_data_ray(
            event.view_direction,
            event.dims_displayed
        )
    )

    return click_position_data_3d, click_dir_data_3d

data_to_world_ray(vector, layer)

Convert a vector defining an orientation from data coordinates to world coordinates. For example, this would be used to convert the view ray.

PARAMETER	DESCRIPTION
vector	A vector in data coordinates. TYPE: tuple, list, 1D array
layer	The napari layer to get the transform from. TYPE: BaseLayer

RETURNS	DESCRIPTION
ndarray	Transformed vector in data coordinates.

Source code in src/napari_threedee/utils/napari_utils.py

def data_to_world_ray(vector, layer):
    """Convert a vector defining an orientation from data coordinates to world coordinates.
    For example, this would be used to convert the view ray.

    Parameters
    ----------
    vector : tuple, list, 1D array
        A vector in data coordinates.
    layer : napari.layers.BaseLayer
        The napari layer to get the transform from.

    Returns
    -------
    np.ndarray
        Transformed vector in data coordinates.
    """
    p1 = np.asarray(layer.data_to_world(vector))
    p0 = np.asarray(layer.data_to_world(np.zeros_like(vector)))
    normalized_vector = (p1 - p0) / np.linalg.norm(p1 - p0)

    return normalized_vector

data_to_world_normal(vector, layer)

Convert a normal vector defining an orientation from data coordinates to world coordinates. For example, this would be used to a plane normal.

https://www.scratchapixel.com/lessons/mathematics-physics-for-computer-graphics/geometry/transforming-normals.html

PARAMETER	DESCRIPTION
vector	A vector in data coordinates. TYPE: tuple, list, 1D array
layer	The napari layer to get the transform from. TYPE: BaseLayer

RETURNS	DESCRIPTION
ndarray	Transformed vector in data coordinates. This returns a unit vector.

Source code in src/napari_threedee/utils/napari_utils.py

def data_to_world_normal(vector, layer):
    """Convert a normal vector defining an orientation from data coordinates to world coordinates.
    For example, this would be used to a plane normal.

    https://www.scratchapixel.com/lessons/mathematics-physics-for-computer-graphics/geometry/transforming-normals.html

    Parameters
    ----------
    vector : tuple, list, 1D array
        A vector in data coordinates.
    layer : napari.layers.BaseLayer
        The napari layer to get the transform from.

    Returns
    -------
    np.ndarray
        Transformed vector in data coordinates. This returns a unit vector.
    """
    unit_vector = np.asarray(vector) / np.linalg.norm(vector)

    # get the transform
    inverse_transform = layer._transforms[1:].simplified.inverse.linear_matrix
    transpose_inverse_transform = inverse_transform.T

    # transform the vector
    transformed_vector = np.matmul(transpose_inverse_transform, unit_vector)

    return transformed_vector / np.linalg.norm(transformed_vector)

world_to_data_normal(vector, layer)

Convert a normal vector defining an orientation from world coordinates to data coordinates. For example, this would be used to a plane normal.

https://www.scratchapixel.com/lessons/mathematics-physics-for-computer-graphics/geometry/transforming-normals.html

PARAMETER	DESCRIPTION
vector	A vector in world coordinates. TYPE: tuple, list, 1D array
layer	The napari layer to get the transform from. TYPE: BaseLayer

RETURNS	DESCRIPTION
ndarray	Transformed vector in data coordinates. This returns a unit vector.

Source code in src/napari_threedee/utils/napari_utils.py

def world_to_data_normal(vector, layer):
    """Convert a normal vector defining an orientation from world coordinates to data coordinates.
    For example, this would be used to a plane normal.

    https://www.scratchapixel.com/lessons/mathematics-physics-for-computer-graphics/geometry/transforming-normals.html

    Parameters
    ----------
    vector : tuple, list, 1D array
        A vector in world coordinates.
    layer : napari.layers.BaseLayer
        The napari layer to get the transform from.

    Returns
    -------
    np.ndarray
        Transformed vector in data coordinates. This returns a unit vector.
    """
    unit_vector = np.asarray(vector) / np.linalg.norm(vector)

    # get the transform
    # the napari transform is from layer -> world.
    # We want the inverse of the world ->  layer, so we just take the napari transform
    inverse_transform = layer._transforms[1:].simplified.linear_matrix
    transpose_inverse_transform = inverse_transform.T

    # transform the vector
    transformed_vector = np.matmul(transpose_inverse_transform, unit_vector)

    return transformed_vector / np.linalg.norm(transformed_vector)

point_in_layer_bounding_box(point, layer)

Determine whether an nD point is inside a layers nD bounding box.

PARAMETER	DESCRIPTION
point	(n,) array containing nD point coordinates to check. TYPE: ndarray
layer	napari layer to get the bounding box from TYPE: Layer

RETURNS	DESCRIPTION
bool	True if the point is in the bounding box of the layer, otherwise False

Notes

For a more general point-in-bbox function, see: napari_threedee.utils.geometry.point_in_bounding_box

Source code in src/napari_threedee/utils/napari_utils.py

def point_in_layer_bounding_box(point, layer):
    """Determine whether an nD point is inside a layers nD bounding box.

    Parameters
    ----------
    point : np.ndarray
        (n,) array containing nD point coordinates to check.
    layer : napari.layers.Layer
        napari layer to get the bounding box from

    Returns
    -------
    bool
        True if the point is in the bounding box of the layer,
        otherwise False

    Notes
    -----
    For a more general point-in-bbox function, see:
        `napari_threedee.utils.geometry.point_in_bounding_box`
    """
    dims_displayed = get_dims_displayed(layer)
    bbox = layer._display_bounding_box(dims_displayed).T
    if np.any(point < bbox[0]) or np.any(point > bbox[1]):
        return False
    else:
        return True

clamp_point_to_layer_bounding_box(point: np.ndarray, layer)

Ensure that a point is inside of the bounding box of a given layer. If the point has a coordinate outside of the bounding box, the value is clipped to the max extent of the bounding box.

PARAMETER	DESCRIPTION
point	n-dimensional point as an (n,) ndarray. Multiple points can be passed as an (n, D) array. TYPE: ndarray
layer	napari layer to get the bounding box from TYPE: Layer

RETURNS	DESCRIPTION
clamped_point	point clamped to the limits of the layer bounding box TYPE: ndarray

Notes

This function is derived from the napari function: napari.utils.geometry.clamp_point_to_bounding_box

Source code in src/napari_threedee/utils/napari_utils.py

def clamp_point_to_layer_bounding_box(point: np.ndarray, layer):
    """Ensure that a point is inside of the bounding box of a given layer. 
    If the point has a coordinate outside of the bounding box, the value 
    is clipped to the max extent of the bounding box.

    Parameters
    ----------
    point : np.ndarray
        n-dimensional point as an (n,) ndarray. Multiple points can
        be passed as an (n, D) array.
    layer : napari.layers.Layer
        napari layer to get the bounding box from

    Returns
    -------
    clamped_point : np.ndarray
        `point` clamped to the limits of the layer bounding box

    Notes
    -----
    This function is derived from the napari function:
        `napari.utils.geometry.clamp_point_to_bounding_box`
    """
    dims_displayed = get_dims_displayed(layer)
    bbox = layer._display_bounding_box(dims_displayed)
    clamped_point = np.clip(point, bbox[:, 0], bbox[:, 1] - 1)
    return clamped_point