Merge pull request #951 from annie-xd-wang/communicating-from-model-to-controller

Communicating from model to controller

Author: AdvancedImagingUTSW

src/navigate/controller/controller.py

@@ -174,27 +174,24 @@ def __init__(
         logger.info(f"Spec - Waveform Constants Path: {waveform_constants_path}")
         logger.info(f"Spec - Rest API Path: {rest_api_path}")
 
-        # Wire up pipes
         #: mp.Pipe: Pipe for sending images from model to view.
         self.show_img_pipe = self.model.create_pipe("show_img_pipe")
 
-        # save default experiment file
         #: string: Path to the default experiment yaml file.
         self.default_experiment_file = experiment_path
 
-        # waveform setting file
         #: string: Path to the waveform constants yaml file.
         self.waveform_constants_path = waveform_constants_path
 
-        # Configuration Reader
         #: ConfigurationController: Configuration Controller object.
         self.configuration_controller = ConfigurationController(self.configuration)
 
-        # Initialize the View
         #: View: View object in MVC architecture.
         self.view = view(root)
 
-        # Sub Gui Controllers
+        #: dict: Event listeners for the controller.
+        self.event_listeners = {}
+
         #: AcquireBarController: Acquire Bar Sub-Controller.
         self.acquire_bar_controller = AcquireBarController(self.view.acqbar, self)
 
@@ -234,7 +231,7 @@ def __init__(
         #: KeystrokeController: Keystroke Sub-Controller.
         self.keystroke_controller = KeystrokeController(self.view, self)
 
-        # Exit
+        # Exit the program when the window is closed
         self.view.root.protocol(
             "WM_DELETE_WINDOW", self.acquire_bar_controller.exit_program
         )
@@ -248,22 +245,19 @@ def __init__(
         # self.microscope = self.configuration['configuration']
         # ['microscopes'].keys()[0]  # Default to the first microscope
 
-        # Initialize the menus
         #: MenuController: Menu Sub-Controller.
         self.menu_controller = MenuController(view=self.view, parent_controller=self)
         self.menu_controller.initialize_menus()
 
         #: dict: acquisition modes from plugins
         self.plugin_acquisition_modes = {}
 
-        # add plugin menus
         #: PluginsController: Plugin Sub-Controller
         self.plugin_controller = PluginsController(
             view=self.view, parent_controller=self
         )
         self.plugin_controller.load_plugins()
 
-        # Create default data buffer
         #: int: Number of x_pixels from microscope configuration file.
         self.img_width = 0
 
@@ -473,6 +467,16 @@ def update_experiment_setting(self):
             "multiposition_count"
         ] = len(positions)
 
+        if (
+            self.configuration["experiment"]["MicroscopeState"]["is_multiposition"]
+            and len(positions) == 0
+        ):
+            # Update the view and override the settings.
+            self.configuration["experiment"]["MicroscopeState"][
+                "is_multiposition"
+            ] = False
+            self.channels_tab_controller.is_multiposition_val.set(False)
+
         # TODO: validate experiment dict
 
         channel_warning = self.channels_tab_controller.verify_experiment_values()
@@ -1225,54 +1229,13 @@ def update_event(self):
                 # Display a warning that arises from the model as a top-level GUI popup
                 messagebox.showwarning(title="Navigate", message=value)
 
-            elif event == "waveform":
-                # Update the waveform plot.
-                self.waveform_tab_controller.update_waveforms(
-                    waveform_dict=value,
-                    sample_rate=self.configuration_controller.daq_sample_rate,
-                )
-
             elif event == "multiposition":
                 # Update the multi-position tab without appending to the list
                 update_table(
                     table=self.multiposition_tab_controller.table,
                     pos=value,
                 )
                 self.channels_tab_controller.is_multiposition_val.set(True)
-                self.channels_tab_controller.toggle_multiposition()
-
-            elif event == "disable_multiposition":
-                self.channels_tab_controller.is_multiposition_val.set(False)
-                self.channels_tab_controller.toggle_multiposition()
-
-            elif event == "ilastik_mask":
-                # Display the ilastik mask
-                self.camera_view_controller.display_mask(mask=value)
-
-            elif event == "autofocus":
-                # Display the autofocus plot
-                if hasattr(self, "af_popup_controller"):
-                    self.af_popup_controller.display_plot(
-                        data=value[0], line_plot=value[1], clear_data=value[2]
-                    )
-
-            elif event == "tonywilson":
-                if hasattr(self, "ao_popup_controller"):
-                    # self.ao_popup_controller.set_widgets_from_coef(value['coefs'])
-                    self.ao_popup_controller.plot_tonywilson(value)
-                    # self.ao_popup_controller.plot_mirror(value)
-                    if value["done"]:
-                        print("Tony Wilson done! Updating expt...")
-                        self.ao_popup_controller.update_experiment_values()
-
-            elif event == "mirror_update":
-                if hasattr(self, "ao_popup_controller"):
-                    self.ao_popup_controller.set_widgets_from_coef(value["coefs"])
-                    self.ao_popup_controller.plot_mirror(value)
-
-            elif event == "ao_save_report":
-                if hasattr(self, "ao_popup_controller"):
-                    self.ao_popup_controller.save_report_to_file(value)
 
             elif event == "stop":
                 # Stop the software
@@ -1287,17 +1250,47 @@ def update_event(self):
                         time.sleep(0.001)
                         pass
 
-            elif event == "remove_positions":
-                self.multiposition_tab_controller.remove_positions(value)
-
-            elif event == "exposure_time":
-                self.channels_tab_controller.set_exposure_time(value[0], value[1])
-            elif event == "display_camera_parameters":
-                self.camera_setting_controller.update_camera_parameters_silent(*value)
+            elif event in self.event_listeners.keys():
+                try:
+                    self.event_listeners[event](value)
+                except Exception:
+                    print(f"*** unhandled event: {event}, {value}")
 
     def add_acquisition_mode(self, name, acquisition_obj):
+        """Add and Acquisition Mode.
+
+        Parameters
+        ----------
+        name : string
+            Name of the acquisition mode.
+        acquisition_obj : object
+            Object of the acquisition mode.
+        """
         if name in self.plugin_acquisition_modes:
             print(f"*** plugin acquisition mode {name} exists, can't add another one!")
             return
         self.plugin_acquisition_modes[name] = acquisition_obj(name)
         self.acquire_bar_controller.add_mode(name)
+
+    def register_event_listener(self, event_name, event_handler):
+        """Register an event listener.
+
+        Parameters
+        ----------
+        event_name : string
+            Name of the event.
+        event_handler : function
+            Function to handle the event.
+        """
+        self.event_listeners[event_name] = event_handler
+
+    def register_event_listeners(self, events):
+        """Register multiple event listeners.
+
+        Parameters
+        ----------
+        events : dict
+            Dictionary of event names and handlers.
+        """
+        for event_name, event_handler in events.items():
+            self.register_event_listener(event_name, event_handler)

src/navigate/controller/sub_controllers/adaptive_optics.py

@@ -370,6 +370,7 @@ def plot_mirror(self, data):
 
         try:
             coefs = data["coefs"]
+            self.set_widgets_from_coef(coefs)
             self.coefs_bar.clear()
             self.coefs_bar.bar(range(len(coefs)), coefs)
             self.coefs_bar.set_title("Current Coefs")
@@ -410,6 +411,10 @@ def plot_tonywilson(self, data):
 
         self.plot_tw_trace()
 
+        if data["done"]:
+            print("Tony Wilson done! Updating expt...")
+            self.update_experiment_values()
+
     def plot_tw_trace(self):
         """Plot the tony wilson trace data."""
         mode = self.parent_controller.configuration["experiment"][
@@ -435,3 +440,12 @@ def plot_tw_trace(self):
         # To redraw the plot
         self.fig_tw.tight_layout()
         self.fig_tw.canvas.draw_idle()
+
+    @property
+    def custom_events(self):
+        """dict: Custom events for this controller"""
+        return {
+            "ao_save_report": self.save_report_to_file,
+            "mirror_update": self.plot_mirror,
+            "tonywilson": self.plot_tonywilson,
+        }

src/navigate/controller/sub_controllers/autofocus.py

@@ -204,19 +204,20 @@ def func(*args):
 
         return func
 
-    def display_plot(self, data, line_plot=False, clear_data=True):
+    def display_plot(self, data_and_flags):
         """Displays the autofocus plot
 
-        data : numpy.ndarray
-            The data to be plotted.
-        line_plot : bool
-            If True, the plot will be a line plot.
-            If False, the plot will be a scatter plot.
-        clear_data : bool
-            If True, the plot will be cleared before plotting.
-            If False, the plot will be added to the existing plot.
+        data : tuple (numpy.ndarray, bool, bool)
+            (data, line_plot, clear_data)
+            data: The data to be plotted.
+            line_plot:
+                If True, the plot will be a line plot.
+                If False, the plot will be a scatter plot.
+            clear_data:
+                If True, the plot will be cleared before plotting.
+                If False, the plot will be added to the existing plot.
         """
-
+        data, line_plot, clear_data = data_and_flags
         data = np.asarray(data)
         coarse_range = self.setting_dict.get("coarse_range", 500)
         coarse_step = self.setting_dict.get("coarse_step_size", 50)
@@ -270,3 +271,8 @@ def display_plot(self, data, line_plot=False, clear_data=True):
         self.autofocus_coarse.xaxis.set_minor_locator(tck.AutoMinorLocator())
         self.autofocus_fig.tight_layout()
         self.autofocus_fig.canvas.draw_idle()
+
+    @property
+    def custom_events(self):
+        """dict: Custom events for this controller"""
+        return {"autofocus": self.display_plot}

src/navigate/controller/sub_controllers/camera_settings.py

@@ -580,10 +580,23 @@ def update_camera_device_related_setting(self):
         self.roi_widgets["Center_X"].set(self.default_width / 2)
         self.roi_widgets["Center_Y"].set(self.default_height / 2)
 
-    def update_camera_parameters_silent(self, sensor_mode=None, readout_direction=None, number_of_pixels=None):
+    def update_camera_parameters_silent(self, value):
+        """Update GUI camera parameters
+
+        Parameters
+        ----------
+        value : tuple
+            (sensor_mode, readout_direction, number_of_pixels)
+        """
+        sensor_mode, readout_direction, number_of_pixels = value
         if sensor_mode:
             self.update_sensor_mode(sensor_mode)
         if readout_direction:
             self.mode_widgets["Readout"].set(readout_direction)
         if number_of_pixels:
             self.mode_widgets["Pixels"].set(number_of_pixels)
+
+    @property
+    def custom_events(self):
+        """dict: Custom events for this controller"""
+        return {"display_camera_parameters": self.update_camera_parameters_silent}

src/navigate/controller/sub_controllers/camera_view.py

@@ -1238,3 +1238,8 @@ def try_to_display_image(self, image_id):
 
         display_thread = threading.Thread(target=self.display_image, args=(image_id,))
         display_thread.start()
+
+    @property
+    def custom_events(self):
+        """dict: Custom events for this controller"""
+        return {"ilastik_mask": self.display_mask}

src/navigate/controller/sub_controllers/channels_tab.py

@@ -103,9 +103,8 @@ def __init__(self, view, parent_controller=None):
         self.stack_acq_vals["step_size"].trace_add("write", self.update_z_steps)
         self.stack_acq_vals["start_position"].trace_add("write", self.update_z_steps)
         self.stack_acq_vals["end_position"].trace_add("write", self.update_z_steps)
-        self.stack_acq_vals["start_focus"].trace_add(
-            "write", self.update_z_steps
-        )  # TODO: could be remove later
+        # TODO: could be remove later
+        self.stack_acq_vals["start_focus"].trace_add("write", self.update_z_steps)
         self.stack_acq_buttons["set_start"].configure(
             command=self.update_start_position
         )
@@ -158,9 +157,8 @@ def __init__(self, view, parent_controller=None):
 
         #: bool: Whether or not the user has selected to use multiposition.
         self.is_multiposition_val = self.view.multipoint_frame.on_off
-        self.view.multipoint_frame.save_check.configure(
-            command=self.toggle_multiposition
-        )
+        self.is_multiposition_val.trace_add("write", self.toggle_multiposition)
+
         self.view.multipoint_frame.buttons["tiling"].configure(
             command=self.launch_tiling_wizard
         )
@@ -350,12 +348,10 @@ def set_mode(self, mode):
         # multi-position flag
         if mode == "stop":
             self.is_multiposition_val.set(self.is_multiposition_cache)
-            self.toggle_multiposition()
         else:
             self.is_multiposition_cache = self.is_multiposition
             if mode == "customized":
                 self.is_multiposition_val.set(False)
-                self.toggle_multiposition()
 
         if image_mode == "customized" or mode != "stop":
             self.disable_multiposition_btn()
@@ -712,7 +708,7 @@ def update_timepoint_setting(self, call_parent=False):
             "timepoint settings on channels tab have been changed and recalculated"
         )
 
-    def toggle_multiposition(self):
+    def toggle_multiposition(self, *args):
         """Toggle Multi-position Acquisition.
 
         Recalculates the experiment duration.
@@ -835,17 +831,23 @@ def verify_experiment_values(self):
                 return "Timepoints should be at least 1!"
         return None
 
-    def set_exposure_time(self, channel, exposure_time):
+    def set_exposure_time(self, channel_exposure_time):
         """Set exposure time for a specified channel
 
         Parameters
         ----------
-        channel : str
+        channel_exposure_time : tuple(str, float)
+            (channel_name, exposure_time)
             Channel name, such as "channel_1", "channel_2",...
-        exposure_time : float
             Exposure time in milliseconds.
         """
+        channel, exposure_time = channel_exposure_time
         idx = int(channel[channel.index("_") + 1 :]) - 1
         self.channel_setting_controller.in_initialization = True
         self.channel_setting_controller.view.exptime_variables[idx].set(exposure_time)
         self.channel_setting_controller.in_initialization = False
+
+    @property
+    def custom_events(self):
+        """Custom events for the channels tab."""
+        return {"exposure_time": self.set_exposure_time}