essreduce 25.12.1__py3-none-any.whl → 26.1.1__py3-none-any.whl

ess/reduce/streaming.py

@@ -108,6 +108,14 @@ class Accumulator(ABC, Generic[T]):
         Clear the accumulator, resetting it to its initial state.
         """
 
+    def on_finalize(self) -> None:
+        """
+        Called after finalize retrieves value.
+
+        Override this method to perform custom cleanup after each finalize cycle.
+        The default implementation does nothing.
+        """
+
 
 class EternalAccumulator(Accumulator[T]):
     """
@@ -422,6 +430,9 @@ class StreamProcessor:
             needs_recompute |= self._context_key_to_cached_context_nodes_map[key]
         for key, value in context.items():
             self._context_workflow[key] = value
+            # Propagate context values to finalize workflow so providers that depend
+            # on context keys receive the updated values during finalize().
+            self._finalize_workflow[key] = value
         results = self._context_workflow.compute(needs_recompute)
         for key, value in results.items():
             if key in self._target_keys:
@@ -505,7 +516,10 @@ class StreamProcessor:
         """
         for key in self._accumulators:
             self._finalize_workflow[key] = self._accumulators[key].value
-        return self._finalize_workflow.compute(self._target_keys)
+        result = self._finalize_workflow.compute(self._target_keys)
+        for acc in self._accumulators.values():
+            acc.on_finalize()
+        return result
 
     def clear(self) -> None:
         """

ess/reduce/time_of_flight/__init__.py

@@ -30,6 +30,8 @@ from .types import (
     TimeOfFlightLookupTableFilename,
     ToaDetector,
     TofDetector,
+    TofLookupTable,
+    TofLookupTableFilename,
     TofMonitor,
 )
 from .workflow import GenericTofWorkflow
@@ -54,6 +56,8 @@ __all__ = [
     "TimeResolution",
     "ToaDetector",
     "TofDetector",
+    "TofLookupTable",
+    "TofLookupTableFilename",
     "TofLookupTableWorkflow",
     "TofMonitor",
     "providers",

ess/reduce/time_of_flight/eto_to_tof.py

@@ -35,9 +35,9 @@ from .types import (
     DetectorLtotal,
     MonitorLtotal,
     PulseStrideOffset,
-    TimeOfFlightLookupTable,
     ToaDetector,
     TofDetector,
+    TofLookupTable,
     TofMonitor,
 )
 
@@ -96,7 +96,7 @@ class TofInterpolator:
 
 
 def _time_of_flight_data_histogram(
-    da: sc.DataArray, lookup: TimeOfFlightLookupTable, ltotal: sc.Variable
+    da: sc.DataArray, lookup: TofLookupTable, ltotal: sc.Variable
 ) -> sc.DataArray:
     # In NeXus, 'time_of_flight' is the canonical name in NXmonitor, but in some files,
     # it may be called 'tof' or 'frame_time'.
@@ -201,7 +201,7 @@ def _guess_pulse_stride_offset(
 
 def _prepare_tof_interpolation_inputs(
     da: sc.DataArray,
-    lookup: TimeOfFlightLookupTable,
+    lookup: TofLookupTable,
     ltotal: sc.Variable,
     pulse_stride_offset: int | None,
 ) -> dict:
@@ -295,7 +295,7 @@ def _prepare_tof_interpolation_inputs(
 
 def _time_of_flight_data_events(
     da: sc.DataArray,
-    lookup: TimeOfFlightLookupTable,
+    lookup: TofLookupTable,
     ltotal: sc.Variable,
     pulse_stride_offset: int | None,
 ) -> sc.DataArray:
@@ -395,7 +395,7 @@ def monitor_ltotal_from_straight_line_approximation(
 
 def _compute_tof_data(
     da: sc.DataArray,
-    lookup: TimeOfFlightLookupTable,
+    lookup: TofLookupTable,
     ltotal: sc.Variable,
     pulse_stride_offset: int,
 ) -> sc.DataArray:
@@ -413,7 +413,7 @@ def _compute_tof_data(
 
 def detector_time_of_flight_data(
     detector_data: RawDetector[RunType],
-    lookup: TimeOfFlightLookupTable,
+    lookup: TofLookupTable,
     ltotal: DetectorLtotal[RunType],
     pulse_stride_offset: PulseStrideOffset,
 ) -> TofDetector[RunType]:
@@ -447,7 +447,7 @@ def detector_time_of_flight_data(
 
 def monitor_time_of_flight_data(
     monitor_data: RawMonitor[RunType, MonitorType],
-    lookup: TimeOfFlightLookupTable,
+    lookup: TofLookupTable,
     ltotal: MonitorLtotal[RunType, MonitorType],
     pulse_stride_offset: PulseStrideOffset,
 ) -> TofMonitor[RunType, MonitorType]:
@@ -481,7 +481,7 @@ def monitor_time_of_flight_data(
 
 def detector_time_of_arrival_data(
     detector_data: RawDetector[RunType],
-    lookup: TimeOfFlightLookupTable,
+    lookup: TofLookupTable,
     ltotal: DetectorLtotal[RunType],
     pulse_stride_offset: PulseStrideOffset,
 ) -> ToaDetector[RunType]:

ess/reduce/time_of_flight/lut.py

@@ -13,7 +13,7 @@ import sciline as sl
 import scipp as sc
 
 from ..nexus.types import AnyRun, DiskChoppers
-from .types import TimeOfFlightLookupTable
+from .types import TofLookupTable
 
 
 @dataclass
@@ -30,9 +30,6 @@ class SimulationResults:
     time_of_arrival:
         Time of arrival of the neutrons at the position where the events were recorded
         (1d array of size N).
-    speed:
-        Speed of the neutrons, typically derived from the wavelength of the neutrons
-        (1d array of size N).
     wavelength:
         Wavelength of the neutrons (1d array of size N).
     weight:
@@ -48,12 +45,14 @@ class SimulationResults:
     """
 
     time_of_arrival: sc.Variable
-    speed: sc.Variable
     wavelength: sc.Variable
     weight: sc.Variable
     distance: sc.Variable
     choppers: DiskChoppers[AnyRun] | None = None
 
+    def __post_init__(self):
+        self.speed = (sc.constants.h / sc.constants.m_n) / self.wavelength
+
 
 NumberOfSimulatedNeutrons = NewType("NumberOfSimulatedNeutrons", int)
 """
@@ -230,7 +229,7 @@ def make_tof_lookup_table(
     pulse_period: PulsePeriod,
     pulse_stride: PulseStride,
     error_threshold: LookupTableRelativeErrorThreshold,
-) -> TimeOfFlightLookupTable:
+) -> TofLookupTable:
     """
     Compute a lookup table for time-of-flight as a function of distance and
     time-of-arrival.
@@ -239,7 +238,7 @@ def make_tof_lookup_table(
     ----------
     simulation:
         Results of a time-of-flight simulation used to create a lookup table.
-        The results should be a flat table with columns for time-of-arrival, speed,
+        The results should be a flat table with columns for time-of-arrival,
         wavelength, and weight.
     ltotal_range:
         Range of total flight path lengths from the source to the detector.
@@ -372,7 +371,7 @@ def make_tof_lookup_table(
     # In-place masking for better performance
     _mask_large_uncertainty(table, error_threshold)
 
-    return TimeOfFlightLookupTable(
+    return TofLookupTable(
         array=table,
         pulse_period=pulse_period,
         pulse_stride=pulse_stride,
@@ -398,13 +397,13 @@ def simulate_chopper_cascade_using_tof(
 ) -> SimulationResults:
     """
     Simulate a pulse of neutrons propagating through a chopper cascade using the
-    ``tof`` package (https://tof.readthedocs.io).
+    ``tof`` package (https://scipp.github.io/tof).
 
     Parameters
     ----------
     choppers:
         A dict of DiskChopper objects representing the choppers in the beamline. See
-        https://scipp.github.io/scippneutron/user-guide/chopper/processing-nexus-choppers.html#Build-DiskChopper
+        https://scipp.github.io/scippneutron/user-guide/chopper/processing-nexus-choppers.html
         for more information.
     source_position:
         A scalar variable with ``dtype=vector3`` that defines the source position.
@@ -436,7 +435,6 @@ def simulate_chopper_cascade_using_tof(
         events = source.data.squeeze().flatten(to='event')
         return SimulationResults(
             time_of_arrival=events.coords["birth_time"],
-            speed=events.coords["speed"],
             wavelength=events.coords["wavelength"],
             weight=events.data,
             distance=0.0 * sc.units.m,
@@ -451,7 +449,6 @@ def simulate_chopper_cascade_using_tof(
     ]
     return SimulationResults(
         time_of_arrival=events.coords["toa"],
-        speed=events.coords["speed"],
         wavelength=events.coords["wavelength"],
         weight=events.data,
         distance=furthest_chopper.distance,

ess/reduce/time_of_flight/types.py

@@ -10,12 +10,15 @@ import scipp as sc
 
 from ..nexus.types import MonitorType, RunType
 
-TimeOfFlightLookupTableFilename = NewType("TimeOfFlightLookupTableFilename", str)
+TofLookupTableFilename = NewType("TofLookupTableFilename", str)
 """Filename of the time-of-flight lookup table."""
 
+TimeOfFlightLookupTableFilename = TofLookupTableFilename
+"""Filename of the time-of-flight lookup table (alias)."""
+
 
 @dataclass
-class TimeOfFlightLookupTable:
+class TofLookupTable:
     """
     Lookup table giving time-of-flight as a function of distance and time of arrival.
     """
@@ -47,6 +50,10 @@ class TimeOfFlightLookupTable:
         return self.array.plot(*args, **kwargs)
 
 
+TimeOfFlightLookupTable = TofLookupTable
+"""Lookup table giving time-of-flight as a function of distance and time of arrival
+(alias)."""
+
 PulseStrideOffset = NewType("PulseStrideOffset", int | None)
 """
 When pulse-skipping, the offset of the first pulse in the stride. This is typically

ess/reduce/time_of_flight/workflow.py

@@ -9,14 +9,14 @@ from ..nexus import GenericNeXusWorkflow
 from . import eto_to_tof
 from .types import (
     PulseStrideOffset,
-    TimeOfFlightLookupTable,
-    TimeOfFlightLookupTableFilename,
+    TofLookupTable,
+    TofLookupTableFilename,
 )
 
 
 def load_tof_lookup_table(
-    filename: TimeOfFlightLookupTableFilename,
-) -> TimeOfFlightLookupTable:
+    filename: TofLookupTableFilename,
+) -> TofLookupTable:
     """Load a time-of-flight lookup table from an HDF5 file."""
     table = sc.io.load_hdf5(filename)
 
@@ -40,7 +40,7 @@ def load_tof_lookup_table(
             "error_threshold": table.coords["error_threshold"].value,
         }
 
-    return TimeOfFlightLookupTable(**table)
+    return TofLookupTable(**table)
 
 
 def GenericTofWorkflow(

{essreduce-25.12.1.dist-info → essreduce-26.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: essreduce
-Version: 25.12.1
+Version: 26.1.1
 Summary: Common data reduction tools for the ESS facility
 Author: Scipp contributors
 License-Expression: BSD-3-Clause

{essreduce-25.12.1.dist-info → essreduce-26.1.1.dist-info}/RECORD

@@ -3,7 +3,7 @@ ess/reduce/logging.py,sha256=6n8Czq4LZ3OK9ENlKsWSI1M3KvKv6_HSoUiV4__IUlU,357
 ess/reduce/normalization.py,sha256=r8H6SZgT94a1HE9qZ6Bx3N6c3VG3FzlJPzoCVMNI5-0,13081
 ess/reduce/parameter.py,sha256=4sCfoKOI2HuO_Q7JLH_jAXnEOFANSn5P3NdaOBzhJxc,4635
 ess/reduce/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ess/reduce/streaming.py,sha256=zbqxQz5dASDq4ZVyx-TdbapBXMyBttImCYz_6WOj4pg,17978
+ess/reduce/streaming.py,sha256=s-Pz6fhnaUPMjJ_lvSIdwF8WZjTK48lMDKQmCnqZf3c,18529
 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=738-lcdgsORYfQ4A0UTk2IgnbVxC3jBdpscpaOFIpdc,3114
@@ -20,15 +20,15 @@ ess/reduce/nexus/json_nexus.py,sha256=QrVc0p424nZ5dHX9gebAJppTw6lGZq9404P_OFl1gi
 ess/reduce/nexus/types.py,sha256=g5oBBEYPH7urF1tDP0tqXtixhQN8JDpe8vmiKrPiUW0,9320
 ess/reduce/nexus/workflow.py,sha256=bVRnVZ6HTEdIFwZv61JuvFUeTt9efUwe1MR65gBhyw8,24995
 ess/reduce/scripts/grow_nexus.py,sha256=hET3h06M0xlJd62E3palNLFvJMyNax2kK4XyJcOhl-I,3387
-ess/reduce/time_of_flight/__init__.py,sha256=jn8x9rZ6PzyP_wK8ACd3cg9rOpDAu_IqHyTNSeKfVn0,1461
-ess/reduce/time_of_flight/eto_to_tof.py,sha256=WkCmp8aDpnFTSbPnWosjb17oY5TnCnPDbL66ZeCHo_E,18849
+ess/reduce/time_of_flight/__init__.py,sha256=bNxhK0uePltQpCW2sdNTpPdzXL6dt1IT1ri_cJ5VTL8,1561
+ess/reduce/time_of_flight/eto_to_tof.py,sha256=imKuN7IARMqBjmi8kjAcsseTFg6OD8ORas9X1FolgFY,18777
 ess/reduce/time_of_flight/fakes.py,sha256=BqpO56PQyO9ua7QlZw6xXMAPBrqjKZEM_jc-VB83CyE,4289
 ess/reduce/time_of_flight/interpolator_numba.py,sha256=wh2YS3j2rOu30v1Ok3xNHcwS7t8eEtZyZvbfXOCtgrQ,3835
 ess/reduce/time_of_flight/interpolator_scipy.py,sha256=_InoAPuMm2qhJKZQBAHOGRFqtvvuQ8TStoN7j_YgS4M,1853
-ess/reduce/time_of_flight/lut.py,sha256=lle3Kl4AV0Z9-nxT3XwfhZS2DzHYYn0KRpUvNDlNuOk,18812
+ess/reduce/time_of_flight/lut.py,sha256=aFaP6CnbTVkScTfCkyvyKt7PCZcJjUNdlS9l-sLHr8c,18637
 ess/reduce/time_of_flight/resample.py,sha256=Opmi-JA4zNH725l9VB99U4O9UlM37f5ACTCGtwBcows,3718
-ess/reduce/time_of_flight/types.py,sha256=v7oUWY2tX1FL1FceK7EIOtRnMJevWD-kdBK04t10vlY,3082
-ess/reduce/time_of_flight/workflow.py,sha256=iaCHqY5-CxxUDrgbnOuECJm81QZZl-j0_ihXE4NaAUM,3129
+ess/reduce/time_of_flight/types.py,sha256=FsSueM6OjJdF80uJHj-TNuyVAci8ixFvMuRMt9oHKDQ,3310
+ess/reduce/time_of_flight/workflow.py,sha256=2jUxeSmP0KweQTctAzIFJLm7Odf_e7kZzAc8MAMKBEs,3084
 ess/reduce/widgets/__init__.py,sha256=SoSHBv8Dc3QXV9HUvPhjSYWMwKTGYZLpsWwsShIO97Q,5325
 ess/reduce/widgets/_base.py,sha256=_wN3FOlXgx_u0c-A_3yyoIH-SdUvDENGgquh9S-h5GI,4852
 ess/reduce/widgets/_binedges_widget.py,sha256=ZCQsGjYHnJr9GFUn7NjoZc1CdsnAzm_fMzyF-fTKKVY,2785
@@ -41,9 +41,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.12.1.dist-info/licenses/LICENSE,sha256=nVEiume4Qj6jMYfSRjHTM2jtJ4FGu0g-5Sdh7osfEYw,1553
-essreduce-25.12.1.dist-info/METADATA,sha256=ALXVOH9hCHFE8rKM8p14XLErG_3gk24HyvWwhX1FzKc,1988
-essreduce-25.12.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-essreduce-25.12.1.dist-info/entry_points.txt,sha256=PMZOIYzCifHMTe4pK3HbhxUwxjFaZizYlLD0td4Isb0,66
-essreduce-25.12.1.dist-info/top_level.txt,sha256=0JxTCgMKPLKtp14wb1-RKisQPQWX7i96innZNvHBr-s,4
-essreduce-25.12.1.dist-info/RECORD,,
+essreduce-26.1.1.dist-info/licenses/LICENSE,sha256=nVEiume4Qj6jMYfSRjHTM2jtJ4FGu0g-5Sdh7osfEYw,1553
+essreduce-26.1.1.dist-info/METADATA,sha256=fwMRSA5kTQ26OFwAM_7xjpvdcz-C3KMiC02MK153XTE,1987
+essreduce-26.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+essreduce-26.1.1.dist-info/entry_points.txt,sha256=PMZOIYzCifHMTe4pK3HbhxUwxjFaZizYlLD0td4Isb0,66
+essreduce-26.1.1.dist-info/top_level.txt,sha256=0JxTCgMKPLKtp14wb1-RKisQPQWX7i96innZNvHBr-s,4
+essreduce-26.1.1.dist-info/RECORD,,