WIP begin refactor of common gridscans

Author: olliesilvester

src/mx_bluesky/beamlines/i04/experiment_plans/i04_grid_detect_then_xray_centre_plan.py

@@ -13,7 +13,7 @@
 from dodal.devices.detector.detector_motion import DetectorMotion
 from dodal.devices.eiger import EigerDetector
 from dodal.devices.fast_grid_scan import (
-    ZebraFastGridScan,
+    ZebraThreeDFastGridScan,
     set_fast_grid_scan_params,
 )
 from dodal.devices.flux import Flux
@@ -80,7 +80,7 @@ def i04_grid_detect_then_xray_centre(
     backlight: Backlight = inject("backlight"),
     beamstop: Beamstop = inject("beamstop"),
     dcm: BaseDCM = inject("dcm"),
-    zebra_fast_grid_scan: ZebraFastGridScan = inject("zebra_fast_grid_scan"),
+    zebra_fast_grid_scan: ZebraThreeDFastGridScan = inject("zebra_fast_grid_scan"),
     flux: Flux = inject("flux"),
     oav: OAV = inject("oav"),
     pin_tip_detection: PinTipDetection = inject("pin_tip_detection"),

src/mx_bluesky/common/experiment_plans/common_flyscan_xray_centre_plan.py

@@ -290,6 +290,7 @@ def run_gridscan(
 
     # GDA's gridscans requires Z steps to be at 0, so make sure we leave this device
     # in a GDA-happy state.
+    # TODO if fgs motors is 3d then do the below
     yield from bps.abs_set(beamline_specific.fgs_motors.z_steps, 0, wait=False)
 
 

src/mx_bluesky/common/parameters/device_composites.py

@@ -10,7 +10,7 @@
 from dodal.devices.detector.detector_motion import DetectorMotion
 from dodal.devices.eiger import EigerDetector
 from dodal.devices.fast_grid_scan import (
-    ZebraFastGridScan,
+    ZebraThreeDFastGridScan,
 )
 from dodal.devices.flux import Flux
 from dodal.devices.mx_phase1.beamstop import Beamstop
@@ -62,7 +62,7 @@ class GridDetectThenXRayCentreComposite(FlyScanEssentialDevices):
     beamstop: Beamstop
     dcm: BaseDCM
     detector_motion: DetectorMotion
-    zebra_fast_grid_scan: ZebraFastGridScan
+    zebra_fast_grid_scan: ZebraThreeDFastGridScan
     flux: Flux
     oav: OAV
     pin_tip_detection: PinTipDetection

src/mx_bluesky/hyperion/experiment_plans/robot_load_then_centre_plan.py

@@ -12,7 +12,7 @@
 from dodal.devices.backlight import Backlight
 from dodal.devices.detector.detector_motion import DetectorMotion
 from dodal.devices.eiger import EigerDetector
-from dodal.devices.fast_grid_scan import PandAFastGridScan, ZebraFastGridScan
+from dodal.devices.fast_grid_scan import PandAFastGridScan, ZebraThreeDFastGridScan
 from dodal.devices.flux import Flux
 from dodal.devices.focusing_mirror import FocusingMirrorWithStripes, MirrorVoltages
 from dodal.devices.i03 import Beamstop
@@ -72,7 +72,7 @@ class RobotLoadThenCentreComposite:
     backlight: Backlight
     detector_motion: DetectorMotion
     eiger: EigerDetector
-    zebra_fast_grid_scan: ZebraFastGridScan
+    zebra_fast_grid_scan: ZebraThreeDFastGridScan
     flux: Flux
     oav: OAV
     pin_tip_detection: PinTipDetection

src/mx_bluesky/hyperion/parameters/device_composites.py

@@ -10,7 +10,7 @@
 from dodal.devices.eiger import EigerDetector
 from dodal.devices.fast_grid_scan import (
     PandAFastGridScan,
-    ZebraFastGridScan,
+    ZebraThreeDFastGridScan,
 )
 from dodal.devices.flux import Flux
 from dodal.devices.robot import BartRobot
@@ -52,7 +52,7 @@ class HyperionFlyScanXRayCentreComposite(FlyScanEssentialDevices):
     sample_shutter: ZebraShutter
     backlight: Backlight
     xbpm_feedback: XBPMFeedback
-    zebra_fast_grid_scan: ZebraFastGridScan
+    zebra_fast_grid_scan: ZebraThreeDFastGridScan
     smargon: Smargon
 
 

tests/unit_tests/beamlines/i04/test_i04_grid_detect_then_xray_centre_plan.py

@@ -13,7 +13,7 @@
 from dodal.devices.detector.detector_motion import DetectorMotion
 from dodal.devices.eiger import EigerDetector
 from dodal.devices.fast_grid_scan import (
-    ZebraFastGridScan,
+    ZebraThreeDFastGridScan,
 )
 from dodal.devices.flux import Flux
 from dodal.devices.mx_phase1.beamstop import Beamstop
@@ -51,7 +51,7 @@ def i04_grid_detect_then_xrc_default_params(
     backlight: Backlight,
     beamstop_phase1: Beamstop,
     dcm: BaseDCM,
-    zebra_fast_grid_scan: ZebraFastGridScan,
+    zebra_fast_grid_scan: ZebraThreeDFastGridScan,
     flux: Flux,
     oav: OAV,
     pin_tip_detection_with_found_pin: PinTipDetection,

tests/unit_tests/common/experiment_plans/inner_plans/test_do_fgs.py

@@ -7,7 +7,7 @@
 from bluesky.simulators import RunEngineSimulator, assert_message_and_return_remaining
 from bluesky.utils import MsgGenerator
 from dodal.beamlines.i03 import eiger
-from dodal.devices.fast_grid_scan import ZebraFastGridScan
+from dodal.devices.fast_grid_scan import ZebraThreeDFastGridScan
 from dodal.devices.synchrotron import Synchrotron, SynchrotronMode
 from dodal.devices.zocalo.zocalo_results import (
     ZOCALO_STAGE_GROUP,
@@ -28,7 +28,7 @@
 def fgs_devices(RE):
     with init_devices(mock=True):
         synchrotron = Synchrotron()
-        grid_scan_device = ZebraFastGridScan("zebra_fgs")
+        grid_scan_device = ZebraThreeDFastGridScan("zebra_fgs")
 
     # Eiger done separately as not ophyd-async yet
     detector = eiger(mock=True)
@@ -125,7 +125,7 @@ def event(self, doc: Event):
     synchrotron = fgs_devices["synchrotron"]
     set_mock_value(synchrotron.synchrotron_mode, SynchrotronMode.DEV)
     detector = fgs_devices["detector"]
-    fgs_device: ZebraFastGridScan = fgs_devices["grid_scan_device"]
+    fgs_device: ZebraThreeDFastGridScan = fgs_devices["grid_scan_device"]
 
     detector.unstage = MagicMock()
 

tests/unit_tests/common/experiment_plans/test_common_flyscan_xray_centre_plan.py

@@ -12,7 +12,7 @@
 from dodal.devices.detector.det_dim_constants import (
     EIGER_TYPE_EIGER2_X_16M,
 )
-from dodal.devices.fast_grid_scan import ZebraFastGridScan
+from dodal.devices.fast_grid_scan import ZebraThreeDFastGridScan
 from dodal.devices.smargon import CombinedMove
 from dodal.devices.synchrotron import SynchrotronMode
 from dodal.devices.zocalo import ZocaloStartInfo
@@ -229,7 +229,7 @@ def test_plan():
     def test_GIVEN_scan_already_valid_THEN_wait_for_GRIDSCAN_returns_immediately(
         self, patch_sleep: MagicMock, RE: RunEngine
     ):
-        test_fgs: ZebraFastGridScan = i03.zebra_fast_grid_scan(
+        test_fgs: ZebraThreeDFastGridScan = i03.zebra_fast_grid_scan(
             connect_immediately=True, mock=True
         )
 
@@ -247,7 +247,7 @@ def test_GIVEN_scan_already_valid_THEN_wait_for_GRIDSCAN_returns_immediately(
     def test_GIVEN_scan_not_valid_THEN_wait_for_GRIDSCAN_raises_and_sleeps_called(
         self, patch_sleep: MagicMock, RE: RunEngine
     ):
-        test_fgs: ZebraFastGridScan = i03.zebra_fast_grid_scan(
+        test_fgs: ZebraThreeDFastGridScan = i03.zebra_fast_grid_scan(
             connect_immediately=True, mock=True
         )
 
@@ -447,7 +447,7 @@ def test_kickoff_and_complete_gridscan_triggers_zocalo(
         RE: RunEngine,
         fake_fgs_composite: FlyScanEssentialDevices,
         dummy_rotation_data_collection_group_info,
-        zebra_fast_grid_scan: ZebraFastGridScan,
+        zebra_fast_grid_scan: ZebraThreeDFastGridScan,
     ):
         id_1, id_2 = 100, 200
 

tests/unit_tests/conftest.py

@@ -15,7 +15,7 @@
 from dodal.devices.backlight import Backlight
 from dodal.devices.detector.detector_motion import DetectorMotion
 from dodal.devices.eiger import EigerDetector
-from dodal.devices.fast_grid_scan import PandAFastGridScan, ZebraFastGridScan
+from dodal.devices.fast_grid_scan import PandAFastGridScan, ZebraThreeDFastGridScan
 from dodal.devices.flux import Flux
 from dodal.devices.i03 import Beamstop
 from dodal.devices.oav.oav_detector import OAV
@@ -396,7 +396,7 @@ def dummy_rotation_data_collection_group_info():
 
 @pytest.fixture
 def beamline_specific(
-    zebra_fast_grid_scan: ZebraFastGridScan,
+    zebra_fast_grid_scan: ZebraThreeDFastGridScan,
 ) -> BeamlineSpecificFGSFeatures:
     return BeamlineSpecificFGSFeatures(
         setup_trigger_plan=MagicMock(),
@@ -430,7 +430,7 @@ async def grid_detect_xrc_devices(
     ophyd_pin_tip_detection: PinTipDetection,
     zocalo: ZocaloResults,
     synchrotron: Synchrotron,
-    fast_grid_scan: ZebraFastGridScan,
+    fast_grid_scan: ZebraThreeDFastGridScan,
     s4_slit_gaps: S4SlitGaps,
     flux: Flux,
     zebra,