Merge pull request #892 from annie-xd-wang/stage-event-bindings

Stage event bindings

Author: AdvancedImagingUTSW

src/navigate/controller/sub_controllers/stage_controller.py

@@ -284,13 +284,15 @@ def disable_synthetic_stages(self, config):
     def bind_position_callbacks(self):
         """Binds position_callback() to each axis, records the trace name so we can
         unbind later."""
+        widgets = self.view.get_widgets()
         if not self.position_callbacks_bound:
             for axis in ["x", "y", "z", "theta", "f"]:
                 # add event bind to position entry variables
-                cbname = self.widget_vals[axis].trace_add(
-                    "write", self.position_callback(axis)
-                )
-                self.position_callback_traces[axis] = cbname
+                widgets[axis].widget.bind("<FocusOut>", self.position_callback(axis))
+                # cbname = self.widget_vals[axis].trace_add(
+                #     "write", self.position_callback(axis)
+                # )
+                # self.position_callback_traces[axis] = cbname
             self.position_callbacks_bound = True
 
     def unbind_position_callbacks(self):
@@ -318,13 +320,11 @@ def set_position(self, position):
         position : dict
             {'x': value, 'y': value, 'z': value, 'theta': value, 'f': value}
         """
-        widgets = self.view.get_widgets()
         for axis in ["x", "y", "z", "theta", "f"]:
-            self.widget_vals[axis].set(position.get(axis, 0))
-            # validate position value if set through variable
-            if self.stage_limits:
-                widgets[axis].widget.trigger_focusout_validation()
-            self.stage_setting_dict[axis] = position.get(axis, 0)
+            if axis not in position:
+                continue
+            self.widget_vals[axis].set(position[axis])
+            self.position_callback(axis)()
         self.show_verbose_info("Set stage position")
 
     def set_position_silent(self, position):
@@ -335,11 +335,17 @@ def set_position_silent(self, position):
         position : dict
             {'x': value, 'y': value, 'z': value, 'theta': value, 'f': value}
         """
-        self.unbind_position_callbacks()
-
-        self.set_position(position)
+        widgets = self.view.get_widgets()
+        for axis in ["x", "y", "z", "theta", "f"]:
+            if axis not in position:
+                continue
+            self.widget_vals[axis].set(position[axis])
+            # validate position value if set through variable
+            if self.stage_limits:
+                widgets[axis].widget.trigger_focusout_validation()
+            self.stage_setting_dict[axis] = position.get(axis, 0)
+        self.show_verbose_info("Set stage position")
 
-        self.bind_position_callbacks()
 
     def get_position(self):
         """This function returns current position from the view.
@@ -392,7 +398,7 @@ def handler():
             to move."""
             stage_direction = -1 if self.flip_flags[axis] else 1
             try:
-                temp = position_val.get() + step_val.get() * stage_direction
+                temp = float(position_val.get()) + step_val.get() * stage_direction
             except tk._tkinter.TclError:
                 return
             if self.stage_limits is True:
@@ -401,8 +407,9 @@ def handler():
                 elif temp < self.position_min[axis]:
                     temp = self.position_min[axis]
             # guarantee stage won't move out of limits
-            if position_val.get() != temp:
+            if float(position_val.get()) != temp:
                 position_val.set(temp)
+                self.position_callback(axis)()
 
         return handler
 
@@ -432,7 +439,7 @@ def handler():
             to move."""
             stage_direction = -1 if self.flip_flags[axis] else 1
             try:
-                temp = position_val.get() - step_val.get() * stage_direction
+                temp = float(position_val.get()) - step_val.get() * stage_direction
             except tk._tkinter.TclError:
                 return
             if self.stage_limits is True:
@@ -441,8 +448,9 @@ def handler():
                 elif temp > self.position_max[axis]:
                     temp = self.position_max[axis]
             # guarantee stage won't move out of limits
-            if position_val.get() != temp:
+            if float(position_val.get()) != temp:
                 position_val.set(temp)
+                self.position_callback(axis)()
 
         return handler
 
@@ -465,6 +473,7 @@ def zero_btn_handler(self, axis):
 
         def handler():
             position_val.set(0)
+            self.position_callback(axis)()
 
         return handler
 
@@ -482,6 +491,8 @@ def xy_zero_btn_handler(self):
         def handler():
             x_val.set(0)
             y_val.set(0)
+            self.position_callback("x")()
+            self.position_callback("y")()
 
         return handler
 
@@ -547,7 +558,7 @@ def handler(*args):
                 self.view.after_cancel(self.event_id[axis])
             # if position is not a number, then do not move stage
             try:
-                position = position_var.get()
+                position = float(position_var.get())
                 if self.stage_limits:
                     widget.trigger_focusout_validation()
                     # if position is not inside limits do not move stage

src/navigate/view/main_window_content/stage_tab.py

@@ -521,7 +521,7 @@ def __init__(self, stage_control_tab, *args, **kwargs):
                 parent=self,
                 label=entry_labels[i],
                 input_class=ValidatedEntry,
-                input_var=tk.DoubleVar(),
+                input_var=tk.StringVar(),
                 input_args={
                     "required": True,
                     "precision": 0.1,

test/controller/sub_controllers/test_stage_controller.py

@@ -31,7 +31,7 @@
 #
 
 import pytest
-from unittest.mock import MagicMock
+from unittest.mock import MagicMock, call
 import numpy as np
 
 AXES = ["x", "y", "z", "theta", "f"]
@@ -55,6 +55,52 @@ def stage_controller(dummy_controller):
         dummy_controller,
     )
 
+# test before set position variables to MagicMock()
+def test_set_position(stage_controller):
+
+    widgets = stage_controller.view.get_widgets()
+    vals = {}
+    for axis in AXES:
+        widgets[axis].widget.trigger_focusout_validation = MagicMock()
+        vals[axis] = np.random.randint(0, 9)
+
+    stage_controller.view.get_widgets = MagicMock(return_value=widgets)
+    stage_controller.show_verbose_info = MagicMock()
+    position = {
+        "x": np.random.random(),
+        "y": np.random.random(),
+        "z": np.random.random(),
+    }
+    stage_controller.set_position(position)
+    for axis in position.keys():
+        assert float(stage_controller.widget_vals[axis].get()) == position[axis]
+        assert widgets[axis].widget.trigger_focusout_validation.called
+        assert stage_controller.stage_setting_dict[axis] == position.get(axis, 0)
+    stage_controller.show_verbose_info.assert_has_calls([call("Stage position changed"), call("Set stage position")])
+
+def test_set_position_silent(stage_controller):
+
+    widgets = stage_controller.view.get_widgets()
+    vals = {}
+    for axis in AXES:
+        widgets[axis].widget.trigger_focusout_validation = MagicMock()
+        vals[axis] = np.random.randint(0, 9)
+
+    stage_controller.view.get_widgets = MagicMock(return_value=widgets)
+    stage_controller.show_verbose_info = MagicMock()
+    position = {
+        "x": np.random.random(),
+        "y": np.random.random(),
+        "z": np.random.random(),
+    }
+    stage_controller.set_position_silent(position)
+    for axis in position.keys():
+        assert float(stage_controller.widget_vals[axis].get()) == position[axis]
+        widgets[axis].widget.trigger_focusout_validation.assert_called_once()
+        assert stage_controller.stage_setting_dict[axis] == position.get(axis, 0)
+    stage_controller.show_verbose_info.assert_has_calls([call("Set stage position")])
+    assert call("Stage position changed") not in stage_controller.show_verbose_info.mock_calls
+
 
 @pytest.mark.parametrize(
     "flip_x, flip_y",
@@ -105,30 +151,6 @@ def test_stage_key_press(stage_controller, flip_x, flip_y):
     stage_config["flip_y"] = False
 
 
-def test_set_position(stage_controller):
-
-    widgets = stage_controller.view.get_widgets()
-    vals = {}
-    for axis in AXES:
-        widgets[axis].widget.trigger_focusout_validation = MagicMock()
-        vals[axis] = np.random.randint(0, 9)
-        stage_controller.widget_vals[axis].set = MagicMock()
-
-    stage_controller.view.get_widgets = MagicMock(return_value=widgets)
-    stage_controller.show_verbose_info = MagicMock()
-    position = {
-        "x": np.random.random(),
-        "y": np.random.random(),
-        "z": np.random.random(),
-    }
-    stage_controller.set_position(position)
-    for axis in AXES:
-        assert stage_controller.widget_vals[axis].set.called
-        widgets[axis].widget.trigger_focusout_validation.assert_called_once()
-        assert stage_controller.stage_setting_dict[axis] == position.get(axis, 0)
-    stage_controller.show_verbose_info.assert_called_once_with("Set stage position")
-
-
 def test_get_position(stage_controller):
     import tkinter as tk