blissdata-lima2 2.0__py3-none-any.whl

blissdata_lima2/__init__.py

@@ -0,0 +1,4 @@
+from .stream import Lima2Stream, Lima2View  # noqa: F401
+
+stream_cls = Lima2Stream
+view_cls = Lima2View

blissdata_lima2/stream.py

@@ -0,0 +1,254 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of the bliss project
+#
+# Copyright (c) Beamline Control Unit, ESRF
+# Distributed under the GNU LGPLv3. See LICENSE for more info.
+
+import logging
+from collections.abc import Sequence
+
+import lima2.client.services as l2s
+import numpy as np
+from blissdata.exceptions import (
+    EmptyViewException,
+    EndOfStream,
+    IndexNoMoreThereError,
+    IndexNotYetThereError,
+)
+from blissdata.lima.image_utils import ImageData
+from blissdata.streams import (
+    BaseStream,
+    BaseView,
+    EventRange,
+    EventStream,
+    StreamDefinition,
+)
+from blissdata.streams.default import Stream
+from blissdata.streams.encoding.numeric import NumericStreamEncoder
+from blissdata.streams.lima.stream import LimaDirectAccess
+from lima2.common.devencoded.sparse_frame import SparseFrame
+from numpy.typing import DTypeLike
+
+_logger = logging.getLogger(__name__)
+
+
+def get_frame(
+    services: l2s.ConductorServices,
+    acq_uuid: str,
+    source: str,
+    frame_idx: int,
+) -> ImageData:
+    frm = services.pipeline.get_frame(frame_idx=frame_idx, source=source, uuid=acq_uuid)
+
+    if isinstance(frm, SparseFrame):
+        frm = frm.densify()
+
+    return ImageData(array=frm.data, frame_id=frm.idx, acq_tag=None)
+
+
+class Lima2View(BaseView):
+    def __init__(
+        self,
+        services: l2s.ConductorServices,
+        acq_uuid: str,
+        source: str,
+        start: int,
+        stop: int,
+    ) -> None:
+        self._services = services
+        """Lima2 client services."""
+        self._acq_uuid = acq_uuid
+        """Lima2 acquisition id."""
+        self._source = source
+        """Frame source name."""
+        self._idx_range = range(start, stop)
+        """Range of absolute frame indices accessible via this view."""
+
+    @property
+    def index(self) -> int:
+        return self._idx_range.start
+
+    def __len__(self) -> int:
+        return len(self._idx_range)
+
+    def get_data(
+        self, start: int | None = None, stop: int | None = None
+    ) -> list[ImageData]:
+        try:
+            return [
+                get_frame(
+                    services=self._services,
+                    acq_uuid=self._acq_uuid,
+                    source=self._source,
+                    frame_idx=idx,
+                )
+                for idx in self._idx_range[start:stop]
+            ]
+        except RuntimeError as e:
+            raise IndexNoMoreThereError(
+                f"Can't fetch {self._source} {self._idx_range[start:stop].start} "
+                f"to {self._idx_range[start:stop].stop}: {e}"
+            ) from e
+
+
+class Lima2Stream(BaseStream, LimaDirectAccess):
+    """Stream of Lima2 frames.
+
+    Frames don't actually transit inside the stream. The stream length can be
+    queried to determine the number of accessible frames.
+
+    Indexing or slicing the stream attempts to fetch frames directly from the
+    Lima2 backend.
+    """
+
+    PROTOCOL_VERSION = 2
+
+    def __init__(self, event_stream: EventStream) -> None:
+        BaseStream.__init__(self, event_stream)
+
+        _logger.debug(f"Instantiate Lima2Stream with {event_stream.info=}")
+
+        if event_stream.info["protocol_version"] != Lima2Stream.PROTOCOL_VERSION:
+            raise RuntimeError(
+                f"Lima2 protocol version mismatch "
+                f"(expected {Lima2Stream.PROTOCOL_VERSION}, "
+                f"got {event_stream.info['protocol_version']})"
+            )
+
+        self._dtype = np.dtype(event_stream.info["dtype"])
+        self._shape = tuple(event_stream.info["shape"])
+        self._acq_uuid = str(event_stream.info["acq_uuid"])
+        self._source = str(event_stream.info["source_name"])
+
+        self._services = l2s.init(
+            hostname=str(event_stream.info["conductor_hostname"]),
+            port=int(event_stream.info["conductor_port"]),
+        )
+        """Lima2 client session."""
+
+        self._length = 0
+        """Current number of accessible frames."""
+
+        self._cursor = Stream(event_stream).cursor()
+
+    @property
+    def kind(self):
+        return "array"
+
+    @staticmethod
+    def make_definition(
+        name: str,
+        source_name: str,
+        conductor_hostname: str,
+        conductor_port: int,
+        acq_uuid: str,
+        master_file: tuple[str, str] | None,
+        dtype: DTypeLike,
+        shape: Sequence,
+    ) -> StreamDefinition:
+        info = {
+            "plugin": "lima2",
+            "dtype": np.dtype(dtype).name,
+            "shape": shape,
+            "protocol_version": Lima2Stream.PROTOCOL_VERSION,
+            "acq_uuid": acq_uuid,
+            "source_name": source_name,
+            "conductor_hostname": conductor_hostname,
+            "conductor_port": conductor_port,
+            "master_file": master_file,
+        }
+
+        return StreamDefinition(name, info, NumericStreamEncoder(np.uint32))
+
+    @property
+    def plugin(self) -> str:
+        return "lima2"
+
+    @property
+    def dtype(self) -> np.dtype:
+        return self._dtype
+
+    @property
+    def shape(self) -> tuple[int, ...]:
+        return self._shape
+
+    def __len__(self) -> int:
+        try:
+            view = self._cursor.read(block=False, last_only=True)
+        except EndOfStream:
+            view = None
+
+        if view is not None:
+            last_status = view.get_data()[0]
+            self._length = int(last_status)
+        return self._length
+
+    def __getitem__(self, key: int | slice) -> ImageData | list[ImageData]:
+        idx_range = range(len(self))
+        if type(key) is int:
+            if key < 0 and not self.is_sealed():
+                raise IndexNotYetThereError(
+                    "Can't index from end of stream until it is sealed"
+                )
+            return get_frame(
+                services=self._services,
+                acq_uuid=self._acq_uuid,
+                source=self._source,
+                frame_idx=idx_range[key],
+            )
+        elif type(key) is slice:
+            if not self.is_sealed() and ((key.start or 0) < 0 or (key.stop or 0) < 0):
+                raise IndexNotYetThereError(
+                    "Can't slice from end of stream until it is sealed"
+                )
+
+            return [
+                get_frame(
+                    services=self._services,
+                    acq_uuid=self._acq_uuid,
+                    source=self._source,
+                    frame_idx=idx,
+                )
+                for idx in idx_range[key]
+            ]
+        else:
+            raise TypeError(f"{type(key)}")
+
+    def _need_last_only(self, last_only: bool) -> bool:
+        # Lima2 event stream represents current progress
+        # -> only the latest one is relevant.
+        return True
+
+    def _build_view_from_events(
+        self, index: int, events: EventRange, last_only: bool
+    ) -> Lima2View:
+        """
+        Build a Lima2View to access a slice of frames which starts at `index`,
+        and ends at the most recent frame according to `events`.
+        """
+        _logger.debug(f"{self.name}: {index=} -> {events=}")
+
+        # events.data[-1] corresponds to the current number of contiguous frames
+        # accessible from the lima2 backend.
+        stop_idx = events.data[-1]
+
+        if stop_idx <= index:
+            # no new image despite new events
+            raise EmptyViewException
+
+        return Lima2View(
+            services=self._services,
+            acq_uuid=self._acq_uuid,
+            source=self._source,
+            start=stop_idx - 1 if last_only else index,
+            stop=stop_idx,
+        )
+
+    def get_last_live_image(self) -> ImageData:
+        return get_frame(
+            services=self._services,
+            acq_uuid=self._acq_uuid,
+            source=self._source,
+            frame_idx=-1,
+        )

blissdata_lima2/tests/conftest.py

@@ -0,0 +1 @@
+from blissdata.tests.conftest import redis_db, redis_url, data_store  # noqa F401

blissdata_lima2/tests/test_lima2_stream.py

@@ -0,0 +1,178 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of the bliss project
+#
+# Copyright (c) Beamline Control Unit, ESRF
+# Distributed under the GNU LGPLv3. See LICENSE for more info.
+
+"""Unit test suite for Lima2 stream and view (streams/lima2.py)."""
+
+from unittest.mock import Mock, call
+from uuid import uuid1
+
+import numpy as np
+import pytest
+from blissdata.exceptions import IndexNotYetThereError
+from blissdata.lima.image_utils import ImageData
+from blissdata.streams import EventStream
+
+from blissdata_lima2 import Lima2Stream, Lima2View
+from blissdata_lima2.stream import get_frame
+
+
+def test_lima2_get_frame():
+    services = Mock()
+    uuid = str(uuid1())
+    frm = get_frame(services=services, acq_uuid=uuid, source="cafe", frame_idx=123)
+    services.pipeline.get_frame.assert_called_with(
+        frame_idx=123, source="cafe", uuid=uuid
+    )
+    assert type(frm) is ImageData
+
+
+def test_lima2_view():
+    services = Mock()
+    uuid = str(uuid1())
+    view = Lima2View(
+        services=services,
+        acq_uuid=uuid,
+        source="cafe",
+        start=0,
+        stop=42,
+    )
+    assert len(view) == 42
+    assert view.index == 0
+
+    frames = view.get_data()
+    assert len(frames) == len(view)
+
+    services.pipeline.get_frame.assert_has_calls(
+        [call(uuid=uuid, source="cafe", frame_idx=i) for i in range(42)]
+    )
+
+
+def test_lima2_protocol(data_store):
+    uuid = str(uuid1())
+
+    stream_def = Lima2Stream.make_definition(
+        name="device:cafe",
+        source_name="cafe",
+        conductor_hostname="www.lima2.org",
+        conductor_port=12345,
+        acq_uuid=uuid,
+        master_file=None,
+        dtype=np.float128,  # fat pixels >:)
+        shape=(4, 1024, 512),
+    )
+    model = data_store._stream_model(
+        encoding=stream_def.encoder.info(), info=stream_def.info
+    )
+    model.info["protocol_version"] = 1  # hack the protocol number
+    event_stream = EventStream.create(data_store, stream_def.name, model)
+
+    with pytest.raises(RuntimeError):
+        _ = Lima2Stream(event_stream=event_stream)
+
+
+def test_lima2_stream(data_store, monkeypatch):
+    uuid = str(uuid1())
+
+    stream_def = Lima2Stream.make_definition(
+        name="device:cafe",
+        source_name="cafe",
+        conductor_hostname="www.lima2.org",
+        conductor_port=12345,
+        acq_uuid=uuid,
+        master_file=None,
+        dtype=np.float128,  # fat pixels >:)
+        shape=(4, 1024, 512),
+    )
+    model = data_store._stream_model(
+        encoding=stream_def.encoder.info(), info=stream_def.info
+    )
+
+    event_stream = EventStream.create(data_store, stream_def.name, model)
+    stream = Lima2Stream(event_stream=event_stream)
+
+    assert stream.plugin == "lima2"
+    assert stream.shape == stream_def.info["shape"]
+
+    # Feed the event stream
+    event_stream.send(np.uint32(42))
+    event_stream.join()
+    assert len(stream) == 42
+
+    event_stream.send(np.uint32(123))
+    event_stream.join()
+    assert len(stream) == 123
+
+    mock_get_frame = Mock()
+    monkeypatch.setattr("blissdata_lima2.stream.get_frame", mock_get_frame)
+
+    # Indexing
+    _ = stream[0]
+    mock_get_frame.assert_called_with(
+        services=stream._services,
+        acq_uuid=uuid,
+        source="cafe",
+        frame_idx=0,
+    )
+
+    with pytest.raises(IndexNotYetThereError):
+        _ = stream[-1]
+
+    # Slicing
+    _ = stream[:3]
+    assert mock_get_frame.mock_calls[-3:] == [
+        call(services=stream._services, acq_uuid=uuid, source="cafe", frame_idx=0),
+        call(services=stream._services, acq_uuid=uuid, source="cafe", frame_idx=1),
+        call(services=stream._services, acq_uuid=uuid, source="cafe", frame_idx=2),
+    ]
+
+    with pytest.raises(IndexNotYetThereError):
+        _ = stream[-2:]
+
+    with pytest.raises(IndexNotYetThereError):
+        _ = stream[:-2]
+
+    event_stream.seal()
+    event_stream.join()
+
+    # Now slicing/indexing from end is ok
+    _ = stream[-2:]
+    assert mock_get_frame.mock_calls[-2:] == [
+        call(
+            services=stream._services,
+            acq_uuid=uuid,
+            source="cafe",
+            frame_idx=123 - 2,
+        ),
+        call(
+            services=stream._services,
+            acq_uuid=uuid,
+            source="cafe",
+            frame_idx=123 - 1,
+        ),
+    ]
+
+    _ = stream[-3]
+    assert mock_get_frame.mock_calls[-1] == call(
+        services=stream._services,
+        acq_uuid=uuid,
+        source="cafe",
+        frame_idx=123 - 3,
+    )
+
+    _ = stream[:]
+    assert mock_get_frame.mock_calls[-123:] == [
+        call(services=stream._services, acq_uuid=uuid, source="cafe", frame_idx=i)
+        for i in range(123)
+    ]
+
+    _ = stream.get_last_live_image()
+    mock_get_frame.assert_called_with(
+        services=stream._services,
+        acq_uuid=uuid,
+        source="cafe",
+        frame_idx=-1,
+    )

blissdata_lima2-2.0.dist-info/METADATA

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: blissdata-lima2
+Version: 2.0
+Summary: Lima2 plugin for blissdata
+Maintainer: BCU (ESRF)
+License-Expression: MIT
+Keywords: blissdata,lima2
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: blissdata~=2.3
+Requires-Dist: lima2-client~=4.0
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-redis; extra == "dev"
+Dynamic: license-file
+
+## blissdata-lima2
+
+Lima2 plugin for blissdata.

blissdata_lima2-2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+blissdata_lima2/__init__.py,sha256=HjlW54bFxQEN3BpM50XLU5OkbSsihhoJSOEBT6ojOlQ,104
+blissdata_lima2/stream.py,sha256=9esgHEHvPDCiRbq94y8PmlTjyi4VfmSO1sLoGiARdHo,7745
+blissdata_lima2/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+blissdata_lima2/tests/conftest.py,sha256=OFm368MkFYoAfQj-LEbUEa0_pbHvAB-rKgUtn6YZ0E8,82
+blissdata_lima2/tests/test_lima2_stream.py,sha256=b6fPkJ_J0Ch9U_DjLdptuH7JrI0T60U0U-eEYgUf_Xs,4825
+blissdata_lima2-2.0.dist-info/licenses/LICENSE.md,sha256=Ep4SbBn-yQzazV_DparPnregYNRiRfWuHFdm4fs0HGY,1076
+blissdata_lima2-2.0.dist-info/METADATA,sha256=dlxcaEbSdzDpJ-Y-axUbJkpBucSl3HNBq17wVw06eK4,664
+blissdata_lima2-2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+blissdata_lima2-2.0.dist-info/entry_points.txt,sha256=OmwUIvXzPNXIYa0SwkuBzrjsOMYPyeq9QHffgpWgL7g,36
+blissdata_lima2-2.0.dist-info/top_level.txt,sha256=qD9nEgajoWcQsG0Dn0Rk-VIX91rKra1_CBBmN7O_1M8,16
+blissdata_lima2-2.0.dist-info/RECORD,,

blissdata_lima2-2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

blissdata_lima2-2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[blissdata]
+lima2 = blissdata_lima2

blissdata_lima2-2.0.dist-info/licenses/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2020-2024 Beamline Control Unit, ESRF
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

blissdata_lima2-2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+blissdata_lima2