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

mx_bluesky/hyperion/experiment_plans/load_centre_collect_full_plan.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
-from collections.abc import Sequence
-
+import bluesky.plan_stubs as bps
+import numpy as np
 import pydantic
 from blueapi.core import BlueskyContext
 from bluesky.preprocessors import run_decorator, set_run_key_decorator, subs_wrapper
@@ -66,33 +66,40 @@ def load_centre_collect_full(
             flyscan_event_handler,
         )
 
-        assert flyscan_event_handler.xray_centre_results, (
-            "Flyscan result event not received or no crystal found and exception not raised"
-        )
+        locations_to_collect_um: list[np.ndarray] = []
 
-        selection_func = flyscan_result.resolve_selection_fn(
-            parameters.selection_params
-        )
-        hits: Sequence[flyscan_result.XRayCentreResult] = selection_func(
-            flyscan_event_handler.xray_centre_results
-        )
-        LOGGER.info(
-            f"Selected hits {hits} using {selection_func}, args={parameters.selection_params}"
-        )
+        if flyscan_event_handler.xray_centre_results:
+            selection_func = flyscan_result.resolve_selection_fn(
+                parameters.selection_params
+            )
+            hits = selection_func(flyscan_event_handler.xray_centre_results)
+            locations_to_collect_um = [hit.centre_of_mass_mm * 1000 for hit in hits]
+
+            LOGGER.info(
+                f"Selected hits {hits} using {selection_func}, args={parameters.selection_params}"
+            )
+        else:
+            # If the xray centring hasn't found a result but has not thrown an error it
+            # means that we do not need to recentre and can collect where we are
+            initial_x = yield from bps.rd(composite.smargon.x.user_readback)
+            initial_y = yield from bps.rd(composite.smargon.y.user_readback)
+            initial_z = yield from bps.rd(composite.smargon.z.user_readback)
+
+            locations_to_collect_um = [np.array([initial_x, initial_y, initial_z])]
 
         multi_rotation = parameters.multi_rotation_scan
         rotation_template = multi_rotation.rotation_scans.copy()
 
         multi_rotation.rotation_scans.clear()
 
-        for hit in hits:
+        for location in locations_to_collect_um:
             for rot in rotation_template:
                 combination = rot.model_copy()
                 (
                     combination.x_start_um,
                     combination.y_start_um,
                     combination.z_start_um,
-                ) = (axis * 1000 for axis in hit.centre_of_mass_mm)
+                ) = location
                 multi_rotation.rotation_scans.append(combination)
         multi_rotation = MultiRotationScan.model_validate(multi_rotation)
 

mx_bluesky/hyperion/experiment_plans/oav_snapshot_plan.py

@@ -34,9 +34,7 @@ def setup_beamline_for_OAV(
     yield from bps.abs_set(smargon.omega.velocity, max_vel, group=group)
     yield from bps.abs_set(backlight, BacklightPosition.IN, group=group)
     yield from bps.abs_set(
-        aperture_scatterguard,
-        ApertureValue.ROBOT_LOAD,
-        group=group,
+        aperture_scatterguard, ApertureValue.OUT_OF_BEAM, group=group
     )
 
 
@@ -44,11 +42,9 @@ def oav_snapshot_plan(
     composite: OavSnapshotComposite,
     parameters: WithSnapshot,
     oav_parameters: OAVParameters,
-    wait: bool = True,
 ) -> MsgGenerator:
     if not parameters.take_snapshots:
         return
-    yield from bps.wait(group=CONST.WAIT.READY_FOR_OAV)
     yield from _setup_oav(composite, parameters, oav_parameters)
     for omega in parameters.snapshot_omegas_deg or []:
         yield from _take_oav_snapshot(composite, omega)

mx_bluesky/hyperion/experiment_plans/robot_load_and_change_energy.py

@@ -95,9 +95,7 @@ def prepare_for_robot_load(
     aperture_scatterguard: ApertureScatterguard, smargon: Smargon
 ):
     yield from bps.abs_set(
-        aperture_scatterguard,
-        ApertureValue.ROBOT_LOAD,
-        group="prepare_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
@@ -122,11 +120,6 @@ def do_robot_load(
     demand_energy_ev: float | None,
     thawing_time: float,
 ):
-    error_code = yield from bps.rd(composite.robot.error_code)
-    # Reset robot if light curtains were tripped
-    if error_code == 40:
-        yield from bps.trigger(composite.robot.reset, wait=True)
-
     yield from bps.abs_set(
         composite.robot,
         sample_location,

mx_bluesky/hyperion/experiment_plans/rotation_scan_plan.py

@@ -346,6 +346,13 @@ def _move_and_rotation(
         yield from setup_beamline_for_OAV(
             composite.smargon, composite.backlight, composite.aperture_scatterguard
         )
+        yield from bps.wait(group=CONST.WAIT.READY_FOR_OAV)
+        if params.selected_aperture:
+            yield from bps.prepare(
+                composite.aperture_scatterguard,
+                params.selected_aperture,
+                group=CONST.WAIT.ROTATION_READY_FOR_DC,
+            )
         yield from oav_snapshot_plan(composite, params, oav_params)
     yield from rotation_scan_plan(
         composite,
@@ -368,8 +375,6 @@ def rotation_scan(
     @bpp.run_decorator(  # attach experiment metadata to the start document
         md={
             "subplan_name": CONST.PLAN.ROTATION_OUTER,
-            CONST.TRIGGER.ZOCALO: CONST.PLAN.ROTATION_MAIN,
-            "zocalo_environment": CONST.ZOCALO_ENV,
             "mx_bluesky_parameters": parameters.model_dump_json(),
             "activate_callbacks": [
                 "RotationISPyBCallback",
@@ -378,8 +383,10 @@ def rotation_scan(
         }
     )
     @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(
@@ -429,10 +436,11 @@ def multi_rotation_scan(
             ],
         }
     )
-    @bpp.stage_decorator([eiger])
     @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))
@@ -443,7 +451,6 @@ def multi_rotation_scan(
             @bpp.run_decorator(  # attach experiment metadata to the start document
                 md={
                     "subplan_name": CONST.PLAN.ROTATION_OUTER,
-                    CONST.TRIGGER.ZOCALO: CONST.PLAN.ROTATION_MAIN,
                     "mx_bluesky_parameters": single_scan.model_dump_json(),
                 }
             )
@@ -463,3 +470,4 @@ 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

@@ -54,7 +54,9 @@ def set_energy_plan(
     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,
             DESIRED_TRANSMISSION_FRACTION,
         )

mx_bluesky/hyperion/external_interaction/callbacks/__main__.py

@@ -3,6 +3,7 @@ from collections.abc import Callable, Sequence
 from threading import Thread
 from time import sleep
 
+from bluesky.callbacks import CallbackBase
 from bluesky.callbacks.zmq import Proxy, RemoteDispatcher
 from dodal.log import LOGGER as dodal_logger
 from dodal.log import set_up_all_logging_handlers
@@ -48,15 +49,33 @@ LIVENESS_POLL_SECONDS = 1
 ERROR_LOG_BUFFER_LINES = 5000
 
 
-def setup_callbacks():
-    zocalo = ZocaloCallback()
-    return [
+def create_gridscan_callbacks() -> tuple[
+    GridscanNexusFileCallback, GridscanISPyBCallback
+]:
+    return (
         GridscanNexusFileCallback(param_type=HyperionSpecifiedThreeDGridScan),
         GridscanISPyBCallback(
-            param_type=GridCommonWithHyperionDetectorParams, emit=zocalo
+            param_type=GridCommonWithHyperionDetectorParams,
+            emit=ZocaloCallback(CONST.PLAN.DO_FGS, CONST.ZOCALO_ENV),
         ),
+    )
+
+
+def create_rotation_callbacks() -> tuple[
+    RotationNexusFileCallback, RotationISPyBCallback
+]:
+    return (
         RotationNexusFileCallback(),
-        RotationISPyBCallback(emit=zocalo),
+        RotationISPyBCallback(
+            emit=ZocaloCallback(CONST.PLAN.ROTATION_MAIN, CONST.ZOCALO_ENV)
+        ),
+    )
+
+
+def setup_callbacks() -> list[CallbackBase]:
+    return [
+        *create_gridscan_callbacks(),
+        *create_rotation_callbacks(),
         LogUidTaggingCallback(),
         RobotLoadISPyBCallback(),
         SampleHandlingCallback(),

mx_bluesky/hyperion/external_interaction/config_server.py

@@ -1,6 +1,7 @@
 from functools import cache
 
 from daq_config_server.client import ConfigServer
+from pydantic import model_validator
 
 from mx_bluesky.common.external_interaction.config_server import FeatureFlags
 from mx_bluesky.common.utils.log import LOGGER
@@ -13,8 +14,10 @@ class HyperionFeatureFlags(FeatureFlags):
 
     Attributes:
         use_panda_for_gridscan:         If True then the PandA is used for gridscans, otherwise the zebra is used
-        compare_cpu_and_gpu_zocalo:     If True then GPU result processing is enabled alongside CPU, if False then
-            CPU only is used.
+        compare_cpu_and_gpu_zocalo:     If True then GPU result processing is enabled
+            alongside CPU and the results are compared. The CPU result is still take.n
+        use_gpu_results:                If True then GPU result processing is enabled
+            and the GPU result is taken.
         set_stub_offsets:               If True then set the stub offsets after moving to the crystal (ignored for
             multi-centre)
         omega_flip:                     If True then invert the smargon omega motor rotation commands with respect to
@@ -28,5 +31,13 @@ class HyperionFeatureFlags(FeatureFlags):
 
     use_panda_for_gridscan: bool = CONST.I03.USE_PANDA_FOR_GRIDSCAN
     compare_cpu_and_gpu_zocalo: bool = CONST.I03.COMPARE_CPU_AND_GPU_ZOCALO
+    use_gpu_results: bool = CONST.I03.USE_GPU_RESULTS
     set_stub_offsets: bool = CONST.I03.SET_STUB_OFFSETS
     omega_flip: bool = CONST.I03.OMEGA_FLIP
+
+    @model_validator(mode="after")
+    def use_gpu_and_compare_cannot_both_be_true(self):
+        assert not (self.use_gpu_results and self.compare_cpu_and_gpu_zocalo), (
+            "Cannot both use GPU results and compare them to CPU"
+        )
+        return self

mx_bluesky/hyperion/parameters/cli.py

@@ -8,7 +8,6 @@ from mx_bluesky._version import version
 @dataclass
 class HyperionArgs:
     dev_mode: bool = False
-    use_external_callbacks: bool = False
     verbose_event_logging: bool = False
     skip_startup_connection: bool = False
 
@@ -34,8 +33,7 @@ def parse_cli_args() -> HyperionArgs:
     """Parses all arguments relevant to hyperion. Returns an HyperionArgs dataclass with
     the fields: (verbose_event_logging: bool,
                  dev_mode: bool,
-                 skip_startup_connection: bool,
-                 external_callbacks: bool)"""
+                 skip_startup_connection: bool)"""
     parser = argparse.ArgumentParser()
     _add_callback_relevant_args(parser)
     parser.add_argument(
@@ -48,11 +46,6 @@ def parse_cli_args() -> HyperionArgs:
         action="store_true",
         help="Skip connecting to EPICS PVs on startup",
     )
-    parser.add_argument(
-        "--external-callbacks",
-        action="store_true",
-        help="Run the external hyperion-callbacks service and publish events over ZMQ",
-    )
     parser.add_argument(
         "--version",
         help="Print hyperion version string",
@@ -64,5 +57,4 @@ def parse_cli_args() -> HyperionArgs:
         verbose_event_logging=args.verbose_event_logging or False,
         dev_mode=args.dev or False,
         skip_startup_connection=args.skip_startup_connection or False,
-        use_external_callbacks=args.external_callbacks or False,
     )

mx_bluesky/hyperion/parameters/constants.py

@@ -4,6 +4,7 @@ from dodal.devices.detector import EIGER2_X_16M_SIZE
 from pydantic.dataclasses import dataclass
 
 from mx_bluesky.common.parameters.constants import (
+    DeviceSettingsConstants,
     DocDescriptorNames,
     EnvironmentConstants,
     ExperimentParamConstants,
@@ -31,9 +32,12 @@ class I03Constants:
     OMEGA_FLIP = True
 
     # Turns on GPU processing for zocalo and logs a comparison between GPU and CPU-
-    # processed results. GPU results never used in analysis for now
+    # processed results.
     COMPARE_CPU_AND_GPU_ZOCALO = False
 
+    # Turns on GPU processing for zocalo and uses the results that come back
+    USE_GPU_RESULTS = False
+
 
 @dataclass(frozen=True)
 class HyperionConstants:
@@ -57,6 +61,7 @@ class HyperionConstants:
     GRAYLOG_PORT = 12232
     PARAMETER_SCHEMA_DIRECTORY = "src/hyperion/parameters/schemas/"
     LOG_FILE_NAME = "hyperion.log"
+    DEVICE_SETTINGS_CONSTANTS = DeviceSettingsConstants()
 
 
 CONST = HyperionConstants()

mx_bluesky/hyperion/parameters/gridscan.py

@@ -7,9 +7,7 @@ from dodal.devices.fast_grid_scan import (
     PandAGridScanParams,
     ZebraGridScanParams,
 )
-from pydantic import Field
 
-from mx_bluesky.common.parameters.constants import GridscanParamConstants
 from mx_bluesky.common.parameters.gridscan import (
     GridCommon,
     SpecifiedThreeDGridScan,
@@ -49,7 +47,8 @@ class GridCommonWithHyperionDetectorParams(GridCommon, WithHyperionUDCFeatures):
             use_roi_mode=self.use_roi_mode,
             det_dist_to_beam_converter_path=self.det_dist_to_beam_converter_path,
             trigger_mode=self.trigger_mode,
-            enable_dev_shm=self.features.compare_cpu_and_gpu_zocalo,
+            enable_dev_shm=self.features.compare_cpu_and_gpu_zocalo
+            or self.features.use_gpu_results,
             **optional_args,
         )
 
@@ -85,7 +84,8 @@ class HyperionSpecifiedThreeDGridScan(SpecifiedThreeDGridScan, WithHyperionUDCFe
             use_roi_mode=self.use_roi_mode,
             det_dist_to_beam_converter_path=self.det_dist_to_beam_converter_path,
             trigger_mode=self.trigger_mode,
-            enable_dev_shm=self.features.compare_cpu_and_gpu_zocalo,
+            enable_dev_shm=self.features.compare_cpu_and_gpu_zocalo
+            or self.features.use_gpu_results,
             **optional_args,
         )
 
@@ -146,4 +146,4 @@ class PinTipCentreThenXrayCentre(
 class GridScanWithEdgeDetect(
     GridCommonWithHyperionDetectorParams, WithHyperionUDCFeatures
 ):
-    box_size_um: float = Field(default=GridscanParamConstants.BOX_WIDTH_UM)
+    pass