mxcubecore 1.364.0__tar.gz → 1.365.0__tar.gz

{mxcubecore-1.364.0 → mxcubecore-1.365.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mxcubecore
-Version: 1.364.0
+Version: 1.365.0
 Summary: Core libraries for the MXCuBE application
 License: LGPL-3.0-or-later
 Keywords: mxcube,mxcube3,mxcubecore

{mxcubecore-1.364.0 → mxcubecore-1.365.0}/mxcubecore/HardwareObjects/BlissEnergy.py

@@ -44,6 +44,7 @@ import math
 
 from gevent import spawn
 
+from mxcubecore import HardwareRepository as HWR
 from mxcubecore.BaseHardwareObjects import HardwareObjectState
 from mxcubecore.HardwareObjects.abstract.AbstractEnergy import AbstractEnergy
 
@@ -108,9 +109,14 @@ class BlissEnergy(AbstractEnergy):
         Args:
             value (float): target energy
         """
+        try:
+            defocus = HWR.beamline.beam.definer.defocused_beam
+        except AttributeError:
+            defocus = False
+
         self.update_state(HardwareObjectState.BUSY)
         try:
-            self.controller.change_energy(value)
+            self.controller.change_energy(value, defocus=defocus)
         except (AttributeError, RuntimeError):
             self.energy_motor.set_value(value)
         self.update_state(HardwareObjectState.READY)

{mxcubecore-1.364.0 → mxcubecore-1.365.0}/mxcubecore/HardwareObjects/ESRF/ESRFBeamDefiner.py

@@ -53,14 +53,14 @@ class ESRFBeamDefiner(AbstractNState):
     def __init__(self, *args):
         super().__init__(*args)
         self.beam_config = {}
-        self.config = []
+        self.bd_config = []
 
     def init(self):
         super().init()
         self._default_name = self.get_property("default_size_name")
 
         # keep the config is needed by the inheriring classes
-        self.config = self.init_config()
+        self.bd_config = self.init_config()
 
         # check if we have values other that UNKNOWN
         if len(self.VALUES) == 1:

mxcubecore-1.365.0/mxcubecore/HardwareObjects/ESRF/ID30BBeamDefiner.py

@@ -0,0 +1,156 @@
+# encoding: utf-8
+#
+#  Project name: MXCuBE
+#  https://github.com/mxcube
+#
+#  This file is part of MXCuBE software.
+#
+#  MXCuBE is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  MXCuBE is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU General Lesser Public License
+#  along with MXCuBE. If not, see <http://www.gnu.org/licenses/>.
+"""
+ID30-B Beam Definer.
+
+Example xml configuration:
+
+.. code-block:: xml
+
+ <object class="ESRF.ID30BBeamDefiner">
+   <object href="/udiff_aperture" role="controller"/>
+   <object href="/bliss" role="bliss"/>
+   <transfocator>tf</transfocator>
+   <beam_config>
+      <name>A10</name>
+      <beam_size>0.01, 0.05</beam_size>
+      <aperture_size>10</aperture_size>
+      <defocused_beam>False</defocused_beam>
+   </beam_config>
+   <beam_config>
+      <name>A20 um</name>
+      <beam_size>0.02, 0.02</beam_size>
+      <aperture_size>20</aperture_size>
+      <defocused_beam>False</defocused_beam>
+   </beam_config>
+   <beam_config>
+      <name>A30</name>
+      <beam_size>0.03, 0.03</beam_size>
+      <aperture_size>30</aperture_size>
+      <defocused_beam>False</defocused_beam>
+   </beam_config>
+   <beam_config>
+      <name>A50</name>
+      <beam_size>0.05, 0.05</beam_size>
+      <aperture_size>50</aperture_size>
+      <defocused_beam>True</defocused_beam>
+   </beam_config>
+   <beam_config>
+      <name>A75</name>
+      <beam_size>0.075, 0.075</beam_size>
+      <aperture_size>75</aperture_size>
+      <defocused_beam>True</defocused_beam>
+   </beam_config>
+ </object>
+"""
+
+__copyright__ = """ Copyright © by the MXCuBE collaboration """
+__license__ = "LGPLv3+"
+
+
+from enum import Enum
+
+from mxcubecore.HardwareObjects.ESRF.ESRFBeamDefiner import ESRFBeamDefiner
+
+
+class ID30BBeamDefiner(ESRFBeamDefiner):
+    """ID30B beam definer implementation"""
+
+    def __init__(self, *args):
+        super().__init__(*args)
+        self.controller = None
+        self.defocused_beam = None
+        self.tf_obj = None
+
+    def init(self):
+        """Initialisation"""
+        super().init()
+
+        self.controller = self.get_object_by_role("controller")
+        bliss = self.get_object_by_role("bliss")
+        self.tf_obj = getattr(bliss, self.get_property("transfocator"))
+        _dict = {}
+
+        for beam_cfg in self.bd_config:
+            name = beam_cfg.get_property("name")
+            _ap_size = beam_cfg.get_property("aperture_size")
+            _aperture = self.controller.value_to_enum(_ap_size, idx=1)
+            _defocused_beam = bool(beam_cfg.get_property("defocused_beam"))
+            _dict[name] = {"aperture": _aperture, "defocus": _defocused_beam}
+
+        self.beam_config = _dict
+        self._initialise_values()
+        self.connect(self.controller, "valueChanged", self._update_name)
+
+        self.defocused_beam = _dict[self.get_current_position_name()]["defocus"]
+
+    def get_state(self):
+        """Get the device state.
+        Returns:
+            (enum 'HardwareObjectState'): Device state.
+        """
+        return self.controller.get_state()
+
+    def _update_name(self, value=None):
+        """
+        Emits:
+            valueChanged (str): Current beam size name.
+        """
+        name = self.get_current_position_name()
+        self.emit("valueChanged", name)
+
+    def get_current_position_name(self):
+        """Get the current beam size name.
+        Returns:
+            (str): Current beam size name.
+        """
+        _aperture = self.controller.get_value()
+        for name, value in self.beam_config.items():
+            if value["aperture"] == _aperture:
+                return name
+        return "UNKNOWN"
+
+    def get_value(self):
+        """Get the device value
+        Returns:
+            (Enum): The current position Enum.
+        """
+        try:
+            value = self.VALUES[self.get_current_position_name()]
+            if isinstance(value.value, tuple):
+                return value
+            return Enum("Dummy", {value.name: value.value[0]})[value.name]
+        except (ValueError, KeyError):
+            return self.VALUES.UNKNOWN
+
+    def set_value(self, value, timeout=None):
+        """Set the beam size.
+        Args:
+            value(str): name of the beam size to set.
+            timeout(float): Timeout to wait for the execution to finish [s].
+        Raises:
+            RuntimeError: Cannot change beam size.
+        """
+        if isinstance(value, Enum):
+            value = value.name
+
+        self.controller.set_value(self.beam_config[value]["aperture"], timeout=timeout)
+        self.defocused_beam = self.beam_config[value]["defocus"]
+        self.tf_obj.change_tf(defocus=self.defocused_beam)

{mxcubecore-1.364.0 → mxcubecore-1.365.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mxcubecore"
-version = "1.364.0"
+version = "1.365.0"
 license = "LGPL-3.0-or-later"
 description = "Core libraries for the MXCuBE application"
 authors = [