1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
|
# mypy: disable-error-code="attr-defined"
import warnings
from collections.abc import Generator
from copy import deepcopy
import numpy as np
from magicgui import magicgui
import napari
from napari._vispy.mouse_event import NapariMouseEvent
from napari._vispy.overlays.interaction_box import VispySelectionBoxOverlay
from napari._vispy.utils.visual import overlay_to_visual
from napari.components.overlays import SelectionBoxOverlay
from napari.components.overlays.interaction_box import InteractionBoxHandle
from napari.layers import Image
from napari.layers.utils.interaction_box import (
generate_interaction_box_vertices,
get_nearby_handle,
)
# define a model for the selection box overlay;
# we subclass from SelectionBoxOverlay to get the
# default behavior of the selection box;
class SelectionBoxNoRotation(SelectionBoxOverlay):
"""Selection box overlay with no rotation handle."""
# we also need to define an equivalent vispy overlay;
# again, we subclass from VispySelectionBoxOverlay
class VispySelectionBoxNoRotation(VispySelectionBoxOverlay):
"""Vispy selection box overlay with no rotation handle."""
# the _on_bounds_change method is the same as in the
# original VispySelectionBoxOverlay, but we set
# rotation to False to not draw the rotation handle
def _on_bounds_change(self) -> None:
if self.layer._slice_input.ndisplay == 2:
top_left, bot_right = self.overlay.bounds
self.node.set_data(
# invert axes for vispy
top_left[::-1],
bot_right[::-1],
handles=self.overlay.handles,
selected=self.overlay.selected_handle,
# by setting rotation to False,
# the circle handle will not be drawn
rotation=False,
)
# before we can use the new overlay, we have to update
# the overlay_to_visual mapping to include our new overlay;
# this is necessary so that the correct vispy overlay
# is used when the overlay is created
overlay_to_visual[SelectionBoxNoRotation] = VispySelectionBoxNoRotation
viewer = napari.Viewer()
# we add an image layer with random data;
data = np.random.randint(0, 255, size=(1024, 512), dtype=np.uint8)
image = viewer.add_image(
data,
name='image',
)
# just for type checking
assert isinstance(image, Image)
# we recover the bounds of the image layer;
# this method will ensure that the overlay is drawn
# correctly in the viewer
# TODO: this half pixel offset should be done on the visual side actually
layer_bounds = ((0, 0), data.shape)
image._overlays['selection_no_rotation'] = SelectionBoxNoRotation(
bounds=layer_bounds, handles=True
)
# with some adjustments, the selection box overlay
# can be interacted with via mouse events;
# we need to first setup the mouse event handlers
# to allow for the interaction with the overlay;
# this callback will handle the mouse events of
# dragging and dropping the selection box handles;
# it will check if the mouse is in range of one of the
# overlay handles; if it is, we will set the selected handle
# to the handle that is closest to the mouse position;
# then we will set the bounds of the overlay to the
# new position of the mouse;
def resize_selection_box(
layer: Image, event: 'NapariMouseEvent'
) -> 'Generator[None, None, None]':
"""Resize the selection box based on mouse movement.
Parameters
----------
layer : DetectorLayer
The layer to resize the selection box for.
event : NapariMouseEvent
The event triggered by mouse movement.
Yields
------
None
This is a generator function that handles mouse dragging.
"""
if len(event.dims_displayed) != 2:
return
# Get the selected handle
selected_handle = layer._overlays['selection_no_rotation'].selected_handle
if selected_handle is None or selected_handle in [
InteractionBoxHandle.INSIDE,
InteractionBoxHandle.ROTATION,
]:
# If no handle is selected or the selected handle
# is INSIDE or ROTATION, do nothing
return
top_left, bot_right = (
list(x)
for x in deepcopy(layer._overlays['selection_no_rotation'].bounds)
)
layer_bounds = image._display_bounding_box_augmented([0, 1])
# to prevent the event from being passed down to the
# pan-zoom event handler, set the event as handled;
event.handled = True
yield
# Main event loop for handling drag events
while event.type == 'mouse_move':
mouse_pos = layer.world_to_data(event.position)[event.dims_displayed]
clipped_y = np.clip(mouse_pos[0], *layer_bounds[0])
clipped_x = np.clip(mouse_pos[1], *layer_bounds[1])
# based on the new mouse position, we recalculate the bounds
# of the overlay; we need to ensure that the new bounds are within
# the bounds of the image
match selected_handle:
case InteractionBoxHandle.TOP_LEFT:
top_left[0] = clipped_y
top_left[1] = clipped_x
case InteractionBoxHandle.TOP_CENTER:
top_left[0] = clipped_y
case InteractionBoxHandle.TOP_RIGHT:
top_left[0] = clipped_y
bot_right[1] = clipped_x
case InteractionBoxHandle.CENTER_LEFT:
top_left[1] = clipped_x
case InteractionBoxHandle.CENTER_RIGHT:
bot_right[1] = clipped_x
case InteractionBoxHandle.BOTTOM_LEFT:
bot_right[0] = clipped_y
top_left[1] = clipped_x
case InteractionBoxHandle.BOTTOM_CENTER:
bot_right[0] = clipped_y
case InteractionBoxHandle.BOTTOM_RIGHT:
bot_right[0] = clipped_y
bot_right[1] = clipped_x
case _:
pass
# now we update the bounds of the overlay
# to trigger the visual update;
layer._overlays['selection_no_rotation'].bounds = deepcopy(
(tuple(top_left), tuple(bot_right))
)
yield
# this callback will hightlight the overlay handles
# when the mouse hovers over them;
def highlight_roi_box_handles(layer: Image, event: NapariMouseEvent) -> None:
"""Highlight the hovered handle of a selection box.
Parameters
----------
layer : Image
The layer to highlight the selection box for.
event : NapariMouseEvent
The event triggered by mouse movement.
"""
# the event is not handled by the viewer
# if the number of displayed dimensions is not 2
# this is a requirement for the overlay to be displayed
if len(event.dims_displayed) != 2:
return
# we work in data space so we're axis aligned which simplifies calculation
# same as Layer.world_to_data
world_to_data = (
layer._transforms[1:].set_slice(layer._slice_input.displayed).inverse
)
# interaction box calculations all happen in vispy coordinates (zyx)
pos = np.array(world_to_data(event.position))[event.dims_displayed][::-1]
top_left, bot_right = layer._overlays['selection_no_rotation'].bounds
handle_coords = generate_interaction_box_vertices(
top_left[::-1], bot_right[::-1], handles=True
)
nearby_handle = get_nearby_handle(pos, handle_coords)
# if the selected handle is INSIDE or ROTATION, we don't want to
# highlight the handles, so we return without doing anything
if nearby_handle in [
InteractionBoxHandle.INSIDE,
InteractionBoxHandle.ROTATION,
]:
nearby_handle = None
# set the selected vertex of the box to the nearby_handle (can also be INSIDE or None)
layer._overlays['selection_no_rotation'].selected_handle = nearby_handle
# after defining the callbacks, we need to connect them to our layer;
# mouse_move_callbacks is a list of callbacks invoked when the mouse
# hovers over the layer;
# mouse_drag_callbacks is a list of callbacks invoked when the
# mouse is pressed, moved and released;
image.mouse_move_callbacks.append(highlight_roi_box_handles)
image.mouse_drag_callbacks.append(resize_selection_box)
# we use a simple magicgui widget to allow
# the toggling of the selection box overlay
# as demonstration
@magicgui(auto_call=True)
def toggle_overlay(
viewer: napari.Viewer, toggle_selection_box: bool = False
) -> None:
with warnings.catch_warnings():
warnings.simplefilter('ignore')
viewer.layers['image']._overlays[
'selection_no_rotation'
].visible = toggle_selection_box
# add the widget to the viewer
viewer.window.add_dock_widget(toggle_overlay)
if __name__ == '__main__':
napari.run()
|