Merge pull request #1069 from annie-xd-wang/ximea-camera

add Ximea camera class file

Author: AdvancedImagingUTSW

src/navigate/controller/sub_controllers/camera_settings.py

@@ -153,7 +153,6 @@ def initialize(self):
         self.update_camera_device_related_setting()
 
         # Camera Mode
-        self.mode_widgets["Sensor"].widget["values"] = ["Normal", "Light-Sheet"]
         self.mode_widgets["Sensor"].widget["state"] = "readonly"
         self.mode_widgets["Sensor"].widget.selection_clear()
 
@@ -219,8 +218,7 @@ def populate_experiment_values(self):
         ][microscope_name]
 
         # Readout Settings
-        self.mode_widgets["Sensor"].set(self.camera_setting_dict["sensor_mode"])
-        self.update_sensor_mode()
+        self.update_sensor_mode(self.camera_setting_dict["sensor_mode"])
 
         # ROI Settings
         if self.camera_setting_dict.get("is_centered", True):
@@ -337,6 +335,11 @@ def update_experiment_values(self, *args):
         ]
         img_width = x_pixels // binning[0]
         img_height = y_pixels // binning[1]
+        img_width = img_width - img_width % self.step_width
+        img_height = img_height - img_height % self.step_height
+
+        x_pixels = img_width * binning[0]
+        y_pixels = img_height * binning[1]
 
         self.camera_setting_dict["x_pixels"] = x_pixels
         self.camera_setting_dict["y_pixels"] = y_pixels
@@ -372,6 +375,8 @@ def update_sensor_mode(self, *args):
         # Camera Mode
         if len(args) > 0 and type(args[0]) is str:
             sensor_value = args[0]
+            if sensor_value not in self.mode_widgets["Sensor"].widget["values"]:
+                sensor_value = self.mode_widgets["Sensor"].widget["values"][0]
             self.mode_widgets["Sensor"].widget.set(sensor_value)
         else:
             sensor_value = self.mode_widgets["Sensor"].widget.get()
@@ -706,6 +711,10 @@ def update_camera_device_related_setting(self):
             "CameraParameters"
         ][microscope_name]
 
+        self.mode_widgets["Sensor"].widget["values"] = camera_config_dict.get("supported_sensor_modes", ["Normal"])
+        if self.mode_widgets["Sensor"].get() not in self.mode_widgets["Sensor"].widget["values"]:
+            self.update_sensor_mode(self.mode_widgets["Sensor"].widget["values"][0])
+
     def update_camera_parameters_silent(self, value):
         """Update GUI camera parameters
 

src/navigate/model/devices/camera/base.py

@@ -130,6 +130,7 @@ def __init__(
         self.camera_parameters["trigger_active"] = 1.0
         self.camera_parameters["trigger_mode"] = 1.0
         self.camera_parameters["trigger_polarity"] = 2.0
+        self.camera_parameters["supported_sensor_modes"] = ["Normal", "Light-Sheet"]
         self.camera_parameters["supported_readout_directions"] = [
             "Top-to-Bottom",
             "Bottom-to-Top",
@@ -258,3 +259,35 @@ def get_line_interval(self) -> float:
             line interval duration (s).
         """
         return self.camera_parameters.get("line_interval", None)
+    
+
+    def set_ROI_and_binning(self, roi_width=2048, roi_height=2048, center_x=1024, center_y=1024, binning='1x1') -> bool:
+        """Change the size of the active region on the camera and set the binning mode.
+
+        Parameters
+        ----------
+        roi_width : int
+            Width of active camera region.
+        roi_height : int
+            Height of active camera region.
+        center_x : int
+            X position of the center of view
+        center_y : int
+            Y position of the center of view
+        binning : str
+            Desired binning properties (e.g., '1x1', '2x2', '4x4', '8x8', '16x16',
+            '1x2', '2x4')
+        
+        Returns
+        -------
+        result: bool
+            True if successful, False otherwise.
+        """
+        # Set ROI
+        result = self.set_ROI(roi_width, roi_height, center_x, center_y)
+        if not result:
+            return False
+
+        # Set Binning
+        result = self.set_binning(binning)
+        return result

src/navigate/model/devices/camera/synthetic.py

@@ -234,18 +234,38 @@ def set_line_interval(self, line_interval_time: float) -> None:
         """
         pass
 
-    def set_binning(self, binning_string: str) -> None:
+    def set_binning(self, binning_string: str) -> bool:
         """Set SyntheticCamera binning mode.
 
         Parameters
         ----------
         binning_string : str
-            Desired binning properties (e.g., '2x2', '4x4', '8x8'
+            Desired binning properties (e.g., '2x2', '4x4', '8x8')
+
+        Returns
+        -------
+        bool
+            True if successful, False otherwise.
         """
+        binning_dict = {
+            "1x1": 1,
+            "2x2": 2,
+            "4x4": 4,
+            # '8x8': 8,
+            # '16x16': 16,
+            # '1x2': 102,
+            # '2x4': 204
+        }
+        if binning_string not in binning_dict.keys():
+            logger.debug(f"can't set binning to {binning_string}")
+            print(f"can't set binning to {binning_string}")
+            return False
+        
         self.x_binning = int(binning_string[0])
         self.y_binning = int(binning_string[2])
         self.x_pixels = int(self.x_pixels / self.x_binning)
         self.y_pixels = int(self.y_pixels / self.y_binning)
+        return True
 
     def initialize_image_series(
         self,
@@ -362,7 +382,7 @@ def set_ROI(
         roi_height: int = 2048,
         center_x: int = 1024,
         center_y: int = 1024,
-    ) -> None:
+    ) -> bool:
         """Change the size of the active region on the camera.
 
         Parameters
@@ -375,11 +395,17 @@ def set_ROI(
             X position of the center of view
         center_y : int
             Y position of the center of view
+        
+        Returns
+        -------
+        bool
+            True if successful, False otherwise.
         """
         self.x_pixels = roi_width
         self.y_pixels = roi_height
         self.center_x = center_x
         self.center_y = center_y
+        return True
 
     @staticmethod
     def calculate_readout_time() -> float: