(#863) Add parameter for how to run pin tip detection

src/hyperion/experiment_plans/pin_centre_then_xray_centre_plan.py

@@ -66,6 +66,7 @@ def pin_centre_then_xray_centre_plan(
         pin_tip_centring_composite,
         parameters.experiment_params.tip_offset_microns,
         oav_config_file,
+        parameters.experiment_params.use_ophyd_pin_tip_detect,
     )
 
     grid_detect_params = create_parameters_for_grid_detection(parameters)

src/hyperion/experiment_plans/pin_tip_centring_plan.py

@@ -21,11 +21,7 @@
 )
 from hyperion.exceptions import WarningException
 from hyperion.log import LOGGER
-from hyperion.parameters.constants import (
-    OAV_REFRESH_DELAY,
-    PIN_TIP_SOURCE,
-    PinTipSource,
-)
+from hyperion.parameters.constants import OAV_REFRESH_DELAY
 from hyperion.utils.context import device_composite_from_context
 
 DEFAULT_STEP_SIZE = 0.5
@@ -139,6 +135,7 @@ def pin_tip_centre_plan(
     composite: PinTipCentringComposite,
     tip_offset_microns: float,
     oav_config_file: str = OAV_CONFIG_JSON,
+    use_ophyd_pin_tip_detect: bool = False,
 ):
     """Finds the tip of the pin and moves to roughly the centre based on this tip. Does
     this at both the current omega angle and +90 deg from this angle so as to get a
@@ -147,17 +144,19 @@ def pin_tip_centre_plan(
     Args:
         tip_offset_microns (float): The x offset from the tip where the centre is assumed
                                     to be.
+        use_ophyd_pin_tip_detect (bool): If true use the ophyd device to find the tip,
+                                    rather than the AD plugin.
     """
     oav: OAV = composite.oav
     smargon: Smargon = composite.smargon
     oav_params = OAVParameters("pinTipCentring", oav_config_file)
 
-    if PIN_TIP_SOURCE == PinTipSource.AD_MXSC_PLUGIN:
-        pin_tip_setup = oav.mxsc
-        pin_tip_detect = oav.mxsc.pin_tip
-    else:
+    if use_ophyd_pin_tip_detect:
         pin_tip_setup = composite.pin_tip_detection
         pin_tip_detect = composite.pin_tip_detection
+    else:
+        pin_tip_setup = oav.mxsc
+        pin_tip_detect = oav.mxsc.pin_tip
 
     tip_offset_px = int(tip_offset_microns / oav.parameters.micronsPerXPixel)
 

src/hyperion/parameters/constants.py

@@ -40,30 +40,3 @@ class Status(Enum):
     BUSY = "Busy"
     ABORTING = "Aborting"
     IDLE = "Idle"
-
-
-class PinTipSource:
-    """
-    Two possible sources for how to get pin-tip information from an OAV.
-
-    AD_MXSC_PLUGIN:
-        The calculations for pin-tip detection run in an ADPython areadetector
-        plugin, configured as part of the areadetector plugin chain in EPICS.
-        The pin tip location is being constantly calculated in the background.
-    OPHYD:
-        The calculations are done in an ophyd device, which pulls a camera frame
-        via PVAccess and then calculates the pin tip location locally, only when
-        requested.
-        Due to using PVAccess, this can only work on the beamline control machine,
-        not from a developer machine.
-    """
-
-    AD_MXSC_PLUGIN = 0
-    OHPYD_DEVICE = 1
-
-
-# Hack: currently default to using MXSC plugin.
-# Eventually probably want this passed in as a parameter,
-# or be confident enough in ophyd device that we can just use
-# that unconditionally.
-PIN_TIP_SOURCE = PinTipSource.AD_MXSC_PLUGIN

src/hyperion/parameters/plan_specific/pin_centre_then_xray_centre_params.py

@@ -42,6 +42,10 @@ class PinCentreThenXrayCentreParams(AbstractExperimentParameterBase):
     # Whether to set the stub offsets after centering
     set_stub_offsets: bool = False
 
+    # Whether to use the ophyd device for tip centring rather than the area detector
+    # plugin
+    use_ophyd_pin_tip_detect: bool = False
+
     def get_num_images(self):
         return 0
 

src/hyperion/parameters/plan_specific/wait_for_robot_load_then_center_params.py

@@ -45,6 +45,10 @@ class WaitForRobotLoadThenCentreParams(AbstractExperimentParameterBase):
     omega_start: float
     snapshot_dir: str
 
+    # Whether to use the ophyd device for tip centring rather than the area detector
+    # plugin
+    use_ophyd_pin_tip_detect: bool = False
+
     def get_num_images(self):
         return 0
 

src/hyperion/parameters/schemas/experiment_schemas/wait_for_robot_load_then_centre_schema.json

@@ -13,6 +13,9 @@
         },
         "omega_start": {
             "type": "number"
+        },
+        "use_ophyd_pin_tip_detect": {
+            "type": "boolean"
         }
     },
     "required": [

tests/test_data/parameter_json_files/good_test_pin_centre_then_xray_centre_parameters.json

@@ -43,6 +43,7 @@
         "omega_start": 0.0,
         "tip_offset_microns": 108.9,
         "grid_width_microns": 290.6,
-        "oav_centring_file": "tests/test_data/test_OAVCentring.json"
+        "oav_centring_file": "tests/test_data/test_OAVCentring.json",
+        "use_ophyd_pin_tip_detect": true
     }
 }

tests/test_data/parameter_json_files/good_test_wait_for_robot_load_params.json

@@ -38,6 +38,7 @@
         "omega_start": 0,
         "exposure_time": 0.004,
         "detector_distance": 255,
-        "snapshot_dir": "/tmp"
+        "snapshot_dir": "/tmp",
+        "use_ophyd_pin_tip_detect": true
     }
 }

tests/unit_tests/experiment_plans/test_pin_tip_centring.py

@@ -206,7 +206,7 @@ def test_when_pin_tip_centre_plan_called_then_expected_plans_called(
     )
     RE(pin_tip_centre_plan(composite, 50, test_config_files["oav_config_json"]))
 
-    mock_setup_oav.assert_called_once()
+    assert mock_setup_oav.call_count == 2
 
     assert len(get_move.call_args_list) == 2