essreduce 25.2.4__py3-none-any.whl → 25.2.6__py3-none-any.whl

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

ess/reduce/nexus/_nexus_loader.py

@@ -180,10 +180,15 @@ def _attempt_to_open_without_locking(
     # HDF5 tracks file locking flags internally within a single process.
     # If the same file is opened multiple times, we can get a flag mismatch.
     # We can try opening without locking, maybe this matches the original flags.
-    if "file locking flag values don't match" in err.args[0]:
-        return True
-    if "file locking 'ignore disabled locks' flag values don't match" in err.args[0]:
-        return True
+    error_message = err.args[0]
+    if isinstance(error_message, str):
+        if "file locking flag values don't match" in error_message:
+            return True
+        if (
+            "file locking 'ignore disabled locks' flag values don't match"
+            in error_message
+        ):
+            return True
     return False
 
 

ess/reduce/streaming.py

@@ -68,7 +68,18 @@ class Accumulator(ABC, Generic[T]):
     def _do_push(self, value: T) -> None: ...
 
     @property
-    @abstractmethod
+    def is_empty(self) -> bool:
+        """
+        Check if the accumulator is empty.
+
+        Returns
+        -------
+        :
+            True if the accumulator is empty, False otherwise.
+        """
+        return False
+
+    @property
     def value(self) -> T:
         """
         Get the accumulated value.
@@ -77,6 +88,24 @@ class Accumulator(ABC, Generic[T]):
         -------
         :
             Accumulated value.
+
+        Raises
+        ------
+        ValueError
+            If the accumulator is empty.
+        """
+        if self.is_empty:
+            raise ValueError("Cannot get value from empty accumulator")
+        return self._get_value()
+
+    @abstractmethod
+    def _get_value(self) -> T:
+        """Return the accumulated value, assuming it exists."""
+
+    @abstractmethod
+    def clear(self) -> None:
+        """
+        Clear the accumulator, resetting it to its initial state.
         """
 
 
@@ -92,7 +121,10 @@ class EternalAccumulator(Accumulator[T]):
         self._value: T | None = None
 
     @property
-    def value(self) -> T:
+    def is_empty(self) -> bool:
+        return self._value is None
+
+    def _get_value(self) -> T:
         return deepcopy(self._value)
 
     def _do_push(self, value: T) -> None:
@@ -101,6 +133,10 @@ class EternalAccumulator(Accumulator[T]):
         else:
             self._value += value
 
+    def clear(self) -> None:
+        """Clear the accumulated value."""
+        self._value = None
+
 
 class RollingAccumulator(Accumulator[T]):
     """
@@ -121,7 +157,10 @@ class RollingAccumulator(Accumulator[T]):
         self._values: list[T] = []
 
     @property
-    def value(self) -> T:
+    def is_empty(self) -> bool:
+        return len(self._values) == 0
+
+    def _get_value(self) -> T:
         # Naive and potentially slow implementation if values and/or window are large!
         return sc.reduce(self._values).sum()
 
@@ -130,6 +169,68 @@ class RollingAccumulator(Accumulator[T]):
         if len(self._values) > self._window:
             self._values.pop(0)
 
+    def clear(self) -> None:
+        """Clear the accumulated values."""
+        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:
     """
@@ -299,6 +400,16 @@ class StreamProcessor:
             self._finalize_workflow[key] = self._accumulators[key].value
         return self._finalize_workflow.compute(self._target_keys)
 
+    def clear(self) -> None:
+        """
+        Clear all accumulators, resetting them to their initial state.
+
+        This is useful for restarting a streaming computation without
+        creating a new StreamProcessor instance.
+        """
+        for accumulator in self._accumulators.values():
+            accumulator.clear()
+
 
 def _find_descendants(
     workflow: sciline.Pipeline, keys: tuple[sciline.typing.Key, ...]

{essreduce-25.2.4.dist-info → essreduce-25.2.6.dist-info}/METADATA

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

{essreduce-25.2.4.dist-info → essreduce-25.2.6.dist-info}/RECORD

@@ -3,16 +3,16 @@ ess/reduce/data.py,sha256=vaoeAJ6EpK1YghOiAALLdWiW17TgUnnnt0H-RGiGzXk,3756
 ess/reduce/logging.py,sha256=6n8Czq4LZ3OK9ENlKsWSI1M3KvKv6_HSoUiV4__IUlU,357
 ess/reduce/parameter.py,sha256=4sCfoKOI2HuO_Q7JLH_jAXnEOFANSn5P3NdaOBzhJxc,4635
 ess/reduce/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ess/reduce/streaming.py,sha256=ffFiWpq9AK1GOfRG-rlvT_Gz7HMBnE4FD0qPZiej4Gg,10306
+ess/reduce/streaming.py,sha256=_zFaT9vZQ4HZ1g9qbCQxetenITdqGZMPhyNNffMpGKw,13244
 ess/reduce/ui.py,sha256=zmorAbDwX1cU3ygDT--OP58o0qU7OBcmJz03jPeYSLA,10884
 ess/reduce/uncertainty.py,sha256=LR4O6ApB6Z-W9gC_XW0ajupl8yFG-du0eee1AX_R-gk,6990
 ess/reduce/workflow.py,sha256=sL34T_2Cjl_8iFlegujxI9VyOUwo6erVC8pOXnfWgYw,3060
 ess/reduce/live/__init__.py,sha256=jPQVhihRVNtEDrE20PoKkclKV2aBF1lS7cCHootgFgI,204
-ess/reduce/live/raw.py,sha256=pzXsPZQERtUm5tabTXjxd-XHH4WDDP13TTBG0lGPcqg,25262
+ess/reduce/live/raw.py,sha256=hyWkDJ0WYE2TS12dVxpRUh6RkzcUJL0bVDd4JjTidi0,24217
 ess/reduce/live/roi.py,sha256=Hs-pW98k41WU6Kl3UQ41kQawk80c2QNOQ_WNctLzDPE,3795
 ess/reduce/live/workflow.py,sha256=bsbwvTqPhRO6mC__3b7MgU7DWwAnOvGvG-t2n22EKq8,4285
 ess/reduce/nexus/__init__.py,sha256=59bxKkNYg8DYcSykNvH6nCa5SYchJC4SbgZEKhkNdYc,967
-ess/reduce/nexus/_nexus_loader.py,sha256=Y8ILMFEP9KxVfyEMGSFKoZZS79DIs0niRqI2Lq2TqZk,19720
+ess/reduce/nexus/_nexus_loader.py,sha256=NpBTBjWLKSnW0B1EarFdt2QxV0X7QBQLk2dSJq2ZuOw,19847
 ess/reduce/nexus/json_generator.py,sha256=ME2Xn8L7Oi3uHJk9ZZdCRQTRX-OV_wh9-DJn07Alplk,2529
 ess/reduce/nexus/json_nexus.py,sha256=QrVc0p424nZ5dHX9gebAJppTw6lGZq9404P_OFl1giA,10282
 ess/reduce/nexus/types.py,sha256=15XcHbNbOfnAYjWXzzKyYDVNyNixRnP0hJ-Q2duwMWE,9896
@@ -36,9 +36,9 @@ ess/reduce/widgets/_spinner.py,sha256=2VY4Fhfa7HMXox2O7UbofcdKsYG-AJGrsgGJB85nDX
 ess/reduce/widgets/_string_widget.py,sha256=iPAdfANyXHf-nkfhgkyH6gQDklia0LebLTmwi3m-iYQ,1482
 ess/reduce/widgets/_switchable_widget.py,sha256=fjKz99SKLhIF1BLgGVBSKKn3Lu_jYBwDYGeAjbJY3Q8,2390
 ess/reduce/widgets/_vector_widget.py,sha256=aTaBqCFHZQhrIoX6-sSqFWCPePEW8HQt5kUio8jP1t8,1203
-essreduce-25.2.4.dist-info/LICENSE,sha256=nVEiume4Qj6jMYfSRjHTM2jtJ4FGu0g-5Sdh7osfEYw,1553
-essreduce-25.2.4.dist-info/METADATA,sha256=4esgkOAUN-XvPn_1HnmisKvJvG5RA0UGFUrmVQPyg50,3708
-essreduce-25.2.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-essreduce-25.2.4.dist-info/entry_points.txt,sha256=PMZOIYzCifHMTe4pK3HbhxUwxjFaZizYlLD0td4Isb0,66
-essreduce-25.2.4.dist-info/top_level.txt,sha256=0JxTCgMKPLKtp14wb1-RKisQPQWX7i96innZNvHBr-s,4
-essreduce-25.2.4.dist-info/RECORD,,
+essreduce-25.2.6.dist-info/LICENSE,sha256=nVEiume4Qj6jMYfSRjHTM2jtJ4FGu0g-5Sdh7osfEYw,1553
+essreduce-25.2.6.dist-info/METADATA,sha256=Gz0Tmn2PFemCCTqJEHbPOMPGLl0ssONSerL6spFiYa4,3708
+essreduce-25.2.6.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+essreduce-25.2.6.dist-info/entry_points.txt,sha256=PMZOIYzCifHMTe4pK3HbhxUwxjFaZizYlLD0td4Isb0,66
+essreduce-25.2.6.dist-info/top_level.txt,sha256=0JxTCgMKPLKtp14wb1-RKisQPQWX7i96innZNvHBr-s,4
+essreduce-25.2.6.dist-info/RECORD,,

{essreduce-25.2.4.dist-info → essreduce-25.2.6.dist-info}/WHEEL

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