dls-dodal 1.60.0__tar.gz → 1.61.0__tar.gz

{dls_dodal-1.60.0 → dls_dodal-1.61.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dls-dodal
-Version: 1.60.0
+Version: 1.61.0
 Summary: Ophyd devices and other utils that could be used across DLS beamlines
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>, Joseph Ware <joseph.ware@diamond.ac.uk>, Oliver Silvester <Oliver.Silvester@diamond.ac.uk>, Noemi Frisina <noemi.frisina@diamond.ac.uk>
 License:                                  Apache License

{dls_dodal-1.60.0 → dls_dodal-1.61.0}/pyproject.toml

@@ -188,6 +188,7 @@ lint.select = [
     "SLF",    # self - https://docs.astral.sh/ruff/settings/#lintflake8-self
     "RUF018", # walrus operators in asserts - https://docs.astral.sh/ruff/rules/assignment-in-assert/
     "TID251", # banned api - https://docs.astral.sh/ruff/rules/banned-api/
+    "INP001", # missing __init__.py - https://docs.astral.sh/ruff/rules/implicit-namespace-package/
 ]
 
 [tool.ruff.lint.per-file-ignores]
@@ -196,6 +197,8 @@ lint.select = [
 # Remove this line to forbid private member access, walrus operators, banned api in asserts in tests 
 "tests/**/*" = ["SLF001", "RUF018", "TID251"]
 "system_tests/**/*" = ["SLF001", "RUF018", "TID251"]
+".github/**/*" = ["INP001"]
+"docs/**/*" = ["INP001"]
 
 [tool.ruff.lint.flake8-tidy-imports.banned-api]
 "time.sleep".msg = "Use bps.sleep or asyncio.sleep instead. # noqa will disable this rule for that line. See https://github.com/DiamondLightSource/mx-bluesky/issues/925"

{dls_dodal-1.60.0 → dls_dodal-1.61.0}/src/dls_dodal.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dls-dodal
-Version: 1.60.0
+Version: 1.61.0
 Summary: Ophyd devices and other utils that could be used across DLS beamlines
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>, Joseph Ware <joseph.ware@diamond.ac.uk>, Oliver Silvester <Oliver.Silvester@diamond.ac.uk>, Noemi Frisina <noemi.frisina@diamond.ac.uk>
 License:                                  Apache License

{dls_dodal-1.60.0 → dls_dodal-1.61.0}/src/dls_dodal.egg-info/SOURCES.txt

@@ -196,8 +196,11 @@ src/dodal/devices/xbpm_feedback.py
 src/dodal/devices/aithre_lasershaping/__init__.py
 src/dodal/devices/aithre_lasershaping/goniometer.py
 src/dodal/devices/aithre_lasershaping/laser_robot.py
+src/dodal/devices/areadetector/__init__.py
 src/dodal/devices/areadetector/plugins/CAM.py
 src/dodal/devices/areadetector/plugins/MJPG.py
+src/dodal/devices/areadetector/plugins/__init__.py
+src/dodal/devices/attenuator/__init__.py
 src/dodal/devices/attenuator/attenuator.py
 src/dodal/devices/attenuator/filter.py
 src/dodal/devices/attenuator/filter_selections.py
@@ -264,9 +267,11 @@ src/dodal/devices/i10/i10_apple2.py
 src/dodal/devices/i10/i10_setting_data.py
 src/dodal/devices/i10/mirrors.py
 src/dodal/devices/i10/slits.py
+src/dodal/devices/i10/rasor/__init__.py
 src/dodal/devices/i10/rasor/rasor_current_amp.py
 src/dodal/devices/i10/rasor/rasor_motors.py
 src/dodal/devices/i10/rasor/rasor_scaler_cards.py
+src/dodal/devices/i11/__init__.py
 src/dodal/devices/i11/cyberstar_blower.py
 src/dodal/devices/i11/diff_stages.py
 src/dodal/devices/i11/mythen.py
@@ -275,6 +280,7 @@ src/dodal/devices/i11/spinner.py
 src/dodal/devices/i13_1/__init__.py
 src/dodal/devices/i13_1/merlin.py
 src/dodal/devices/i13_1/merlin_controller.py
+src/dodal/devices/i15/__init__.py
 src/dodal/devices/i15/dcm.py
 src/dodal/devices/i15/focussing_mirror.py
 src/dodal/devices/i15/jack.py
@@ -283,6 +289,7 @@ src/dodal/devices/i15/motors.py
 src/dodal/devices/i15/multilayer_mirror.py
 src/dodal/devices/i15/rail.py
 src/dodal/devices/i18/KBMirror.py
+src/dodal/devices/i18/__init__.py
 src/dodal/devices/i18/diode.py
 src/dodal/devices/i19/__init__.py
 src/dodal/devices/i19/backlight.py
@@ -294,6 +301,7 @@ src/dodal/devices/i19/shutter.py
 src/dodal/devices/i20_1/__init__.py
 src/dodal/devices/i21/__init__.py
 src/dodal/devices/i21/enums.py
+src/dodal/devices/i22/__init__.py
 src/dodal/devices/i22/dcm.py
 src/dodal/devices/i22/fswitch.py
 src/dodal/devices/i22/nxsas.py
@@ -307,6 +315,7 @@ src/dodal/devices/i24/dual_backlight.py
 src/dodal/devices/i24/focus_mirrors.py
 src/dodal/devices/i24/pmac.py
 src/dodal/devices/i24/vgonio.py
+src/dodal/devices/mx_phase1/__init__.py
 src/dodal/devices/mx_phase1/beamstop.py
 src/dodal/devices/oav/__init__.py
 src/dodal/devices/oav/oav_calculations.py
@@ -317,6 +326,7 @@ src/dodal/devices/oav/utils.py
 src/dodal/devices/oav/pin_image_recognition/__init__.py
 src/dodal/devices/oav/pin_image_recognition/manual_test.py
 src/dodal/devices/oav/pin_image_recognition/utils.py
+src/dodal/devices/oav/snapshots/__init__.py
 src/dodal/devices/oav/snapshots/grid_overlay.py
 src/dodal/devices/oav/snapshots/snapshot.py
 src/dodal/devices/oav/snapshots/snapshot_image_processing.py
@@ -335,6 +345,7 @@ src/dodal/devices/util/__init__.py
 src/dodal/devices/util/adjuster_plans.py
 src/dodal/devices/util/epics_util.py
 src/dodal/devices/util/lookup_tables.py
+src/dodal/devices/xspress3/__init__.py
 src/dodal/devices/xspress3/xspress3.py
 src/dodal/devices/xspress3/xspress3_channel.py
 src/dodal/devices/zebra/__init__.py
@@ -345,6 +356,7 @@ src/dodal/devices/zocalo/__init__.py
 src/dodal/devices/zocalo/zocalo_constants.py
 src/dodal/devices/zocalo/zocalo_interaction.py
 src/dodal/devices/zocalo/zocalo_results.py
+src/dodal/parameters/__init__.py
 src/dodal/parameters/experiment_parameter_base.py
 src/dodal/plan_stubs/__init__.py
 src/dodal/plan_stubs/check_topup.py
@@ -441,10 +453,14 @@ tests/devices/test_zebra_constants_mapping.py
 tests/devices/test_zebra_shutter.py
 tests/devices/test_zocalo_interaction.py
 tests/devices/test_zocalo_results.py
+tests/devices/aithre_lasershaping/__init__.py
 tests/devices/aithre_lasershaping/test_goniometer.py
+tests/devices/b07_1/__init__.py
 tests/devices/b07_1/test_ccmc.py
+tests/devices/current_amplifier/__init__.py
 tests/devices/current_amplifier/test_femto.py
 tests/devices/current_amplifier/test_sr570.py
+tests/devices/detector/__init__.py
 tests/devices/detector/test_det_dim_constants.py
 tests/devices/detector/test_det_resolution.py
 tests/devices/detector/test_detector.py
@@ -483,6 +499,7 @@ tests/devices/i04/test_murko_results.py
 tests/devices/i04/test_transfocator.py
 tests/devices/i09/__init__.py
 tests/devices/i09/test_dcm.py
+tests/devices/i10/__init__.py
 tests/devices/i10/test_i10Apple2.py
 tests/devices/i10/test_data/IDEnergy2GapCalibrations.csv
 tests/devices/i10/test_data/IDEnergy2PhaseCalibrations.csv
@@ -491,16 +508,21 @@ tests/devices/i10/test_data/expectedIDEnergy2GapCalibrationsIdd.pkl
 tests/devices/i10/test_data/expectedIDEnergy2GapCalibrationsIdu.pkl
 tests/devices/i10/test_data/expectedIDEnergy2PhaseCalibrationsidd.pkl
 tests/devices/i10/test_data/expectedIDEnergy2PhaseCalibrationsidu.pkl
+tests/devices/i11/__init__.py
 tests/devices/i11/test_i11devices.py
 tests/devices/i11/test_mythen.py
+tests/devices/i13_1/__init__.py
 tests/devices/i13_1/test_merlin.py
+tests/devices/i15/__init__.py
 tests/devices/i15/test_dcm.py
+tests/devices/i18/__init__.py
 tests/devices/i18/test_kb_mirror.py
 tests/devices/i19/__init__.py
 tests/devices/i19/test_backlight.py
 tests/devices/i19/test_beamstop.py
 tests/devices/i19/test_diffractometer.py
 tests/devices/i19/test_shutter.py
+tests/devices/i22/__init__.py
 tests/devices/i22/test_dcm.py
 tests/devices/i22/test_fswitch.py
 tests/devices/i22/test_metadataholder.py
@@ -521,13 +543,16 @@ tests/devices/oav/test_oav_to_redis_forwarder.py
 tests/devices/oav/test_oav_utils.py
 tests/devices/oav/test_snapshot_image_processing.py
 tests/devices/oav/test_snapshots.py
+tests/devices/oav/image_recognition/__init__.py
 tests/devices/oav/image_recognition/test_pin_tip_detect.py
 tests/devices/oav/image_recognition/test_pin_tip_detect_utils.py
 tests/devices/oav/test_data/__init__.py
 tests/devices/oav/test_data/oav_snapshot_expected.png
 tests/devices/oav/test_data/oav_snapshot_test.png
 tests/devices/oav/test_data/test_OAVCentring.json
+tests/devices/p60/__init__.py
 tests/devices/p60/test_lab_xray_source.py
+tests/devices/p99/__init__.py
 tests/devices/p99/test_p99_stage.py
 tests/devices/temperature_controller/__init__.py
 tests/devices/temperature_controller/lakeshore/__init__.py
@@ -563,6 +588,7 @@ tests/plan_stubs/test_wrapped_stubs.py
 tests/plan_stubs/test_data/__init__.py
 tests/plan_stubs/test_data/topup_long_delay.txt
 tests/plan_stubs/test_data/topup_short_params.txt
+tests/plans/__init__.py
 tests/plans/conftest.py
 tests/plans/test_bimorph.py
 tests/plans/test_compliance.py
@@ -570,7 +596,9 @@ tests/plans/test_configure_arm_trigger_and_disarm_detector.py
 tests/plans/test_scanspec.py
 tests/plans/test_verify_undulator_gap_plan.py
 tests/plans/test_wrapped.py
+tests/plans/test_preprocessors/__init__.py
 tests/plans/test_preprocessors/test_verify_undulator_gap.py
+tests/preprocessors/__init__.py
 tests/preprocessors/test_filesystem_metadata.py
 tests/test_data/__init__.py
 tests/test_data/bad_beamlineParameters

{dls_dodal-1.60.0 → dls_dodal-1.61.0}/src/dodal/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.60.0'
-__version_tuple__ = version_tuple = (1, 60, 0)
+__version__ = version = '1.61.0'
+__version_tuple__ = version_tuple = (1, 61, 0)
 
-__commit_id__ = commit_id = 'gb3036ebaf'
+__commit_id__ = commit_id = 'gdf177058e'

{dls_dodal-1.60.0 → dls_dodal-1.61.0}/src/dodal/devices/apple2_undulator.py

@@ -301,9 +301,68 @@ class UndulatorJawPhase(SafeUndulatorMover[float]):
         )
 
 
+class Apple2Motors(StandardReadable, Movable):
+    """
+    Device representing the combined motor controls for an Apple2 undulator.
+
+    Attributes
+    ----------
+    gap : UndulatorGap
+        The undulator gap motor device.
+    phase : UndulatorPhaseAxes
+        The undulator phase axes device, consisting of four phase motors.
+    """
+
+    def __init__(self, id_gap: UndulatorGap, id_phase: UndulatorPhaseAxes, name=""):
+        """
+        Parameters
+        ----------
+
+        id_gap: UndulatorGap
+            An UndulatorGap device.
+        id_phase: UndulatorPhaseAxes
+            An UndulatorPhaseAxes device.
+        name: str
+            Name of the device.
+        """
+        with self.add_children_as_readables():
+            self.gap = id_gap
+            self.phase = id_phase
+        super().__init__(name=name)
+
+    @AsyncStatus.wrap
+    async def set(self, id_motor_values: Apple2Val) -> None:
+        """
+        Check ID is in a movable state and set all the demand value before moving them
+        all at the same time. This should be modified by the beamline specific ID
+        class, if the ID motors has to move in a specific order.
+        """
+
+        # Only need to check gap as the phase motors share both fault and gate with gap.
+        await self.gap.raise_if_cannot_move()
+        await asyncio.gather(
+            self.phase.top_outer.user_setpoint.set(value=id_motor_values.top_outer),
+            self.phase.top_inner.user_setpoint.set(value=id_motor_values.top_inner),
+            self.phase.btm_inner.user_setpoint.set(value=id_motor_values.btm_inner),
+            self.phase.btm_outer.user_setpoint.set(value=id_motor_values.btm_outer),
+            self.gap.user_setpoint.set(value=id_motor_values.gap),
+        )
+        timeout = np.max(
+            await asyncio.gather(self.gap.get_timeout(), self.phase.get_timeout())
+        )
+        LOGGER.info(
+            f"Moving f{self.name} apple2 motors to {id_motor_values}, timeout = {timeout}"
+        )
+        await asyncio.gather(
+            self.gap.set_move.set(value=1, wait=False, timeout=timeout),
+            self.phase.set_move.set(value=1, wait=False, timeout=timeout),
+        )
+        await wait_for_value(self.gap.gate, UndulatorGateStatus.CLOSE, timeout=timeout)
+
+
 class EnergyMotorConvertor(Protocol):
     def __call__(self, energy: float, pol: Pol) -> tuple[float, float]:
-        """Protocol to provide energy to motor position convertion"""
+        """Protocol to provide energy to motor position conversion"""
         ...
 
 
@@ -318,15 +377,13 @@ class Apple2(abc.ABC, StandardReadable, Movable):
     The class is designed to manage the undulator's gap, phase motors, and polarisation settings, while
     abstracting hardware interactions and providing a high-level interface for beamline operations.
 
-    The class is abstract and requires beamline-specific implementations for set motor
+    The class is abstract and requires beamline-specific implementations for _set motor
      positions based on energy and polarisation.
 
     Attributes
     ----------
-    gap : UndulatorGap
-        The gap control device for the undulator.
-    phase : UndulatorPhaseAxes
-        The phase control device, consisting of four phase motors.
+    apple2_motors : Apple2Motors
+        A collection of gap and phase motor devices.
     energy : SignalR
         A soft signal for the current energy readback.
     polarisation_setpoint : SignalR
@@ -340,7 +397,7 @@ class Apple2(abc.ABC, StandardReadable, Movable):
 
     Abstract Methods
     ----------------
-    set(value: float) -> None
+    _set(value: float) -> None
         Abstract method to set motor positions for a given energy and polarisation.
 
     Methods
@@ -363,8 +420,7 @@ class Apple2(abc.ABC, StandardReadable, Movable):
 
     def __init__(
         self,
-        id_gap: UndulatorGap,
-        id_phase: UndulatorPhaseAxes,
+        apple2_motors: Apple2Motors,
         energy_motor_convertor: EnergyMotorConvertor,
         name: str = "",
     ) -> None:
@@ -378,8 +434,7 @@ class Apple2(abc.ABC, StandardReadable, Movable):
         name: Name of the device.
         """
 
-        self.gap = id_gap
-        self.phase = id_phase
+        self.motors = apple2_motors
         self.energy_to_motor = energy_motor_convertor
         with self.add_children_as_readables(StandardReadableFormat.HINTED_SIGNAL):
             # Store the set energy for readback.
@@ -398,11 +453,11 @@ class Apple2(abc.ABC, StandardReadable, Movable):
             raw_to_derived=self._read_pol,
             set_derived=self._set_pol,
             pol=self.polarisation_setpoint,
-            top_outer=self.phase.top_outer.user_readback,
-            top_inner=self.phase.top_inner.user_readback,
-            btm_inner=self.phase.btm_inner.user_readback,
-            btm_outer=self.phase.btm_outer.user_readback,
-            gap=id_gap.user_readback,
+            top_outer=self.motors.phase.top_outer.user_readback,
+            top_inner=self.motors.phase.top_inner.user_readback,
+            btm_inner=self.motors.phase.btm_inner.user_readback,
+            btm_outer=self.motors.phase.btm_outer.user_readback,
+            gap=self.motors.gap.user_readback,
         )
         super().__init__(name)
 
@@ -420,24 +475,32 @@ class Apple2(abc.ABC, StandardReadable, Movable):
         self._set_pol_setpoint(value)
         await self.set(await self.energy.get_value())
 
-    @abc.abstractmethod
     @AsyncStatus.wrap
     async def set(self, value: float) -> None:
         """
         Set should be in energy units, this will set the energy of the ID by setting the
         gap and phase motors to the correct position for the given energy
         and polarisation.
-        This method should be implemented by the beamline specific ID class as the
-        motor positions will be different for each beamline depending on the
-        undulator design and the lookup table used.
-        _set can be used to set the motor positions for the given energy and
-        polarisation provided that all motors can be moved at the same time.
+
 
         Examples
         --------
         RE( id.set(888.0)) # This will set the ID to 888 eV
         RE(scan([detector], id,600,700,100)) # This will scan the ID from 600 to 700 eV in 100 steps.
         """
+        await self._set(value)
+        self._set_energy_rbv(value)  # Update energy after move for readback.
+        LOGGER.info(f"Energy set to {value} eV successfully.")
+
+    @abc.abstractmethod
+    async def _set(self, value: float) -> None:
+        """
+        This method should be implemented by the beamline specific ID class as the
+        motor positions will be different for each beamline depending on the
+        undulator design and the lookup table used. The set method can be
+        used to set the motor positions for the given energy and polarisation
+        provided that all motors can be moved at the same time.
+        """
 
     def _read_pol(
         self,
@@ -468,36 +531,6 @@ class Apple2(abc.ABC, StandardReadable, Movable):
 
         return read_pol
 
-    async def _set(self, value: Apple2Val, energy: float) -> None:
-        """
-        Check ID is in a movable state and set all the demand value before moving them
-        all at the same time. This should be modified by the beamline specific ID class
-        , if the ID motors has to move in a specific order.
-        """
-
-        # Only need to check gap as the phase motors share both fault and gate with gap.
-        await self.gap.raise_if_cannot_move()
-        await asyncio.gather(
-            self.phase.top_outer.user_setpoint.set(value=value.top_outer),
-            self.phase.top_inner.user_setpoint.set(value=value.top_inner),
-            self.phase.btm_inner.user_setpoint.set(value=value.btm_inner),
-            self.phase.btm_outer.user_setpoint.set(value=value.btm_outer),
-            self.gap.user_setpoint.set(value=value.gap),
-        )
-        timeout = np.max(
-            await asyncio.gather(self.gap.get_timeout(), self.phase.get_timeout())
-        )
-        LOGGER.info(
-            f"Moving f{self.name} energy and polorisation to {energy}, {await self.polarisation.get_value()}"
-            + f"with motor position {value}, timeout = {timeout}"
-        )
-        await asyncio.gather(
-            self.gap.set_move.set(value=1, wait=False, timeout=timeout),
-            self.phase.set_move.set(value=1, wait=False, timeout=timeout),
-        )
-        await wait_for_value(self.gap.gate, UndulatorGateStatus.CLOSE, timeout=timeout)
-        self._set_energy_rbv(energy)  # Update energy after move for readback.
-
     def determine_phase_from_hardware(
         self,
         top_outer: float,

{dls_dodal-1.60.0 → dls_dodal-1.61.0}/src/dodal/devices/electron_analyser/abstract/__init__.py

@@ -1,5 +1,5 @@
 from .base_detector import (
-    AbstractElectronAnalyserDetector,
+    BaseElectronAnalyserDetector,
 )
 from .base_driver_io import AbstractAnalyserDriverIO, TAbstractAnalyserDriverIO
 from .base_region import (
@@ -19,7 +19,7 @@ __all__ = [
     "TAcquisitionMode",
     "TLensMode",
     "AbstractAnalyserDriverIO",
-    "AbstractElectronAnalyserDetector",
+    "BaseElectronAnalyserDetector",
     "AbstractAnalyserDriverIO",
     "TAbstractAnalyserDriverIO",
 ]

{dls_dodal-1.60.0 → dls_dodal-1.61.0}/src/dodal/devices/electron_analyser/abstract/base_detector.py

@@ -1,4 +1,3 @@
-from abc import abstractmethod
 from typing import Generic
 
 from bluesky.protocols import Reading, Triggerable
@@ -9,14 +8,14 @@ from ophyd_async.core import (
     AsyncStatus,
     Device,
 )
+from ophyd_async.epics.adcore import ADBaseController
 
-from dodal.devices.controllers import ConstantDeadTimeController
 from dodal.devices.electron_analyser.abstract.base_driver_io import (
     TAbstractAnalyserDriverIO,
 )
 
 
-class AbstractElectronAnalyserDetector(
+class BaseElectronAnalyserDetector(
     Device,
     Triggerable,
     AsyncReadable,
@@ -34,43 +33,31 @@ class AbstractElectronAnalyserDetector(
 
     def __init__(
         self,
-        driver: TAbstractAnalyserDriverIO,
+        controller: ADBaseController[TAbstractAnalyserDriverIO],
         name: str = "",
     ):
-        self.controller = ConstantDeadTimeController(driver, 0)
+        self._controller = controller
         super().__init__(name)
 
     @AsyncStatus.wrap
     async def trigger(self) -> None:
-        await self.controller.arm()
-        await self.controller.wait_for_idle()
+        await self._controller.arm()
+        await self._controller.wait_for_idle()
 
     async def read(self) -> dict[str, Reading]:
-        return await self.driver.read()
+        return await self._controller.driver.read()
 
     async def describe(self) -> dict[str, DataKey]:
-        data = await self.driver.describe()
+        data = await self._controller.driver.describe()
         # Correct the shape for image
-        prefix = self.driver.name + "-"
-        energy_size = len(await self.driver.energy_axis.get_value())
-        angle_size = len(await self.driver.angle_axis.get_value())
+        prefix = self._controller.driver.name + "-"
+        energy_size = len(await self._controller.driver.energy_axis.get_value())
+        angle_size = len(await self._controller.driver.angle_axis.get_value())
         data[prefix + "image"]["shape"] = [angle_size, energy_size]
         return data
 
     async def read_configuration(self) -> dict[str, Reading]:
-        return await self.driver.read_configuration()
+        return await self._controller.driver.read_configuration()
 
     async def describe_configuration(self) -> dict[str, DataKey]:
-        return await self.driver.describe_configuration()
-
-    @property
-    @abstractmethod
-    def driver(self) -> TAbstractAnalyserDriverIO:
-        """
-        Define common property for all implementations to access the driver. Some
-        implementations will store this as a reference so it doesn't have conflicting
-        parents.
-
-        Returns:
-            instance of the driver.
-        """
+        return await self._controller.driver.describe_configuration()

{dls_dodal-1.60.0 → dls_dodal-1.61.0}/src/dodal/devices/electron_analyser/abstract/base_driver_io.py

@@ -153,11 +153,12 @@ class AbstractAnalyserDriverIO(
             self.energy_source.selected_source.set(region.excitation_energy_source)
         excitation_energy = await self.energy_source.energy.get_value()
 
-        # Copy region so doesn't alter the actual region and switch to kinetic energy
-        ke_region = region.model_copy()
-        ke_region.switch_energy_mode(EnergyMode.KINETIC, excitation_energy)
-
+        # Switch to kinetic energy as epics doesn't support BINDING.
+        ke_region = region.switch_energy_mode(EnergyMode.KINETIC, excitation_energy)
         await self._set_region(ke_region)
+        # Set the true energy mode from original region so binding_energy_axis can be
+        # calculated correctly.
+        await self.energy_mode.set(region.energy_mode)
 
     @abstractmethod
     async def _set_region(self, ke_region: TAbstractBaseRegion):

{dls_dodal-1.60.0 → dls_dodal-1.61.0}/src/dodal/devices/electron_analyser/abstract/base_region.py

@@ -1,7 +1,7 @@
 import re
 from abc import ABC
 from collections.abc import Callable
-from typing import Generic, TypeVar
+from typing import Generic, Self, TypeVar
 
 from pydantic import BaseModel, Field, model_validator
 
@@ -88,28 +88,43 @@ class AbstractBaseRegion(
         return self.energy_mode == EnergyMode.KINETIC
 
     def switch_energy_mode(
-        self, energy_mode: EnergyMode, excitation_energy: float
-    ) -> None:
+        self, energy_mode: EnergyMode, excitation_energy: float, copy: bool = True
+    ) -> Self:
         """
-        Switch region to new energy mode: Kinetic or Binding. Updates the low_energy,
-        centre_energy, high_energy, and energy_mode, only if it switches to a new one.
+        Switch region with to a new energy mode with a new energy mode: Kinetic or Binding.
+        It caculates new values for low_energy, centre_energy, high_energy, via the
+        excitation enerrgy. It doesn't calculate anything if the region is already of
+        the same energy mode.
 
         Parameters:
-            energy_mode: mode you want to switch the region to.
-            excitation_energy: the energy to calculate the new values of low_energy,
-                               centre_energy, and high_energy.
+            energy_mode: Mode you want to switch the region to.
+            excitation_energy: Energy conversion for low_energy, centre_energy, and
+                               high_energy for new energy mode.
+            copy: Defaults to True. If true, create a copy of this region for the new
+                  energy_mode and return it. If False, alter this region for the
+                  energy_mode and return it self.
+
+        Returns:
+            Region with selected energy mode and new calculated energy values.
         """
+        switched_r = self.model_copy() if copy else self
         conv = (
             to_binding_energy
             if energy_mode == EnergyMode.BINDING
             else to_kinetic_energy
         )
-        self.low_energy = conv(self.low_energy, self.energy_mode, excitation_energy)
-        self.centre_energy = conv(
-            self.centre_energy, self.energy_mode, excitation_energy
+        switched_r.low_energy = conv(
+            switched_r.low_energy, switched_r.energy_mode, excitation_energy
         )
-        self.high_energy = conv(self.high_energy, self.energy_mode, excitation_energy)
-        self.energy_mode = energy_mode
+        switched_r.centre_energy = conv(
+            switched_r.centre_energy, switched_r.energy_mode, excitation_energy
+        )
+        switched_r.high_energy = conv(
+            switched_r.high_energy, switched_r.energy_mode, excitation_energy
+        )
+        switched_r.energy_mode = energy_mode
+
+        return switched_r
 
     @model_validator(mode="before")
     @classmethod