essreduce 25.2.5__tar.gz → 25.3.0__tar.gz

{essreduce-25.2.5/src/essreduce.egg-info → essreduce-25.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: essreduce
-Version: 25.2.5
+Version: 25.3.0
 Summary: Common data reduction tools for the ESS facility
 Author: Scipp contributors
 License: BSD 3-Clause License

{essreduce-25.2.5 → essreduce-25.3.0}/src/ess/reduce/live/raw.py

@@ -15,14 +15,12 @@ options:
 - `'xy_plane'`: Project the data onto the x-y plane, i.e., perpendicular to the beam.
 - `'cylinder_mantle_z'`: Project the data onto the mantle of a cylinder aligned with the
    z-axis.
-- `LogicalView`: Not a projection in the traditional sense, but a way to select and
-  flatten dimensions of the data.
+- A callable, e.g., to select and flatten dimensions of the data.
 """
 
 from __future__ import annotations
 
 from collections.abc import Callable, Sequence
-from dataclasses import dataclass, field
 from math import ceil
 from typing import Literal, NewType
 
@@ -140,44 +138,6 @@ class Histogrammer:
         return self._hist(replicated, coords=self._coords) / self.replicas
 
 
-@dataclass
-class LogicalView:
-    """
-    Logical view of a multi-dimensional detector.
-
-    Instances can be used as a "projection" function for a detector view.
-
-    Parameters
-    ----------
-    fold:
-        Dimensions to fold. This is useful is the raw data has a single dimension that
-        corresponds to multiple dimensions in the logical view.
-    transpose:
-        Dimensions to transpose. This is useful for reordering dimensions.
-    select:
-        Dimensions with associated index to select from the data. This extracts a slice
-        of the data for each given dimension.
-    flatten:
-        Dimensions to flatten.
-    """
-
-    fold: dict[str, int] | None = None
-    transpose: tuple[str, ...] | None = None
-    select: dict[str, int] = field(default_factory=dict)
-    flatten: dict[str, list[str]] = field(default_factory=dict)
-
-    def __call__(self, da: sc.DataArray) -> sc.DataArray:
-        if self.fold is not None:
-            da = da.fold(da.dim, sizes=self.fold)
-        if self.transpose is not None:
-            da = da.transpose(self.transpose)
-        for dim, index in self.select.items():
-            da = da[dim, index]
-        for to, dims in self.flatten.items():
-            da = da.flatten(dims, to=to)
-        return da.copy()
-
-
 class Detector:
     def __init__(self, detector_number: sc.Variable):
         self._data = sc.DataArray(
@@ -295,7 +255,7 @@ class RollingDetectorView(Detector):
         else:
             indices = sc.ones(sizes=self.data.sizes, dtype='int32', unit=None)
             indices = sc.cumsum(indices, mode='exclusive')
-            if isinstance(self._projection, LogicalView):
+            if self._projection is not None:
                 indices = self._projection(indices)
         return roi.ROIFilter(indices=indices, norm=norm)
 
@@ -357,17 +317,23 @@ class RollingDetectorView(Detector):
         )
 
     @staticmethod
-    def from_detector_and_logical_view(
-        detector: CalibratedDetector[SampleRun],
-        window: RollingDetectorViewWindow,
-        projection: LogicalView,
-    ) -> RollingDetectorView:
-        """Helper for constructing via a Sciline workflow."""
-        return RollingDetectorView(
-            detector_number=detector.coords['detector_number'],
-            window=window,
-            projection=projection,
-        )
+    def from_detector_with_projection(
+        projection: Callable[[sc.DataArray], sc.DataArray] | None,
+    ) -> Callable[
+        [CalibratedDetector[SampleRun], RollingDetectorViewWindow], RollingDetectorView
+    ]:
+        def factory(
+            detector: CalibratedDetector[SampleRun],
+            window: RollingDetectorViewWindow,
+        ) -> RollingDetectorView:
+            """Helper for constructing via a Sciline workflow."""
+            return RollingDetectorView(
+                detector_number=detector.coords['detector_number'],
+                window=window,
+                projection=projection,
+            )
+
+        return factory
 
     @staticmethod
     def from_nexus(
@@ -375,7 +341,9 @@ class RollingDetectorView(Detector):
         *,
         detector_name: str,
         window: int,
-        projection: Literal['xy_plane', 'cylinder_mantle_z'] | LogicalView,
+        projection: Literal['xy_plane', 'cylinder_mantle_z']
+        | Callable[[sc.DataArray], sc.DataArray]
+        | None = None,
         resolution: dict[str, int] | None = None,
         pixel_noise: Literal['cylindrical'] | sc.Variable | None = None,
     ) -> RollingDetectorView:
@@ -396,10 +364,12 @@ class RollingDetectorView(Detector):
             Size of the rolling window.
         projection:
             Projection to use for the detector data. This can be a string selecting a
-            predefined projection or a LogicalView instance.
+            predefined projection or a function that takes a DataArray and returns a
+            DataArray. The predefined projections are 'xy_plane' and
+            'cylinder_mantle_z'.
         resolution:
-            Resolution to use for histogramming the detector data. Not required when the
-            projection is a LogicalView.
+            Resolution to use for histogramming the detector data. Only required for
+            'xy_plane' and 'cylinder_mantle_z' projections.
         pixel_noise:
             Noise to add to the pixel positions. This can be a scalar value to add
             Gaussian noise to the pixel positions or the string 'cylindrical' to add
@@ -413,13 +383,7 @@ class RollingDetectorView(Detector):
             noise_replica_count = 16
         wf = GenericNeXusWorkflow(run_types=[SampleRun], monitor_types=[])
         wf[RollingDetectorViewWindow] = window
-        if isinstance(projection, LogicalView):
-            wf[LogicalView] = projection
-            wf[NeXusTransformation[snx.NXdetector, SampleRun]] = NeXusTransformation[
-                snx.NXdetector, SampleRun
-            ](sc.scalar(1))
-            wf.insert(RollingDetectorView.from_detector_and_logical_view)
-        elif projection == 'cylinder_mantle_z':
+        if projection == 'cylinder_mantle_z':
             wf.insert(make_cylinder_mantle_coords)
             wf.insert(RollingDetectorView.from_detector_and_histogrammer)
             wf[DetectorViewResolution] = resolution
@@ -428,7 +392,12 @@ class RollingDetectorView(Detector):
             wf.insert(RollingDetectorView.from_detector_and_histogrammer)
             wf[DetectorViewResolution] = resolution
         else:
-            raise ValueError(f"Invalid {projection=}.")
+            wf[NeXusTransformation[snx.NXdetector, SampleRun]] = NeXusTransformation[
+                snx.NXdetector, SampleRun
+            ](sc.scalar(1))
+            wf.insert(
+                RollingDetectorView.from_detector_with_projection(projection=projection)
+            )
         if isinstance(pixel_noise, sc.Variable):
             wf.insert(gaussian_position_noise)
             wf[PositionNoiseSigma] = pixel_noise

{essreduce-25.2.5 → essreduce-25.3.0}/src/ess/reduce/streaming.py

@@ -174,6 +174,64 @@ class RollingAccumulator(Accumulator[T]):
         self._values = []
 
 
+class MinAccumulator(Accumulator):
+    """Keeps the minimum value seen so far.
+
+    Only supports scalar values.
+    """
+
+    def __init__(self, **kwargs: Any) -> None:
+        super().__init__(**kwargs)
+        self._cur_min: sc.Variable | None = None
+
+    def _do_push(self, value: sc.Variable) -> None:
+        if self._cur_min is None:
+            self._cur_min = value
+        else:
+            self._cur_min = min(self._cur_min, value)
+
+    @property
+    def is_empty(self) -> bool:
+        """Check if the accumulator has collected a minimum value."""
+        return self._cur_min is None
+
+    def _get_value(self) -> Any:
+        return self._cur_min
+
+    def clear(self) -> None:
+        """Clear the accumulated minimum value."""
+        self._cur_min = None
+
+
+class MaxAccumulator(Accumulator):
+    """Keeps the maximum value seen so far.
+
+    Only supports scalar values.
+    """
+
+    def __init__(self, **kwargs: Any) -> None:
+        super().__init__(**kwargs)
+        self._cur_max: sc.Variable | None = None
+
+    @property
+    def is_empty(self) -> bool:
+        """Check if the accumulator has collected a maximum value."""
+        return self._cur_max is None
+
+    def _do_push(self, value: sc.Variable) -> None:
+        if self._cur_max is None:
+            self._cur_max = value
+        else:
+            self._cur_max = max(self._cur_max, value)
+
+    def _get_value(self) -> sc.Variable | None:
+        return self._cur_max
+
+    def clear(self) -> None:
+        """Clear the accumulated maximum value."""
+        self._cur_max = None
+
+
 class StreamProcessor:
     """
     Wrap a base workflow for streaming processing of chunks.

{essreduce-25.2.5 → essreduce-25.3.0/src/essreduce.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: essreduce
-Version: 25.2.5
+Version: 25.3.0
 Summary: Common data reduction tools for the ESS facility
 Author: Scipp contributors
 License: BSD 3-Clause License

{essreduce-25.2.5 → essreduce-25.3.0}/tests/live/raw_test.py

@@ -354,13 +354,12 @@ def test_ROIFilter_from_trivial_RollingDetectorView() -> None:
     assert sc.identical(scale, sc.ones(dims=['detector_number'], shape=[2]))
 
 
-def test_ROIFilter_from_RollingDetectorView_with_LogicalView() -> None:
-    logical_view = raw.LogicalView(select={'z': 0})
+def test_ROIFilter_from_RollingDetectorView_with_custom_projection() -> None:
     detector_number = sc.array(
         dims=['x', 'y', 'z'], values=[[[1, 2], [3, 4]], [[5, 6], [7, 8]]], unit=None
     )
     view = raw.RollingDetectorView(
-        detector_number=detector_number, window=2, projection=logical_view
+        detector_number=detector_number, window=2, projection=lambda da: da['z', 0]
     )
     roi_filter = view.make_roi_filter()
     data = detector_number.copy()

{essreduce-25.2.5 → essreduce-25.3.0}/tests/live/roi_test.py

@@ -3,7 +3,7 @@
 import pytest
 import scipp as sc
 
-from ess.reduce.live import raw, roi
+from ess.reduce.live import roi
 
 
 @pytest.fixture
@@ -146,13 +146,12 @@ def test_apply_selection_fails_with_out_of_bounds_index():
         roi.apply_selection(data, selection=selection)
 
 
-@pytest.fixture
-def logical_view():
-    return raw.LogicalView(fold={'x': 3, 'y': 4, 'z': 2}, select={'z': 0})
+def logical_view(da: sc.DataArray) -> sc.DataArray:
+    return da.fold(da.dim, sizes={'x': 3, 'y': 4, 'z': 2})['z', 0]
 
 
 @pytest.fixture
-def roi_filter(logical_view: raw.LogicalView):
+def roi_filter() -> roi.ROIFilter:
     indices = sc.ones(sizes={'detector_number': 24}, dtype='int32', unit=None)
     indices = sc.cumsum(indices, mode='exclusive')
     return roi.ROIFilter(logical_view(indices))

{essreduce-25.2.5 → essreduce-25.3.0}/tests/streaming_test.py

@@ -152,6 +152,30 @@ def test_rolling_accumulator_is_empty() -> None:
         _ = accum.value
 
 
+def test_min_accumulator() -> None:
+    accum = streaming.MinAccumulator()
+    var = sc.array(dims=['x'], values=[1.0, 2.0, 3.0, 2.0, 1.0])
+    for scalar_var in var:
+        accum.push(scalar_var)
+    assert sc.identical(accum.value, sc.min(var))
+    accum.clear()
+    assert accum.is_empty
+    with pytest.raises(ValueError, match="Cannot get value from empty accumulator"):
+        _ = accum.value
+
+
+def test_max_accumulator() -> None:
+    accum = streaming.MaxAccumulator()
+    var = sc.array(dims=['x'], values=[1.0, 2.0, 3.0, 2.0, 1.0])
+    for scalar_var in var:
+        accum.push(scalar_var)
+    assert sc.identical(accum.value, sc.max(var))
+    accum.clear()
+    assert accum.is_empty
+    with pytest.raises(ValueError, match="Cannot get value from empty accumulator"):
+        _ = accum.value
+
+
 DynamicA = NewType('DynamicA', float)
 DynamicB = NewType('DynamicB', float)
 DynamicC = NewType('DynamicC', float)