mx-bluesky 1.4.5__py3-none-any.whl → 1.4.7__py3-none-any.whl

mx_bluesky/hyperion/experiment_plans/oav_snapshot_plan.py

@@ -57,7 +57,7 @@ def _setup_oav(
 ):
     yield from setup_general_oav_params(composite.oav, oav_parameters)
     yield from bps.abs_set(
-        composite.oav.snapshot.directory,  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+        composite.oav.snapshot.directory,
         str(parameters.snapshot_directory),
     )
 
@@ -67,14 +67,14 @@ def _take_oav_snapshot(composite: OavSnapshotComposite, omega: float):
         composite.smargon.omega, omega, group=OAV_SNAPSHOT_SETUP_SHOT
     )
     time_now = datetime.now()
-    filename = f"{time_now.strftime('%H%M%S')}_oav_snapshot_{omega:.0f}"
+    filename = f"{time_now.strftime('%H%M%S%f')[:8]}_oav_snapshot_{omega:.0f}"
     yield from bps.abs_set(
-        composite.oav.snapshot.filename,  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+        composite.oav.snapshot.filename,
         filename,
         group=OAV_SNAPSHOT_SETUP_SHOT,
     )
     yield from bps.wait(group=OAV_SNAPSHOT_SETUP_SHOT)
-    yield from bps.trigger(composite.oav.snapshot, wait=True)  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+    yield from bps.trigger(composite.oav.snapshot, wait=True)
     yield from bps.create(DocDescriptorNames.OAV_ROTATION_SNAPSHOT_TRIGGERED)
-    yield from bps.read(composite.oav.snapshot)  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+    yield from bps.read(composite.oav)
     yield from bps.save()

mx_bluesky/hyperion/experiment_plans/optimise_attenuation_plan.py

@@ -9,8 +9,8 @@ from dodal.devices.attenuator.attenuator import BinaryFilterAttenuator
 from dodal.devices.xspress3.xspress3 import Xspress3
 from dodal.devices.zebra.zebra_controlled_shutter import ZebraShutter, ZebraShutterState
 
+from mx_bluesky.common.utils.context import device_composite_from_context
 from mx_bluesky.common.utils.log import LOGGER
-from mx_bluesky.hyperion.utils.context import device_composite_from_context
 
 
 class AttenuationOptimisationFailedException(Exception):

mx_bluesky/hyperion/experiment_plans/pin_centre_then_xray_centre_plan.py

@@ -12,7 +12,9 @@ from mx_bluesky.common.external_interaction.callbacks.xray_centre.ispyb_callback
     ispyb_activation_wrapper,
 )
 from mx_bluesky.common.parameters.constants import OavConstants
+from mx_bluesky.common.utils.context import device_composite_from_context
 from mx_bluesky.common.utils.log import LOGGER
+from mx_bluesky.common.xrc_result import XRayCentreEventHandler
 from mx_bluesky.hyperion.device_setup_plans.manipulate_sample import move_phi_chi_omega
 from mx_bluesky.hyperion.device_setup_plans.utils import (
     start_preparing_data_collection_then_do_plan,
@@ -20,9 +22,6 @@ from mx_bluesky.hyperion.device_setup_plans.utils import (
 from mx_bluesky.hyperion.experiment_plans.change_aperture_then_move_plan import (
     change_aperture_then_move_to_xtal,
 )
-from mx_bluesky.hyperion.experiment_plans.flyscan_xray_centre_plan import (
-    XRayCentreEventHandler,
-)
 from mx_bluesky.hyperion.experiment_plans.grid_detect_then_xray_centre_plan import (
     GridDetectThenXRayCentreComposite,
     detect_grid_and_do_gridscan,
@@ -39,7 +38,6 @@ from mx_bluesky.hyperion.parameters.gridscan import (
     GridScanWithEdgeDetect,
     PinTipCentreThenXrayCentre,
 )
-from mx_bluesky.hyperion.utils.context import device_composite_from_context
 
 
 def create_devices(context: BlueskyContext) -> GridDetectThenXRayCentreComposite:

mx_bluesky/hyperion/experiment_plans/pin_tip_centring_plan.py

@@ -9,20 +9,21 @@ from dodal.devices.oav.oav_detector import OAV
 from dodal.devices.oav.oav_parameters import OAV_CONFIG_JSON, OAVParameters
 from dodal.devices.oav.pin_image_recognition import PinTipDetection, Tip
 from dodal.devices.oav.utils import (
+    PinNotFoundException,
     Pixel,
     get_move_required_so_that_beam_is_at_pixel,
     wait_for_tip_to_be_found,
 )
 from dodal.devices.smargon import Smargon
 
-from mx_bluesky.common.utils.exceptions import SampleException
+from mx_bluesky.common.utils.context import device_composite_from_context
+from mx_bluesky.common.utils.exceptions import SampleException, catch_exception_and_warn
 from mx_bluesky.common.utils.log import LOGGER
 from mx_bluesky.hyperion.device_setup_plans.setup_oav import pre_centring_setup_oav
 from mx_bluesky.hyperion.device_setup_plans.smargon import (
     move_smargon_warn_on_out_of_range,
 )
 from mx_bluesky.hyperion.parameters.constants import CONST
-from mx_bluesky.hyperion.utils.context import device_composite_from_context
 
 DEFAULT_STEP_SIZE = 0.5
 
@@ -53,7 +54,7 @@ def trigger_and_return_pin_tip(
 def move_pin_into_view(
     pin_tip_device: PinTipDetection,
     smargon: Smargon,
-    step_size_mm: float = DEFAULT_STEP_SIZE,
+    step_magnitude_mm: float = DEFAULT_STEP_SIZE,
     max_steps: int = 2,
 ) -> Generator[Msg, None, Pixel]:
     """Attempt to move the pin into view and return the tip location in pixels if found.
@@ -63,7 +64,7 @@ def move_pin_into_view(
     Args:
         pin_tip_device (PinTipDetection): The device being used to detect the pin
         smargon (Smargon): The gonio to move the tip
-        step_size (float, optional): Distance to move the gonio (in mm) for each
+        step_magnitude_mm (float, optional): Distance to move the gonio (in mm) for each
                                     step of the search. Defaults to 0.5.
         max_steps (int, optional): The number of steps to search with. Defaults to 2.
 
@@ -83,21 +84,21 @@ def move_pin_into_view(
         if pin_tip_valid(tip_xy_px):
             return (int(tip_xy_px[0]), int(tip_xy_px[1]))
 
-        if tip_xy_px[0] == 0:
-            # Pin is off in the -ve direction
-            step_size_mm = -step_size_mm
+        # Pin is off in the -ve direction if the returned tip x pixel value is 0
+        direction_multiple = -1 if tip_xy_px[0] == 0 else 1
+        step_vector_mm = step_magnitude_mm * direction_multiple
 
         smargon_x = yield from bps.rd(smargon.x.user_readback)
-        ideal_move_to_find_pin = float(smargon_x) + step_size_mm
+        ideal_move_to_find_pin = float(smargon_x) + step_vector_mm
         high_limit = yield from bps.rd(smargon.x.high_limit_travel)
         low_limit = yield from bps.rd(smargon.x.low_limit_travel)
         move_within_limits = max(min(ideal_move_to_find_pin, high_limit), low_limit)
         if move_within_limits != ideal_move_to_find_pin:
             LOGGER.warning(
-                f"Pin tip is off screen, and moving {step_size_mm} mm would cross limits, "
+                f"Pin tip is off screen, and moving {step_vector_mm}mm would cross limits, "
                 f"moving to {move_within_limits} instead"
             )
-        yield from bps.mv(smargon.x, move_within_limits)  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+        yield from bps.mv(smargon.x, move_within_limits)
 
         # Some time for the view to settle after the move
         yield from bps.sleep(CONST.HARDWARE.OAV_REFRESH_DELAY)
@@ -154,11 +155,12 @@ def pin_tip_centre_plan(
     tip = yield from move_pin_into_view(pin_tip_detect, smargon)
     yield from offset_and_move(tip)
 
-    yield from bps.mvr(smargon.omega, 90)  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+    yield from bps.mvr(smargon.omega, 90)
 
     # need to wait for the OAV image to update
     # See #673 for improvements
     yield from bps.sleep(0.3)
-
-    tip = yield from wait_for_tip_to_be_found(pin_tip_detect)
+    tip = yield from catch_exception_and_warn(
+        PinNotFoundException, wait_for_tip_to_be_found, pin_tip_detect
+    )
     yield from offset_and_move(tip)

mx_bluesky/hyperion/experiment_plans/robot_load_and_change_energy.py

@@ -54,7 +54,7 @@ class RobotLoadAndEnergyChangeComposite:
 
 
 def create_devices(context: BlueskyContext) -> RobotLoadAndEnergyChangeComposite:
-    from mx_bluesky.hyperion.utils.context import device_composite_from_context
+    from mx_bluesky.common.utils.context import device_composite_from_context
 
     return device_composite_from_context(context, RobotLoadAndEnergyChangeComposite)
 
@@ -98,16 +98,16 @@ def prepare_for_robot_load(
         aperture_scatterguard, ApertureValue.OUT_OF_BEAM, group="prepare_robot_load"
     )
 
-    yield from bps.mv(smargon.stub_offsets, StubPosition.RESET_TO_ROBOT_LOAD)  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+    yield from bps.mv(smargon.stub_offsets, StubPosition.RESET_TO_ROBOT_LOAD)
 
     # fmt: off
     yield from bps.mv(
-        smargon.x, 0,  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
-        smargon.y, 0,  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
-        smargon.z, 0,  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
-        smargon.omega, 0,  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
-        smargon.chi, 0,  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
-        smargon.phi, 0  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+        smargon.x, 0,
+        smargon.y, 0,
+        smargon.z, 0,
+        smargon.omega, 0,
+        smargon.chi, 0,
+        smargon.phi, 0
     )
     # fmt: on
 
@@ -131,7 +131,7 @@ def do_robot_load(
     yield from bps.wait("robot_load")
 
     yield from bps.abs_set(
-        composite.thawer.thaw_for_time_s,  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+        composite.thawer.thaw_for_time_s,
         thawing_time,
         group="thawing_finished",
     )
@@ -193,7 +193,7 @@ def robot_load_and_snapshots(
 
     yield from bps.create(name=CONST.DESCRIPTORS.ROBOT_LOAD)
     yield from bps.read(composite.robot.barcode)
-    yield from bps.read(composite.oav.snapshot)  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+    yield from bps.read(composite.oav.snapshot)
     yield from bps.read(composite.webcam)
     yield from bps.save()
 

mx_bluesky/hyperion/experiment_plans/robot_load_then_centre_plan.py

@@ -3,7 +3,6 @@ from __future__ import annotations
 from math import isclose
 from typing import cast
 
-import bluesky.preprocessors as bpp
 import pydantic
 from blueapi.core import BlueskyContext
 from bluesky import plan_stubs as bps
@@ -41,12 +40,6 @@ from mx_bluesky.hyperion.device_setup_plans.utils import (
     fill_in_energy_if_not_supplied,
     start_preparing_data_collection_then_do_plan,
 )
-from mx_bluesky.hyperion.experiment_plans.change_aperture_then_move_plan import (
-    change_aperture_then_move_to_xtal,
-)
-from mx_bluesky.hyperion.experiment_plans.flyscan_xray_centre_plan import (
-    XRayCentreEventHandler,
-)
 from mx_bluesky.hyperion.experiment_plans.grid_detect_then_xray_centre_plan import (
     GridDetectThenXRayCentreComposite,
 )
@@ -106,7 +99,7 @@ class RobotLoadThenCentreComposite:
 
 
 def create_devices(context: BlueskyContext) -> RobotLoadThenCentreComposite:
-    from mx_bluesky.hyperion.utils.context import device_composite_from_context
+    from mx_bluesky.common.utils.context import device_composite_from_context
 
     return device_composite_from_context(context, RobotLoadThenCentreComposite)
 
@@ -135,27 +128,6 @@ def _robot_load_then_flyscan_plan(
     yield from _flyscan_plan_from_robot_load_params(composite, params, oav_config_file)
 
 
-def robot_load_then_centre(
-    composite: RobotLoadThenCentreComposite,
-    parameters: RobotLoadThenCentre,
-) -> MsgGenerator:
-    """Perform pin-tip detection followed by a flyscan to determine centres of interest.
-    Performs a robot load if necessary. Centre on the best diffracting centre.
-    """
-
-    xray_centre_event_handler = XRayCentreEventHandler()
-
-    yield from bpp.subs_wrapper(
-        robot_load_then_xray_centre(composite, parameters), xray_centre_event_handler
-    )
-    flyscan_results = xray_centre_event_handler.xray_centre_results
-    if flyscan_results is not None:
-        yield from change_aperture_then_move_to_xtal(
-            flyscan_results[0], composite.smargon, composite.aperture_scatterguard
-        )
-    # else no chi change, no need to recentre.
-
-
 def robot_load_then_xray_centre(
     composite: RobotLoadThenCentreComposite,
     parameters: RobotLoadThenCentre,

mx_bluesky/hyperion/experiment_plans/rotation_scan_plan.py

@@ -26,10 +26,20 @@ from dodal.devices.xbpm_feedback import XBPMFeedback
 from dodal.devices.zebra.zebra import RotationDirection, Zebra
 from dodal.devices.zebra.zebra_controlled_shutter import ZebraShutter
 from dodal.plan_stubs.check_topup import check_topup_and_wait_if_necessary
+from dodal.plans.preprocessors.verify_undulator_gap import (
+    verify_undulator_gap_before_run_decorator,
+)
 
-from mx_bluesky.common.device_setup_plans.read_hardware_for_setup import (
+from mx_bluesky.common.parameters.components import WithSnapshot
+from mx_bluesky.common.plans.read_hardware import (
     read_hardware_for_zocalo,
+    standard_read_hardware_during_collection,
+    standard_read_hardware_pre_collection,
+)
+from mx_bluesky.common.preprocessors.preprocessors import (
+    transmission_and_xbpm_feedback_for_collection_decorator,
 )
+from mx_bluesky.common.utils.context import device_composite_from_context
 from mx_bluesky.common.utils.log import LOGGER
 from mx_bluesky.hyperion.device_setup_plans.manipulate_sample import (
     cleanup_sample_environment,
@@ -37,10 +47,6 @@ from mx_bluesky.hyperion.device_setup_plans.manipulate_sample import (
     move_x_y_z,
     setup_sample_environment,
 )
-from mx_bluesky.hyperion.device_setup_plans.read_hardware_for_setup import (
-    read_hardware_during_collection,
-    read_hardware_pre_collection,
-)
 from mx_bluesky.hyperion.device_setup_plans.setup_zebra import (
     arm_zebra,
     setup_zebra_for_rotation,
@@ -49,9 +55,6 @@ from mx_bluesky.hyperion.device_setup_plans.setup_zebra import (
 from mx_bluesky.hyperion.device_setup_plans.utils import (
     start_preparing_data_collection_then_do_plan,
 )
-from mx_bluesky.hyperion.device_setup_plans.xbpm_feedback import (
-    transmission_and_xbpm_feedback_for_collection_decorator,
-)
 from mx_bluesky.hyperion.experiment_plans.oav_snapshot_plan import (
     OavSnapshotComposite,
     oav_snapshot_plan,
@@ -62,7 +65,6 @@ from mx_bluesky.hyperion.parameters.rotation import (
     MultiRotationScan,
     RotationScan,
 )
-from mx_bluesky.hyperion.utils.context import device_composite_from_context
 
 
 @pydantic.dataclasses.dataclass(config={"arbitrary_types_allowed": True})
@@ -267,7 +269,7 @@ def rotation_scan_plan(
         # get some information for the ispyb deposition and trigger the callback
         yield from read_hardware_for_zocalo(composite.eiger)
 
-        yield from read_hardware_pre_collection(
+        yield from standard_read_hardware_pre_collection(
             composite.undulator,
             composite.synchrotron,
             composite.s4_slit_gaps,
@@ -293,7 +295,7 @@ def rotation_scan_plan(
         LOGGER.info("Executing rotation scan")
         yield from bps.rel_set(axis, motion_values.distance_to_move_deg, wait=True)
 
-        yield from read_hardware_during_collection(
+        yield from standard_read_hardware_during_collection(
             composite.aperture_scatterguard,
             composite.attenuator,
             composite.flux,
@@ -371,24 +373,26 @@ def rotation_scan(
     if not oav_params:
         oav_params = OAVParameters(context="xrayCentring")
 
+    @transmission_and_xbpm_feedback_for_collection_decorator(
+        composite,
+        parameters.transmission_frac,
+    )
+    @verify_undulator_gap_before_run_decorator(composite)
     @bpp.set_run_key_decorator("rotation_scan")
     @bpp.run_decorator(  # attach experiment metadata to the start document
         md={
             "subplan_name": CONST.PLAN.ROTATION_OUTER,
             "mx_bluesky_parameters": parameters.model_dump_json(),
+            "with_snapshot": parameters.model_dump_json(
+                include=WithSnapshot.model_fields.keys()  # type: ignore
+            ),
             "activate_callbacks": [
+                "BeamDrawingCallback",
                 "RotationISPyBCallback",
                 "RotationNexusFileCallback",
             ],
         }
     )
-    @transmission_and_xbpm_feedback_for_collection_decorator(
-        composite.undulator,
-        composite.xbpm_feedback,
-        composite.attenuator,
-        composite.dcm,
-        parameters.transmission_frac,
-    )
     def rotation_scan_plan_with_stage_and_cleanup(
         params: RotationScan,
     ):
@@ -408,7 +412,7 @@ def rotation_scan(
             rotation_with_cleanup_and_stage(params),
             group=CONST.WAIT.ROTATION_READY_FOR_DC,
         )
-        yield from bps.unstage(eiger)  # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
+        yield from bps.unstage(eiger)
 
     yield from rotation_scan_plan_with_stage_and_cleanup(parameters)
 
@@ -424,6 +428,10 @@ def multi_rotation_scan(
     eiger: EigerDetector = composite.eiger
     eiger.set_detector_parameters(parameters.detector_params)
 
+    @transmission_and_xbpm_feedback_for_collection_decorator(
+        composite,
+        parameters.transmission_frac,
+    )
     @bpp.set_run_key_decorator("multi_rotation_scan")
     @bpp.run_decorator(
         md={
@@ -436,17 +444,11 @@ def multi_rotation_scan(
             ],
         }
     )
-    @transmission_and_xbpm_feedback_for_collection_decorator(
-        composite.undulator,
-        composite.xbpm_feedback,
-        composite.attenuator,
-        composite.dcm,
-        parameters.transmission_frac,
-    )
     @bpp.finalize_decorator(lambda: _cleanup_plan(composite))
     def _multi_rotation_scan():
         for single_scan in parameters.single_rotation_scans:
 
+            @verify_undulator_gap_before_run_decorator(composite)
             @bpp.set_run_key_decorator("rotation_scan")
             @bpp.run_decorator(  # attach experiment metadata to the start document
                 md={
@@ -461,6 +463,8 @@ def multi_rotation_scan(
 
             yield from rotation_scan_core(single_scan)
 
+        yield from bps.unstage(eiger)
+
     LOGGER.info("setting up and staging eiger...")
     yield from start_preparing_data_collection_then_do_plan(
         composite.beamstop,
@@ -470,4 +474,3 @@ def multi_rotation_scan(
         _multi_rotation_scan(),
         group=CONST.WAIT.ROTATION_READY_FOR_DC,
     )
-    yield from bps.unstage(eiger)

mx_bluesky/hyperion/experiment_plans/set_energy_plan.py

@@ -5,18 +5,21 @@
 * reenable feedback
 """
 
+import bluesky.preprocessors as bpp
 import pydantic
 from bluesky import plan_stubs as bps
 from dodal.devices.attenuator.attenuator import BinaryFilterAttenuator
 from dodal.devices.dcm import DCM
 from dodal.devices.focusing_mirror import FocusingMirrorWithStripes, MirrorVoltages
+from dodal.devices.undulator import Undulator
 from dodal.devices.undulator_dcm import UndulatorDCM
 from dodal.devices.xbpm_feedback import XBPMFeedback
 
-from mx_bluesky.hyperion.device_setup_plans import dcm_pitch_roll_mirror_adjuster
-from mx_bluesky.hyperion.device_setup_plans.xbpm_feedback import (
+from mx_bluesky.common.parameters.constants import PlanNameConstants
+from mx_bluesky.common.preprocessors.preprocessors import (
     transmission_and_xbpm_feedback_for_collection_wrapper,
 )
+from mx_bluesky.hyperion.device_setup_plans import dcm_pitch_roll_mirror_adjuster
 
 DESIRED_TRANSMISSION_FRACTION = 0.1
 
@@ -33,6 +36,17 @@ class SetEnergyComposite:
     attenuator: BinaryFilterAttenuator
 
 
+# Remove composite after https://github.com/DiamondLightSource/dodal/issues/1092
+@pydantic.dataclasses.dataclass(config={"arbitrary_types_allowed": True})
+class XBPMWrapperComposite:
+    undulator: Undulator
+    xbpm_feedback: XBPMFeedback
+    attenuator: BinaryFilterAttenuator
+    dcm: DCM
+
+
+@bpp.set_run_key_decorator(PlanNameConstants.SET_ENERGY)
+@bpp.run_decorator()
 def _set_energy_plan(
     energy_kev,
     composite: SetEnergyComposite,
@@ -51,12 +65,17 @@ def set_energy_plan(
     energy_ev: float | None,
     composite: SetEnergyComposite,
 ):
+    # Remove conversion after https://github.com/DiamondLightSource/dodal/issues/1092
+    composite_for_wrapper = XBPMWrapperComposite(
+        composite.undulator_dcm.undulator_ref._obj,  # noqa: SLF001
+        composite.xbpm_feedback,
+        composite.attenuator,
+        composite.dcm,
+    )
+
     if energy_ev:
         yield from transmission_and_xbpm_feedback_for_collection_wrapper(
             _set_energy_plan(energy_ev / 1000, composite),
-            composite.undulator_dcm.undulator_ref(),
-            composite.xbpm_feedback,
-            composite.attenuator,
-            composite.dcm,
+            composite_for_wrapper,
             DESIRED_TRANSMISSION_FRACTION,
         )