Camera: remove Camera.get_trigger_type method and TRIGGER_* constants (#197)

Cameras now have a `trigger_type` and `triger_mode` properties.  The
previous `get_trigger_type` method (which returns something different
from the `trigger_type` propertye) was kept for temporary backwards
compatibility and not break Cockpit.  Cockpit now no longer makes use
of `Camera.get_trigger_type` and so we can remove it from Microscope.

This commit removes the Camera.get_trigger_type method as well as its
implementation from all concrete implementations of Camera.  It also
removes the related microscope.abc.TRIGGER_* constants.

Author: carandraug

NEWS.rst

@@ -4,6 +4,15 @@ python-microscope releases.
 Version 0.7.0 (upcoming)
 ------------------------
 
+* Selected most important, backwards incompatible, changes:
+
+  * The `Camera.get_trigger_type` method, deprecated on version 0.6.0,
+    has been removed as well as the multiple `TRIGGER_*` constants it
+    returned.  Use the `Camera.trigger_type` and `Camera.trigger_mode`
+    properties.  Note that, despite the similar names, the removed
+    `Camera.get_trigger_type` does not return the same as
+    `Camera.trigger_type` property.
+
 * The device server logging was broken in version 0.6.0 for Windows
   and macOS (systems not using fork for multiprocessing).  This
   version fixes that issue.

microscope/abc.py

@@ -42,9 +42,6 @@
 _logger = logging.getLogger(__name__)
 
 
-# Trigger types.
-(TRIGGER_AFTER, TRIGGER_BEFORE, TRIGGER_DURATION, TRIGGER_SOFT) = range(4)
-
 # Mapping of setting data types descriptors to allowed-value types.
 #
 # We use a descriptor for the type instead of the actual type because
@@ -993,16 +990,6 @@ def set_roi(self, roi: microscope.ROI) -> None:
             roi = microscope.ROI(left, top, width, height)
         return self._set_roi(roi)
 
-    def get_trigger_type(self):
-        """Return the current trigger mode.
-
-        One of
-            TRIGGER_AFTER,
-            TRIGGER_BEFORE or
-            TRIGGER_DURATION (bulb exposure.)
-        """
-        pass
-
 
 class SerialDeviceMixin(metaclass=abc.ABCMeta):
     """Mixin for devices that are controlled via serial.

microscope/cameras/andorsdk3.py

@@ -49,15 +49,6 @@
 # SDK data pointer type
 DPTR_TYPE = SDK3.POINTER(SDK3.AT_U8)
 
-# Trigger mode to type.
-TRIGGER_MODES = {
-    "internal": None,
-    "external": microscope.abc.TRIGGER_BEFORE,
-    "external start": None,
-    "external exposure": microscope.abc.TRIGGER_DURATION,
-    "software": microscope.abc.TRIGGER_SOFT,
-}
-
 # Convert from SDK3 trigger mode names to Microscope trigger type and
 # mode.
 SDK3_STRING_TO_TRIGGER = {
@@ -577,10 +568,6 @@ def _get_sensor_shape(self):
             self._sensor_height.get_value(),
         )
 
-    def get_trigger_type(self):
-        # deprecated, use trigger_mode and trigger_type properties
-        return TRIGGER_MODES[self._trigger_mode.get_string().lower()]
-
     def soft_trigger(self):
         # deprecated, use triger()
         return self._software_trigger()

microscope/cameras/atmcd.py

@@ -1748,19 +1748,6 @@ def _get_sensor_temperature(self):
         with self:
             return GetTemperature()[1]
 
-    def get_trigger_type(self):
-        """Return the microscope.devices trigger type.
-
-        deprecated, use trigger_mode and trigger_type properties.
-        """
-        trig = self.get_setting("TriggerMode")
-        if trig == TriggerMode.BULB:
-            return microscope.abc.TRIGGER_DURATION
-        elif trig == TriggerMode.SOFTWARE:
-            return microscope.abc.TRIGGER_SOFT
-        else:
-            return microscope.abc.TRIGGER_BEFORE
-
     def soft_trigger(self):
         """Send a software trigger signal.
 

microscope/cameras/pvcam.py

@@ -1116,10 +1116,9 @@ def get_param_dtype(param_id):
 class TriggerMode:
     """A microscope trigger mode using PVCAM PMODES."""
 
-    def __init__(self, label, pv_mode, microscope_mode):
+    def __init__(self, label, pv_mode):
         self.label = label
         self.pv_mode = pv_mode
-        self.microscope_mode = microscope_mode
 
     def __repr__(self):
         return "<%s: '%s'>" % (type(self).__name__, self.label)
@@ -1137,18 +1136,12 @@ def __repr__(self):
 
 # Trigger mode definitions.
 TRIGGER_MODES = {
-    TRIG_SOFT: TriggerMode(
-        "software", TIMED_MODE, microscope.abc.TRIGGER_SOFT
-    ),
-    TRIG_TIMED: TriggerMode("timed", TIMED_MODE, -1),
-    TRIG_VARIABLE: TriggerMode("variable timed", VARIABLE_TIMED_MODE, -1),
-    TRIG_FIRST: TriggerMode(
-        "trig. first", TRIGGER_FIRST_MODE, microscope.abc.TRIGGER_BEFORE,
-    ),
-    TRIG_STROBED: TriggerMode(
-        "strobed", STROBED_MODE, microscope.abc.TRIGGER_BEFORE
-    ),
-    TRIG_BULB: TriggerMode("bulb", BULB_MODE, microscope.abc.TRIGGER_DURATION),
+    TRIG_SOFT: TriggerMode("software", TIMED_MODE),
+    TRIG_TIMED: TriggerMode("timed", TIMED_MODE),
+    TRIG_VARIABLE: TriggerMode("variable timed", VARIABLE_TIMED_MODE),
+    TRIG_FIRST: TriggerMode("trig. first", TRIGGER_FIRST_MODE),
+    TRIG_STROBED: TriggerMode("strobed", STROBED_MODE),
+    TRIG_BULB: TriggerMode("bulb", BULB_MODE),
 }
 
 PV_MODE_TO_TRIGGER = {
@@ -1817,13 +1810,6 @@ def get_cycle_time(self):
         value during _do_enable."""
         return self.cycle_time
 
-    def get_trigger_type(self):
-        """Return the current trigger type.
-
-        Deprecated, get the trigger_mode and trigger_type property.
-        """
-        return TRIGGER_MODES[self._trigger].microscope_mode
-
     @Pyro4.oneway
     def soft_trigger(self):
         """Expose software triggering to a client.

microscope/cameras/ximea.py

@@ -454,11 +454,3 @@ def set_trigger(
             # Changing trigger source requires stopping acquisition.
             with _disabled_camera(self):
                 self._handle.set_trigger_source(trg_source.name)
-
-    def get_trigger_type(self) -> int:
-        ttype_microscope_to_cockpit = {
-            microscope.TriggerType.SOFTWARE: microscope.abc.TRIGGER_SOFT,
-            microscope.TriggerType.RISING_EDGE: microscope.abc.TRIGGER_BEFORE,
-            microscope.TriggerType.FALLING_EDGE: microscope.abc.TRIGGER_AFTER,
-        }
-        return ttype_microscope_to_cockpit[self.trigger_type]

microscope/devices.py

@@ -22,10 +22,6 @@
 
 from microscope import ROI, AxisLimits, Binning, TriggerMode, TriggerType
 from microscope.abc import (
-    TRIGGER_AFTER,
-    TRIGGER_BEFORE,
-    TRIGGER_DURATION,
-    TRIGGER_SOFT,
     Camera as CameraDevice,
     Controller as ControllerDevice,
     DataDevice,

microscope/simulators/__init__.py

@@ -280,10 +280,6 @@ def get_cycle_time(self):
     def _get_sensor_shape(self):
         return (512, 512)
 
-    def get_trigger_type(self):
-        # deprecated, use trigger_type and trigger_mode properties
-        return microscope.abc.TRIGGER_SOFT
-
     def soft_trigger(self):
         # deprecated, use self.trigger()
         self.trigger()