Merge pull request #339 from BiAPoL/support-timelapse

add callback to changed frame

Author: jo-mueller

src/napari_clusters_plotter/_new_plotter_widget.py

@@ -130,6 +130,9 @@ def _setup_callbacks(self):
             self._on_update_layer_selection
         )
 
+        # connect frame change to alpha update
+        self.viewer.dims.events.current_step.connect(self._on_frame_changed)
+
         # reset the coloring of the selected layer
         self.control_widget.reset_button.clicked.connect(self._reset)
 
@@ -198,6 +201,24 @@ def _replot(self):
         #         "MANUAL_CLUSTER_ID"
         #     ].to_numpy()
 
+    def _on_frame_changed(self, event: napari.utils.events.Event):
+        """
+        Called when the frame changes. Updates the alpha values of the points.
+        """
+
+        if "frame" in self._get_features().columns:
+            current_step = self.viewer.dims.current_step[0]
+            alpha = np.asarray(
+                self._get_features()["frame"] == current_step, dtype=float
+            )
+            size = np.ones(len(alpha)) * 50
+
+            index_out_of_frame = alpha == 0
+            alpha[index_out_of_frame] = 0.25
+            size[index_out_of_frame] = 35
+            self.plotting_widget.active_artist.alpha = alpha
+            self.plotting_widget.active_artist.size = size
+
     def _checkbox_status_changed(self):
         self._replot()
 

src/napari_clusters_plotter/_tests/test_plotter.py

@@ -295,3 +295,36 @@ def test_categorical_handling(make_napari_viewer, create_sample_layers):
     )  # should only be MANUAL_CLUSTER_ID and layer name
     assert categorical_columns[0] == "MANUAL_CLUSTER_ID"
     assert categorical_columns[1] == "layer"
+
+
+@pytest.mark.parametrize(
+    "create_sample_layers",
+    [
+        create_multi_point_layer,
+        create_multi_vectors_layer,
+        create_multi_surface_layer,
+        create_multi_shapes_layers,
+    ],
+)
+def test_temporal_highlighting(make_napari_viewer, create_sample_layers):
+    from napari_clusters_plotter import PlotterWidget
+
+    viewer = make_napari_viewer()
+    layer, layer2 = create_sample_layers()
+
+    # add layers to viewer
+    viewer.add_layer(layer)
+    viewer.add_layer(layer2)
+    plotter_widget = PlotterWidget(viewer)
+    viewer.window.add_dock_widget(plotter_widget, area="right")
+
+    plotter_widget._selectors["x"].setCurrentText("feature3")
+
+    # move time slider
+    current_step = viewer.dims.current_step[0]
+    viewer.dims.set_current_step(0, current_step + 1)
+
+    # check that the dots in the plotter widget update alpha and size
+    # to highlight out-of and in-frame data points
+    assert plotter_widget.plotting_widget.active_artist.alpha.min() == 0.25
+    assert plotter_widget.plotting_widget.active_artist.size.min() == 35