essreduce 25.1.1__py3-none-any.whl → 25.2.0__py3-none-any.whl

ess/reduce/time_of_flight/types.py

@@ -48,17 +48,6 @@ class SimulationResults:
     distance: sc.Variable
 
 
-@dataclass
-class FastestNeutron:
-    """
-    Properties of the fastest neutron in the simulation results.
-    """
-
-    time_of_arrival: sc.Variable
-    speed: sc.Variable
-    distance: sc.Variable
-
-
 LtotalRange = NewType("LtotalRange", tuple[sc.Variable, sc.Variable])
 """
 Range (min, max) of the total length of the flight path from the source to the detector.
@@ -79,10 +68,16 @@ Should be a single scalar value with a unit of length.
 This is typically of the order of 1-10 cm.
 """
 
-TimeOfArrivalResolution = NewType("TimeOfArrivalResolution", int | sc.Variable)
+TimeResolution = NewType("TimeResolution", sc.Variable)
 """
-Resolution of the time of arrival axis in the lookup table.
-Can be an integer (number of bins) or a sc.Variable (bin width).
+Step size of the event_time_offset axis in the lookup table.
+This is basically the 'time-of-flight' resolution of the detector.
+Should be a single scalar value with a unit of time.
+This is typically of the order of 0.1-0.5 ms.
+
+Since the event_time_offset range needs to span exactly one pulse period, the final
+resolution in the lookup table will be at least the supplied value here, but may be
+smaller if the pulse period is not an integer multiple of the time resolution.
 """
 
 TimeOfFlightLookupTable = NewType("TimeOfFlightLookupTable", sc.DataArray)
@@ -90,48 +85,12 @@ TimeOfFlightLookupTable = NewType("TimeOfFlightLookupTable", sc.DataArray)
 Lookup table giving time-of-flight as a function of distance and time of arrival.
 """
 
-MaskedTimeOfFlightLookupTable = NewType("MaskedTimeOfFlightLookupTable", sc.DataArray)
-"""
-Lookup table giving time-of-flight as a function of distance and time of arrival, with
-regions of large uncertainty masked out.
-"""
-
 LookupTableRelativeErrorThreshold = NewType("LookupTableRelativeErrorThreshold", float)
-
-FramePeriod = NewType("FramePeriod", sc.Variable)
 """
-The period of a frame, a (small) integer multiple of the source period.
+Threshold for the relative standard deviation (coefficient of variation) of the
+projected time-of-flight above which values are masked.
 """
 
-UnwrappedTimeOfArrival = NewType("UnwrappedTimeOfArrival", sc.Variable)
-"""
-Time of arrival of the neutron at the detector, unwrapped at the pulse period.
-"""
-
-PivotTimeAtDetector = NewType("PivotTimeAtDetector", sc.Variable)
-"""
-Pivot time at the detector, i.e., the time of the start of the frame at the detector.
-"""
-
-UnwrappedTimeOfArrivalMinusPivotTime = NewType(
-    "UnwrappedTimeOfArrivalMinusPivotTime", sc.Variable
-)
-"""
-Time of arrival of the neutron at the detector, unwrapped at the pulse period, minus
-the start time of the frame.
-"""
-
-TimeOfArrivalMinusPivotTimeModuloPeriod = NewType(
-    "TimeOfArrivalMinusPivotTimeModuloPeriod", sc.Variable
-)
-"""
-Time of arrival of the neutron at the detector minus the start time of the frame,
-modulo the frame period.
-"""
-
-FrameFoldedTimeOfArrival = NewType("FrameFoldedTimeOfArrival", sc.Variable)
-
-
 PulsePeriod = NewType("PulsePeriod", sc.Variable)
 """
 Period of the source pulses, i.e., time between consecutive pulse starts.
@@ -144,7 +103,8 @@ Stride of used pulses. Usually 1, but may be a small integer when pulse-skipping
 
 PulseStrideOffset = NewType("PulseStrideOffset", int)
 """
-When pulse-skipping, the offset of the first pulse in the stride.
+When pulse-skipping, the offset of the first pulse in the stride. This is typically
+zero but can be a small integer < pulse_stride.
 """
 
 RawData = NewType("RawData", sc.DataArray)

{essreduce-25.1.1.dist-info → essreduce-25.2.0.dist-info}/METADATA

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

{essreduce-25.1.1.dist-info → essreduce-25.2.0.dist-info}/RECORD

@@ -3,26 +3,27 @@ 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=nEO1Xg6LbQ36F44UaVmSNe2MSWmpwz97y9tnlc-z0zA,7493
+ess/reduce/streaming.py,sha256=-ffg5pq0ShVPatLzHqKfWU-qpYmuYZjOrwoKd8J4aJU,9129
 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=W9fv0zaRqC6PFB5DYGAI1BK-zMgX73h5JHANKu-sMl4,19438
+ess/reduce/live/raw.py,sha256=o1Q3t07qPPncCMtZOk6x17OUzhWFXGfy4WeO0YGEw4Y,24997
+ess/reduce/live/roi.py,sha256=6EwQNjGLk5y2zwI99YIVw6Q7si7U25Ou_IM_kLfkkAU,3719
 ess/reduce/live/workflow.py,sha256=bsbwvTqPhRO6mC__3b7MgU7DWwAnOvGvG-t2n22EKq8,4285
 ess/reduce/nexus/__init__.py,sha256=PxJkhlGcFRzVU4SICBhymK5_5FjM5oXPZ8YUpd0v1pE,967
-ess/reduce/nexus/_nexus_loader.py,sha256=otc0qEjGD5K8xFLbn_RYAble34NoDhxLaazE0LAvySE,17911
+ess/reduce/nexus/_nexus_loader.py,sha256=NbKIepTxv-UirVlViImh8Ozm16k-ZIiF6AQ9-oKuDHU,19222
 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=Az_pZtaTIlEAA4Po_YOLabez8w4HeHcr0asY3rS6BXg,9676
 ess/reduce/nexus/workflow.py,sha256=jzdh0ubp9Mmb98a04KIeM8Xo9bpAqpnsfwFWz2VllnQ,23676
 ess/reduce/scripts/grow_nexus.py,sha256=hET3h06M0xlJd62E3palNLFvJMyNax2kK4XyJcOhl-I,3387
-ess/reduce/time_of_flight/__init__.py,sha256=buqd_rvHvdeO3BTZLf_rKGAFwfJgd6ixAAsxRU_-kik,1546
-ess/reduce/time_of_flight/fakes.py,sha256=cyo6eYn0nOy3Dt1iDge7utkUrSGU-OpZ5g73-DGJsyw,7583
-ess/reduce/time_of_flight/simulation.py,sha256=Tn4kRkXisWjA4ss4AXVshfa9gga0GFOXqtABjRru2MI,2488
-ess/reduce/time_of_flight/to_events.py,sha256=hXTyc_o6qQc2KDurUM55Kb-5VS-VrB9lE5H_R6vAfYM,4115
-ess/reduce/time_of_flight/toa_to_tof.py,sha256=_aQiXqO5LeeBePZcZv_f5VhkreH9NDwFQfDsbe275xI,19505
-ess/reduce/time_of_flight/types.py,sha256=JIAvdBF61wESKoxl1vHmks_udNfT2dlrOxHKOBjFCzg,5888
+ess/reduce/time_of_flight/__init__.py,sha256=VJWy8kXJ-QaVWWed7C9rLhCpZ7MrkXuv9-8cV-U7TQ4,1098
+ess/reduce/time_of_flight/fakes.py,sha256=UyYxvtnb8QDdCgwaOhe0guRGCKP1DFr0wPXUPO3RNYU,6730
+ess/reduce/time_of_flight/simulation.py,sha256=CireE9m9kFbUXhGUeY2L3SoMy7kpqopxKj__h4tSKzo,2614
+ess/reduce/time_of_flight/to_events.py,sha256=_5CcUOWvguDcK8uo2pPZWzXnWoiZhC1w-zF8xysaIvU,4339
+ess/reduce/time_of_flight/toa_to_tof.py,sha256=crvNe6GIwHLrSUE_C3omDfroIujoH1rphwWhX8Dj25U,20601
+ess/reduce/time_of_flight/types.py,sha256=fIgnLKv6QolevXwrY5hD2-eC_7wtNlVJ-k6CvaeRJQk,5014
 ess/reduce/widgets/__init__.py,sha256=wk5ihxvtZHqkp2EYVtbJr1Es0lw69KQpyTSaizNgWjU,5326
 ess/reduce/widgets/_base.py,sha256=_wN3FOlXgx_u0c-A_3yyoIH-SdUvDENGgquh9S-h5GI,4852
 ess/reduce/widgets/_binedges_widget.py,sha256=ZCQsGjYHnJr9GFUn7NjoZc1CdsnAzm_fMzyF-fTKKVY,2785
@@ -35,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.1.1.dist-info/LICENSE,sha256=nVEiume4Qj6jMYfSRjHTM2jtJ4FGu0g-5Sdh7osfEYw,1553
-essreduce-25.1.1.dist-info/METADATA,sha256=mjZuI2PH5ONZej_X6h-FCcEUOu70Qh8sxwaWLUL5gH0,3708
-essreduce-25.1.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-essreduce-25.1.1.dist-info/entry_points.txt,sha256=PMZOIYzCifHMTe4pK3HbhxUwxjFaZizYlLD0td4Isb0,66
-essreduce-25.1.1.dist-info/top_level.txt,sha256=0JxTCgMKPLKtp14wb1-RKisQPQWX7i96innZNvHBr-s,4
-essreduce-25.1.1.dist-info/RECORD,,
+essreduce-25.2.0.dist-info/LICENSE,sha256=nVEiume4Qj6jMYfSRjHTM2jtJ4FGu0g-5Sdh7osfEYw,1553
+essreduce-25.2.0.dist-info/METADATA,sha256=43hbId31E_VE73MQpwhFxaBgLsHuzx_rI2RQg1IBtSI,3708
+essreduce-25.2.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+essreduce-25.2.0.dist-info/entry_points.txt,sha256=PMZOIYzCifHMTe4pK3HbhxUwxjFaZizYlLD0td4Isb0,66
+essreduce-25.2.0.dist-info/top_level.txt,sha256=0JxTCgMKPLKtp14wb1-RKisQPQWX7i96innZNvHBr-s,4
+essreduce-25.2.0.dist-info/RECORD,,