lima2.client 2.1.1__tar.gz → 2.1.3__tar.gz

{lima2_client-2.1.1/src/lima2.client.egg-info → lima2_client-2.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: lima2.client
-Version: 2.1.1
+Version: 2.1.3
 Summary: Python client library for Lima2 detector
 Home-page: https://gitlab.esrf.fr/limagroup/lima2-client
 Author: BCU (ESRF)

lima2_client-2.1.3/src/lima2/client/devencoded/smx_sparse_frame.py

@@ -0,0 +1,128 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of the Lima2 project
+#
+# Copyright (c) 2020-2024 Beamline Control Unit, ESRF
+# Distributed under the MIT license. See LICENSE for more info.
+
+"""Utility functions to decode Lima data from device server.
+"""
+
+import struct
+import numpy as np
+import typing
+from dataclasses import dataclass
+
+from .exception import DevEncodedFormatNotSupported
+
+DATA_HEADER_FORMAT = "<HHIII"
+DATA_HEADER_SIZE = struct.calcsize(DATA_HEADER_FORMAT)
+
+
+@dataclass
+class SmxSparseFrame:
+    """
+    Provide sparse data frame from Lima including few metadata
+    """
+
+    index: np.ndarray
+    intensity: np.ndarray
+    background_avg: np.ndarray
+    background_std: np.ndarray
+
+    idx: typing.Optional[int]
+    """Index of the frame where 0 is the first frame"""
+
+    shape: tuple[int, ...]
+    """Shape of the frame"""
+
+    def __bool__(self):
+        return not self.isEmpty()
+
+    def isEmpty(self):
+        return self.index is None
+
+    def densify(self, mask, radius, dummy, normalization=None):
+        """Generate a dense image of its sparse representation with background
+
+        :param mask: 2D array with NaNs for mask and pixel radius for the valid pixels
+        :param radius: 1D array with the radial distance
+        :param dummy: numerical value for masked-out pixels in dense image
+        :param normalization: flat*solidangle*polarization*... array
+        :return dense array
+        """
+        dense = np.interp(mask, radius, self.background_avg)
+        if self.background_std is not None:
+            std = np.interp(mask, radius, self.background_std)
+            np.maximum(0.0, np.random.normal(dense, std), out=dense)
+        if normalization is not None:
+            dense *= normalization
+
+        flat = dense.ravel()
+        flat[self.index] = self.intensity
+        dtype = self.intensity.dtype
+        if np.issubdtype(dtype, np.integer):
+            dense = np.round(dense)
+        dense = np.ascontiguousarray(dense, dtype=dtype)
+        dense[np.logical_not(np.isfinite(mask))] = dummy
+        return dense
+
+    def densify_peaks(self):
+        """Generate a dense image of its sparse representation with peaks only
+
+        :param mask: 2D array with NaNs for mask and pixel radius for the valid pixels
+        :return dense array
+        """
+        dense = np.zeros(self.shape, self.intensity.dtype)
+        flat = dense.ravel()
+        flat[self.index] = self.intensity
+        return dense
+
+    @property
+    def data(self):
+        return self.densify_peaks()
+
+
+def decode_sparse_frame(raw_data: bytes) -> SmxSparseFrame:
+    """Decode data provided by Lima2
+
+    Argument:
+        raw_data: DevEncoded data
+
+    Returns:
+        A SmxSparseFrame.
+    """
+
+    if isinstance(raw_data, tuple):
+        # Support the direct output from proxy.readImage
+        if raw_data[0] != "SMX_SPARSE_FRAME":
+            raise DevEncodedFormatNotSupported(
+                "Data type SMX_SPARSE_FRAME expected (found %s)." % raw_data[0]
+            )
+        raw_data = raw_data[1]
+
+    (
+        width,
+        height,
+        nb_bins,
+        nb_peaks,
+        frame_idx,
+    ) = struct.unpack_from(DATA_HEADER_FORMAT, raw_data)
+
+    offset = DATA_HEADER_SIZE
+    index = np.frombuffer(raw_data, count=nb_peaks, offset=offset, dtype=np.int32)
+    offset += index.nbytes
+    intensity = np.frombuffer(raw_data, count=nb_peaks, offset=offset, dtype=np.float32)
+    offset += intensity.nbytes
+    background_avg = np.frombuffer(
+        raw_data, count=nb_bins, offset=offset, dtype=np.float32
+    )
+    offset += background_avg.nbytes
+    background_std = np.frombuffer(
+        raw_data, count=nb_bins, offset=offset, dtype=np.float32
+    )
+
+    shape = (1, height, width)
+    return SmxSparseFrame(
+        index, intensity, background_avg, background_std, frame_idx, shape
+    )

{lima2_client-2.1.1 → lima2_client-2.1.3}/src/lima2/client/pipeline.py

@@ -28,7 +28,12 @@ from typing_extensions import Optional
 
 from lima2.client import progress_counter, utils
 from lima2.client.convert import frame_info_to_shape_dtype
-from lima2.client.devencoded import dense_frame, sparse_frame, structured_array
+from lima2.client.devencoded import (
+    dense_frame,
+    sparse_frame,
+    smx_sparse_frame,
+    structured_array,
+)
 from lima2.client.progress_counter import ProgressCounter, SingleCounter
 from lima2.client.topology import (
     RoundRobinTopology,
@@ -45,11 +50,13 @@ logger = logging.getLogger(__name__)
 class FrameType(Enum):
     DENSE = auto()
     SPARSE = auto()
+    SMX_SPARSE = auto()
 
 
 decoder_by_type: dict[FrameType, Callable] = {
     FrameType.DENSE: dense_frame.decode,
     FrameType.SPARSE: sparse_frame.decode,
+    FrameType.SMX_SPARSE: smx_sparse_frame.decode_sparse_frame,
 }
 """Mapping from frame type to associated decode function"""
 

{lima2_client-2.1.1 → lima2_client-2.1.3}/src/lima2/client/pipelines/smx.py

@@ -36,7 +36,7 @@ class Smx(Pipeline):
         ),
         "sparse_frame": FrameSource(
             getter_name="getSparseFrame",
-            frame_type=FrameType.SPARSE,
+            frame_type=FrameType.SMX_SPARSE,
             saving_channel="saving_sparse",
         ),
         "acc_corrected": FrameSource(
@@ -121,3 +121,13 @@ class Smx(Pipeline):
         logger.debug(f"Returning peak counters for frames: {data['frame_idx']}")
 
         return (data["frame_idx"], data["nb_peaks"])
+
+    @property
+    def channels(self):
+        """Return the channel descriptions"""
+        return {
+            "frame": self.input_frame_info[0],
+            "sparse_frame": self.processed_frame_info[0],
+            "acc_corrected": self.processed_frame_info[0],
+            "acc_peaks": self.processed_frame_info[0],
+        }

{lima2_client-2.1.1 → lima2_client-2.1.3}/src/lima2/client/state_machine.py

@@ -83,7 +83,10 @@ class StateMachine(fsm.StateMachine):
                 State.FAULT,
                 State.UNKNOWN,
             ]:
-                self.error()
+                _logger.error(
+                    f"Device {evt.device.dev_name()} in FAULT state. Stopping all devices."
+                )
+                gevent.spawn(self.abort).join()
 
             if self.state == State.DISCONNECTED:
                 _logger.info(
@@ -123,6 +126,8 @@ class StateMachine(fsm.StateMachine):
             # Tolerate a mix of prepared and idle devices. In this case,
             # the global state shall be IDLE (forcing user to prepare again).
             self.state = State.IDLE
+        elif any(s == ServerState.fault for s in states):
+            self.state = State.FAULT
         elif not all(s == ctl_state for s in states):
             # Otherwise, if states are divergent, sync cannot be done
             self._state = State.UNKNOWN
@@ -153,7 +158,7 @@ class StateMachine(fsm.StateMachine):
             self.on_state_change(value)
 
     @transition(
-        source=[State.IDLE, State.PREPARED, State.FAULT],
+        source=[State.IDLE, State.PREPARED],
         target=State.PREPARING,
         on_error=State.IDLE,
     )
@@ -240,8 +245,18 @@ class StateMachine(fsm.StateMachine):
         ],
         target=State.FAULT,
     )
-    def error(self):
-        # Send close to control device only (recv close by themselves)
+    def abort(self):
+        """Called when a device enters FAULT state."""
+        self.ctrl.Stop()
+
+        # Stop acquisition on receivers that are running
+        greenlets = [
+            gevent.spawn(recv.Stop)
+            for recv in self.recvs
+            if recv.acq_state.name == "running"
+        ]
+        gevent.joinall(greenlets, raise_error=False)
+
         self.ctrl.Close()
 
     def __subscribe_events(self):
@@ -271,7 +286,8 @@ class StateMachine(fsm.StateMachine):
                     r.unsubscribe_event(e)
 
                 _logger.debug(f"on_end_acq while {self.state}")
-                gevent.spawn(self.close)
+                if self.state == State.RUNNING:
+                    gevent.spawn(self.close)
 
                 nb_frames_xferreds = []
 

{lima2_client-2.1.1 → lima2_client-2.1.3/src/lima2.client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: lima2.client
-Version: 2.1.1
+Version: 2.1.3
 Summary: Python client library for Lima2 detector
 Home-page: https://gitlab.esrf.fr/limagroup/lima2-client
 Author: BCU (ESRF)

{lima2_client-2.1.1 → lima2_client-2.1.3}/src/lima2.client.egg-info/SOURCES.txt

@@ -22,6 +22,7 @@ src/lima2/client/utils.py
 src/lima2/client/devencoded/__init__.py
 src/lima2/client/devencoded/dense_frame.py
 src/lima2/client/devencoded/exception.py
+src/lima2/client/devencoded/smx_sparse_frame.py
 src/lima2/client/devencoded/sparse_frame.py
 src/lima2/client/devencoded/structured_array.py
 src/lima2/client/pipelines/__init__.py