Raises numpydoc.

Raising numpydoc and code formatter...

Author: AdvancedImagingUTSW

src/navigate/model/devices/APIs/asi/asi_tiger_controller.py

@@ -666,8 +666,9 @@ def set_speed_as_percent_max(self, pct: float) -> None:
             Percentage of the maximum speed
         """
         if self.default_axes_sequence is None:
-            logger.error(f"{str(self)}, Default axes sequence is not set. "
-            f"Cannot set speed.")
+            logger.error(
+                f"{str(self)}, Default axes sequence is not set. " f"Cannot set speed."
+            )
             raise ASIException(
                 "Unable to query system for axis sequence. Cannot set speed."
             )
@@ -860,8 +861,8 @@ def send_filter_wheel_command(self, cmd: str) -> None:
         self.send_command(f"{cmd}\n")
         # print(f"Sent Command: {command.decode(encoding='ascii')}")
 
-    def select_filter_wheel(self, filter_wheel_number: int=0) -> None:
-        """ Select the filter wheel, e.g., 0, 1...
+    def select_filter_wheel(self, filter_wheel_number: int = 0) -> None:
+        """Select the filter wheel, e.g., 0, 1...
 
         Sets the current filter wheel for later commands. Prompt shows the currently
         selected wheel, e.g., 0> is a result of FW 0 command. If the selected wheel is
@@ -882,7 +883,7 @@ def select_filter_wheel(self, filter_wheel_number: int=0) -> None:
         self.send_filter_wheel_command(f"FW {filter_wheel_number}")
         self.read_response()
 
-    def move_filter_wheel(self, filter_wheel_position: int=0) -> None:
+    def move_filter_wheel(self, filter_wheel_position: int = 0) -> None:
         """Move Filter Wheel
 
         Move to filter position n , where n is a valid filter position.
@@ -904,7 +905,7 @@ def move_filter_wheel_to_home(self) -> None:
         self.send_filter_wheel_command("HO")
         self.read_response()
 
-    def change_filter_wheel_speed(self, speed: int=0) -> None:
+    def change_filter_wheel_speed(self, speed: int = 0) -> None:
         """Change the Filter-Wheel Speed
 
         Selects a consistent set of preset acceleration and speed parameters.
@@ -925,7 +926,7 @@ def halt_filter_wheel(self) -> None:
         self.send_filter_wheel_command("HA")
         self.read_response()
 
-    def move_dichroic(self, dichroic_id: str, dichroic_position: int=0) -> None:
+    def move_dichroic(self, dichroic_id: str, dichroic_position: int = 0) -> None:
         """Move Dichroic Slider.
 
         Move to dichroic position n , where n is a valid filter position.
@@ -952,36 +953,33 @@ def square_wave(self, on_time: int, delay_time: int) -> None:
             Delay time in quarter milliseconds
         """
 
-        commands = ['CCA X=0',
-
-        'M E=2',
-        'CCA Y=15',
-        f'CCA Z={delay_time}',
-        'CCB X=68 Y=192 Z=0',
-
-        'M E=3',
-        'CCA Y=5',
-        'CCB X=1 Y=66',
-
-        'M E=4',
-        'CCA Y=14',
-        f'CCA Z={on_time}',
-        'CCB X=3 Y=192 Z=0',
-
-        'M E=33',
-        'CCA Z=1',
-        'M E=34',
-        'CCA Z=2',
-        'M E=35',
-        'CCA Z=3',
-        'M E=36',
-        'CCA Z=4',
-
-        'M E=1',
-        'CCA Z=1']
+        commands = [
+            "CCA X=0",
+            "M E=2",
+            "CCA Y=15",
+            f"CCA Z={delay_time}",
+            "CCB X=68 Y=192 Z=0",
+            "M E=3",
+            "CCA Y=5",
+            "CCB X=1 Y=66",
+            "M E=4",
+            "CCA Y=14",
+            f"CCA Z={on_time}",
+            "CCB X=3 Y=192 Z=0",
+            "M E=33",
+            "CCA Z=1",
+            "M E=34",
+            "CCA Z=2",
+            "M E=35",
+            "CCA Z=3",
+            "M E=36",
+            "CCA Z=4",
+            "M E=1",
+            "CCA Z=1",
+        ]
         for command in commands:
             # Send data
-            self.send_command(f'{command}\r')
+            self.send_command(f"{command}\r")
             self.read_response()
 
     def logic_card_on(self, axis: str) -> None:
@@ -994,9 +992,9 @@ def logic_card_on(self, axis: str) -> None:
         """
 
         axis = int(axis) + 32
-        self.send_command(f'6 M E = {axis}\r')
+        self.send_command(f"6 M E = {axis}\r")
         self.read_response()
-        self.send_command(f'6 CCA Z=64\r')
+        self.send_command(f"6 CCA Z=64\r")
         self.read_response()
 
     def logic_card_off(self, axis: str) -> None:
@@ -1008,7 +1006,7 @@ def logic_card_off(self, axis: str) -> None:
             The axis of the logic card
         """
         axis = int(axis) + 32
-        self.send_command(f'6 M E = {axis}\r')
+        self.send_command(f"6 M E = {axis}\r")
+        self.read_response()
+        self.send_command(f"6 CCA Z=0\r")
         self.read_response()
-        self.send_command(f'6 CCA Z=0\r')
-        self.read_response()

src/navigate/model/devices/shutter/asi.py

@@ -45,6 +45,7 @@
 p = __name__.split(".")[1]
 logger = logging.getLogger(p)
 
+
 @log_initialization
 class ASIShutter(ShutterBase, SerialDevice):
     """ShutterTTL Class
@@ -74,13 +75,21 @@ def __init__(
         """
         super().__init__(microscope_name, device_connection, configuration)
 
+        #: str: Address of the shutter, if applicable.
         self.address = address
 
+        #: TigerController: ASI Tiger Controller object.
         self.shutter = device_connection
 
-        self.axis = configuration["configuration"]["microscopes"][microscope_name]["shutter"]["hardware"]["axis"]
+        #: str: Axis of the shutter.
+        self.axis = configuration["configuration"]["microscopes"][microscope_name][
+            "shutter"
+        ]["hardware"]["axis"]
 
-        self.port = configuration["configuration"]["microscopes"][microscope_name]["shutter"]["hardware"]["port"]
+        #: str: Port for communicating with the shutter.
+        self.port = configuration["configuration"]["microscopes"][microscope_name][
+            "shutter"
+        ]["hardware"]["port"]
 
     @classmethod
     def connect(cls, port, baudrate=115200, timeout=0.25):
@@ -109,7 +118,13 @@ def connect(cls, port, baudrate=115200, timeout=0.25):
         return tiger_controller
 
     def __del__(self) -> None:
-        """Disconnect from the serial port."""
+        """Disconnect from the serial port.
+
+        Raises
+        -------
+        Exception
+            If there is an error during the cleanup process.
+        """
         try:
             if self.shutter:
                 self.shutter.disconnect_from_serial()
@@ -118,15 +133,27 @@ def __del__(self) -> None:
             logger.exception(f"Error during cleanup: {traceback.format_exc()}")
 
     def open_shutter(self) -> None:
-        """Opens the shutter."""
+        """Opens the shutter.
+
+        Raises
+        -------
+        Exception
+            If there is an error while trying to open the shutter.
+        """
         try:
             self.shutter.logic_card_on(self.axis)
             logger.debug("ASIShutter opened")
         except Exception as e:
             logger.exception(f"Shutter not open: {traceback.format_exc()}")
 
     def close_shutter(self) -> None:
-        """Closes the shutter."""
+        """Closes the shutter.
+
+        Raises
+        -------
+        Exception
+            If there is an error while trying to close the shutter.
+        """
         try:
             self.shutter.logic_card_off(self.axis)
             logger.debug("ASIShutter closed")
@@ -135,5 +162,11 @@ def close_shutter(self) -> None:
 
     @property
     def state(self) -> bool:
-        """Get the state of the shutter."""
+        """Get the state of the shutter.
+
+        Returns
+        -------
+        bool:
+            True if the shutter is open, False if it is closed.
+        """
         return self.shutter.get_axis_position(self.axis)