Merge pull request #459 from jo-mueller/support-shape-selection

add conditional support for interactive shape selection

Author: jo-mueller

docs/usage/overview.md

@@ -44,3 +44,7 @@ The drawing of the plotted data is triggered whenever the data in the `layer.fea
 In case you ever found yourself in the situation that you wanted to process or inspect an individual object from a layer separately from all the other objects without tedious image processing to pick out *just the right object*, you can now do this in the clusters plotter. Simply draw a selection in the canvas (using the `MANUAL_CLUSTER_ID`) as hue column or select any other categorical feature. Then use the cluster selector on the top of the canvas to select the object class you'd want to export and click the `Add current class as new layer button`!
 
 ![Add selected objects to new layer](./imgs/copy_export_objects_function.gif)
+
+## Bi-directional object selection
+
+*Geez, what's the matter with this cell*? Ever hoped you could just select an object on the napari canvas and introspect its properties? Just as it is possible to select objects in the napari-clusters-plotter interface and highlight them in the napari viewer, it is possible to do it the other way around. For `Labels`, `Points` and `Shapes` (Shapes: napari version >=0.6.5), you can select objects in the napari UI. A new categorical feature (`SELECTED_LAYER_CLUSTER_ID`) will be added to the `hue` dropdown that highlights all selected objects.

src/napari_clusters_plotter/_new_plotter_widget.py

@@ -570,7 +570,12 @@ def _on_update_layer_selection(
             # connect selection event
             if _is_selectable_layer(layer):
                 selection_event = _get_selection_event(layer)
-                selection_event.connect(self._update_selected_object_feature)
+
+                # not all napari versions support all selection events
+                if selection_event is not None:
+                    selection_event.connect(
+                        self._update_selected_object_feature
+                    )
 
     def _update_selected_object_feature(self) -> None:
         """

src/napari_clusters_plotter/_tests/test_plotter.py

@@ -753,7 +753,11 @@ def test_cluster_visibility_toggle(make_napari_viewer, create_sample_layers):
 
 @pytest.mark.parametrize(
     "create_sample_layers",
-    [create_multi_point_layer, create_multi_labels_layer],
+    [
+        create_multi_point_layer,
+        create_multi_labels_layer,
+        create_multi_shapes_layers,
+    ],
 )
 def test_selected_data_point_layer(make_napari_viewer, create_sample_layers):
     from napari_clusters_plotter import PlotterWidget
@@ -771,7 +775,7 @@ def test_selected_data_point_layer(make_napari_viewer, create_sample_layers):
     viewer.layers.selection.active = layer2
 
     event = _get_selection_event(layer2)
-    if isinstance(layer2, Points):
+    if type(layer2) in [Points, Shapes]:
         selection = [1, 2]
         layer2.selected_data = selection
         event.emit()

src/napari_clusters_plotter/_utilities.py

@@ -4,12 +4,9 @@
 import numpy as np
 from napari.layers import Image, Labels, Layer, Points, Shapes
 from napari.utils.events import Event
+from packaging.version import Version
 
-_selectable_layers = [
-    Labels,
-    Points,
-    # TODO: Shapes support is planned for future implementation; currently excluded from selectable layers due to incomplete support.
-]
+_selectable_layers = [Labels, Points, Shapes]
 
 
 def _get_unique_values(layer: Union[Image, Labels]) -> np.ndarray:
@@ -77,4 +74,7 @@ def _get_selection_event(layer: Layer) -> Event:
     elif isinstance(layer, Labels):
         return layer.events.selected_label
     elif isinstance(layer, Shapes):
-        return layer.events.highlight
+        from napari import __version__
+
+        if Version(__version__) >= Version("0.6.5"):
+            return layer.selected_data.events.items_changed