essreduce 25.12.0__tar.gz → 26.1.0__tar.gz

{essreduce-25.12.0 → essreduce-26.1.0}/PKG-INFO

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

{essreduce-25.12.0 → essreduce-26.1.0}/docs/user-guide/tof/dream.ipynb

@@ -311,7 +311,7 @@
    "id": "21",
    "metadata": {},
    "source": [
-    "By default, the workflow tries to load a `TimeOfFlightLookupTable` from a file.\n",
+    "By default, the workflow tries to load a `TofLookupTable` from a file.\n",
     "\n",
     "In this notebook, instead of using such a pre-made file,\n",
     "we will build our own lookup table from the chopper information and apply it to the workflow."
@@ -346,7 +346,7 @@
     "    sc.scalar(75.5, unit=\"m\"),\n",
     "    sc.scalar(78.0, unit=\"m\"),\n",
     ")\n",
-    "lut_wf.visualize(TimeOfFlightLookupTable)"
+    "lut_wf.visualize(TofLookupTable)"
    ]
   },
   {
@@ -411,7 +411,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "table = lut_wf.compute(TimeOfFlightLookupTable)\n",
+    "table = lut_wf.compute(TofLookupTable)\n",
     "\n",
     "# Overlay mean on the figure above\n",
     "table.array[\"distance\", 13].plot(ax=fig2.ax, color=\"C1\", ls=\"-\", marker=None)"
@@ -453,7 +453,7 @@
    "outputs": [],
    "source": [
     "# Set the computed lookup table onto the original workflow\n",
-    "wf[TimeOfFlightLookupTable] = table\n",
+    "wf[TofLookupTable] = table\n",
     "\n",
     "# Compute time-of-flight of neutron events\n",
     "tofs = wf.compute(TofDetector[SampleRun])\n",
@@ -743,7 +743,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "table = lut_wf.compute(TimeOfFlightLookupTable).array\n",
+    "table = lut_wf.compute(TofLookupTable).array\n",
     "table.plot() / (sc.stddevs(table) / sc.values(table)).plot(norm=\"log\")"
    ]
   },
@@ -769,7 +769,7 @@
    "source": [
     "lut_wf[LookupTableRelativeErrorThreshold] = 0.01\n",
     "\n",
-    "table = lut_wf.compute(TimeOfFlightLookupTable)\n",
+    "table = lut_wf.compute(TofLookupTable)\n",
     "table.plot()"
    ]
   },
@@ -797,7 +797,7 @@
     "wf[RawDetector[SampleRun]] = ess_beamline.get_monitor(\"detector\")[0]\n",
     "wf[DetectorLtotal[SampleRun]] = Ltotal\n",
     "\n",
-    "wf[TimeOfFlightLookupTable] = table\n",
+    "wf[TofLookupTable] = table\n",
     "\n",
     "# Compute time-of-flight\n",
     "tofs = wf.compute(TofDetector[SampleRun])\n",

{essreduce-25.12.0 → essreduce-26.1.0}/docs/user-guide/tof/frame-unwrapping.ipynb

@@ -171,7 +171,7 @@
    "id": "9",
    "metadata": {},
    "source": [
-    "By default, the workflow tries to load a `TimeOfFlightLookupTable` from a file.\n",
+    "By default, the workflow tries to load a `TofLookupTable` from a file.\n",
     "\n",
     "In this notebook, instead of using such a pre-made file,\n",
     "we will build our own lookup table from the chopper information and apply it to the workflow.\n",
@@ -227,7 +227,7 @@
     "}\n",
     "lut_wf[SourcePosition] = sc.vector([0, 0, 0], unit=\"m\")\n",
     "\n",
-    "lut_wf.visualize(TimeOfFlightLookupTable)"
+    "lut_wf.visualize(TofLookupTable)"
    ]
   },
   {
@@ -245,7 +245,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "table = lut_wf.compute(TimeOfFlightLookupTable)\n",
+    "table = lut_wf.compute(TofLookupTable)\n",
     "table.plot()"
    ]
   },
@@ -267,7 +267,7 @@
    "outputs": [],
    "source": [
     "# Set the computed lookup table on the original workflow\n",
-    "wf[TimeOfFlightLookupTable] = table\n",
+    "wf[TofLookupTable] = table\n",
     "\n",
     "# Compute neutron tofs\n",
     "tofs = wf.compute(TofDetector[SampleRun])\n",
@@ -432,7 +432,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "table = lut_wf.compute(TimeOfFlightLookupTable)\n",
+    "table = lut_wf.compute(TofLookupTable)\n",
     "\n",
     "table.plot(figsize=(9, 4))"
    ]
@@ -457,7 +457,7 @@
     "nxevent_data = results.to_nxevent_data()\n",
     "wf[RawDetector[SampleRun]] = nxevent_data\n",
     "wf[DetectorLtotal[SampleRun]] = nxevent_data.coords[\"Ltotal\"]\n",
-    "wf[TimeOfFlightLookupTable] = table\n",
+    "wf[TofLookupTable] = table\n",
     "\n",
     "tofs = wf.compute(TofDetector[SampleRun])\n",
     "\n",

{essreduce-25.12.0 → essreduce-26.1.0}/docs/user-guide/tof/wfm.ipynb

@@ -332,7 +332,7 @@
    "id": "20",
    "metadata": {},
    "source": [
-    "By default, the workflow tries to load a `TimeOfFlightLookupTable` from a file.\n",
+    "By default, the workflow tries to load a `TofLookupTable` from a file.\n",
     "\n",
     "In this notebook, instead of using such a pre-made file,\n",
     "we will build our own lookup table from the chopper information and apply it to the workflow."
@@ -365,7 +365,7 @@
     "lut_wf[SourcePosition] = source_position\n",
     "lut_wf[LtotalRange] = Ltotal, Ltotal\n",
     "lut_wf[LookupTableRelativeErrorThreshold] = 0.1\n",
-    "lut_wf.visualize(TimeOfFlightLookupTable)"
+    "lut_wf.visualize(TofLookupTable)"
    ]
   },
   {
@@ -430,7 +430,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "table = lut_wf.compute(TimeOfFlightLookupTable)\n",
+    "table = lut_wf.compute(TofLookupTable)\n",
     "\n",
     "# Overlay mean on the figure above\n",
     "table.array[\"distance\", 1].plot(ax=fig2.ax, color=\"C1\", ls=\"-\", marker=None)\n",
@@ -463,7 +463,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "wf[TimeOfFlightLookupTable] = table\n",
+    "wf[TofLookupTable] = table\n",
     "\n",
     "tofs = wf.compute(TofDetector[SampleRun])\n",
     "tofs"

{essreduce-25.12.0 → essreduce-26.1.0}/requirements/base.txt

@@ -67,7 +67,7 @@ python-dateutil==2.9.0.post0
     #   scippneutron
 sciline==25.11.1
     # via -r base.in
-scipp==25.11.0
+scipp==25.12.0
     # via
     #   -r base.in
     #   scippneutron

{essreduce-25.12.0 → essreduce-26.1.0}/requirements/basetest.txt

@@ -99,7 +99,7 @@ python-dateutil==2.9.0.post0
     # via matplotlib
 requests==2.32.5
     # via pooch
-scipp==25.11.0
+scipp==25.12.0
     # via tof
 scipy==1.16.3
     # via -r basetest.in

{essreduce-25.12.0 → essreduce-26.1.0}/src/ess/reduce/nexus/workflow.py

@@ -370,6 +370,8 @@ def get_calibrated_detector(
     ----------
     detector:
         NeXus detector group.
+    transform:
+        Transformation matrix for the detector.
     offset:
         Offset to add to the detector position.
     bank_sizes:
@@ -430,8 +432,8 @@ def assemble_detector_data(
 
 def get_calibrated_monitor(
     monitor: NeXusComponent[MonitorType, RunType],
+    transform: NeXusTransformation[MonitorType, RunType],
     offset: MonitorPositionOffset[RunType, MonitorType],
-    source_position: Position[snx.NXsource, RunType],
 ) -> EmptyMonitor[RunType, MonitorType]:
     """
     Extract the data array corresponding to a monitor's signal field.
@@ -443,16 +445,16 @@ def get_calibrated_monitor(
     ----------
     monitor:
         NeXus monitor group.
+    transform:
+        Transformation matrix for the monitor.
     offset:
         Offset to add to the monitor position.
-    source_position:
-        Position of the neutron source.
     """
-    monitor = nexus.compute_component_position(monitor)
+    transform_unit = transform.value.unit
     return EmptyMonitor[RunType, MonitorType](
         nexus.extract_signal_data_array(monitor).assign_coords(
-            position=monitor['position'] + offset.to(unit=monitor['position'].unit),
-            source_position=source_position,
+            position=transform.value * sc.vector([0, 0, 0], unit=transform_unit)
+            + offset.to(unit=transform_unit),
         )
     )
 

{essreduce-25.12.0 → essreduce-26.1.0}/src/ess/reduce/normalization.py

@@ -2,7 +2,11 @@
 # Copyright (c) 2025 Scipp contributors (https://github.com/scipp)
 """Normalization routines for neutron data reduction."""
 
+from __future__ import annotations
+
+import enum
 import functools
+import warnings
 
 import scipp as sc
 
@@ -14,6 +18,7 @@ def normalize_by_monitor_histogram(
     *,
     monitor: sc.DataArray,
     uncertainty_broadcast_mode: UncertaintyBroadcastMode,
+    skip_range_check: bool = False,
 ) -> sc.DataArray:
     """Normalize detector data by a normalized histogrammed monitor.
 
@@ -23,10 +28,13 @@ def normalize_by_monitor_histogram(
     - For *event* detectors, the monitor values are mapped to the detector
       using :func:`scipp.lookup`. That is, for detector event :math:`d_i`,
       :math:`m_i` is the monitor bin value at the same coordinate.
-    - For *histogram* detectors, the monitor is rebinned using to the detector
+    - For *histogram* detectors, the monitor is generally rebinned using the detector
       binning using :func:`scipp.rebin`. Thus, detector value :math:`d_i` and
       monitor value :math:`m_i` correspond to the same bin.
 
+        - In case the detector coordinate does not have a dimension in common with the
+          monitor, :func:`scipp.lookup` is used as in the event case.
+
     In both cases, let :math:`x_i` be the lower bound of monitor bin :math:`i`
     and let :math:`\\Delta x_i = x_{i+1} - x_i` be the width of that bin.
 
@@ -47,6 +55,16 @@ def normalize_by_monitor_histogram(
         Must be one-dimensional and have a dimension coordinate, typically "wavelength".
     uncertainty_broadcast_mode:
         Choose how uncertainties of the monitor are broadcast to the sample data.
+    skip_range_check:
+        If false (default), the detector data must be within the range of the monitor
+        coordinate. Set this to true to disable the check.
+        The value of out-of-range bins / events is undefined in that case.
+
+        This is useful when the detector contains data outside the monitor range, and it
+        is difficult or impossible to slice the detector without also removing in-range
+        data. In this case, the caller can mask those data points and skip the range
+        check. ``normalize_by_monitor_histogram`` does not take masks into account when
+        checking ranges as that is expensive to implement in a general case.
 
     Returns
     -------
@@ -60,22 +78,45 @@ def normalize_by_monitor_histogram(
     normalize_by_monitor_integrated:
         Normalize by an integrated monitor.
     """
-    _check_monitor_range_contains_detector(monitor=monitor, detector=detector)
+    if not skip_range_check:
+        _check_monitor_range_contains_detector(monitor=monitor, detector=detector)
 
     dim = monitor.dim
 
-    if detector.bins is None:
-        monitor = monitor.rebin({dim: detector.coords[dim]})
-    detector = _mask_detector_for_norm(detector=detector, monitor=monitor)
-    coord = monitor.coords[dim]
-    delta_w = sc.DataArray(coord[1:] - coord[:-1], masks=monitor.masks)
-    norm = broadcast_uncertainties(
-        monitor / delta_w, prototype=detector, mode=uncertainty_broadcast_mode
-    )
-
-    if detector.bins is None:
-        return detector / norm.rebin({dim: detector.coords[dim]})
-    return detector.bins / sc.lookup(norm, dim=dim)
+    match _HistogramNormalizationMode.deduce(detector, dim):
+        case _HistogramNormalizationMode.Events:
+            detector = _mask_detector_for_norm(detector=detector, monitor=monitor)
+            norm = _histogram_monitor_term(
+                monitor,
+                dim,
+                broadcast_to=detector,
+                uncertainty_broadcast_mode=uncertainty_broadcast_mode,
+            )
+            if dim in detector.bins.coords:
+                return detector.bins / sc.lookup(norm, dim=dim)
+            else:
+                return detector / norm
+
+        case _HistogramNormalizationMode.BinsCommonDim:
+            monitor = monitor.rebin({dim: detector.coords[dim]})
+            detector = _mask_detector_for_norm(detector=detector, monitor=monitor)
+            norm = _histogram_monitor_term(
+                monitor,
+                dim,
+                broadcast_to=detector,
+                uncertainty_broadcast_mode=uncertainty_broadcast_mode,
+            )
+            return detector / norm
+
+        case _HistogramNormalizationMode.BinsDifferentDim:
+            detector = _mask_detector_for_norm(detector=detector, monitor=monitor)
+            # No broadcast here because there are no common dims, use lookup instead.
+            norm = _histogram_monitor_term(
+                monitor,
+                dim,
+                uncertainty_broadcast_mode=uncertainty_broadcast_mode,
+            )
+            return detector / sc.lookup(norm)[_compute_bin_centers(detector, dim)]
 
 
 def normalize_by_monitor_integrated(
@@ -83,6 +124,7 @@ def normalize_by_monitor_integrated(
     *,
     monitor: sc.DataArray,
     uncertainty_broadcast_mode: UncertaintyBroadcastMode,
+    skip_range_check: bool = False,
 ) -> sc.DataArray:
     """Normalize detector data by an integrated monitor.
 
@@ -113,6 +155,16 @@ def normalize_by_monitor_integrated(
         Must be one-dimensional and have a dimension coordinate, typically "wavelength".
     uncertainty_broadcast_mode:
         Choose how uncertainties of the monitor are broadcast to the sample data.
+    skip_range_check:
+        If false (default), the detector data must be within the range of the monitor
+        coordinate. Set this to true to disable the check.
+        The value of out-of-range bins / events is undefined in that case.
+
+        This is useful when the detector contains data outside the monitor range, and it
+        is difficult or impossible to slice the detector without also removing in-range
+        data. In this case, the caller can mask those data points and skip the range
+        check. ``normalize_by_monitor_histogram`` does not take masks into account when
+        checking ranges as that is expensive to implement in a general case.
 
     Returns
     -------
@@ -126,7 +178,8 @@ def normalize_by_monitor_integrated(
     normalize_by_monitor_histogram:
         Normalize by a monitor histogram.
     """
-    _check_monitor_range_contains_detector(monitor=monitor, detector=detector)
+    if not skip_range_check:
+        _check_monitor_range_contains_detector(monitor=monitor, detector=detector)
     detector = _mask_detector_for_norm(detector=detector, monitor=monitor)
     norm = monitor.nansum().data
     norm = broadcast_uncertainties(
@@ -149,15 +202,15 @@ def _check_monitor_range_contains_detector(
     # monitor range that is less than the detector bins which is fine for the events,
     # but would be wrong if the detector was subsequently histogrammed.
     if (det_coord := detector.coords.get(dim)) is not None:
-        lo = det_coord[dim, :-1].nanmin()
-        hi = det_coord[dim, 1:].nanmax()
+        ...
     elif (det_coord := detector.bins.coords.get(dim)) is not None:
-        lo = det_coord.nanmin()
-        hi = det_coord.nanmax()
+        ...
     else:
         raise sc.CoordError(
             f"Missing '{dim}' coordinate in detector for monitor normalization."
         )
+    lo = det_coord.nanmin()
+    hi = det_coord.nanmax()
 
     if monitor.coords[dim].min() > lo or monitor.coords[dim].max() < hi:
         raise ValueError(
@@ -181,13 +234,17 @@ def _mask_detector_for_norm(
     if (monitor_mask := _monitor_mask(monitor)) is None:
         return detector
 
-    if (detector_coord := detector.coords.get(monitor.dim)) is not None:
+    if (detector_coord := detector.coords.get(dim)) is not None:
         # Apply the mask to the bins or a dense detector.
-        # Use rebin to reshape the mask to the detector.
-        mask = sc.DataArray(monitor_mask, coords={dim: monitor.coords[dim]}).rebin(
-            {dim: detector_coord}
-        ).data != sc.scalar(0, unit=None)
-        return detector.assign_masks({"_monitor_mask": mask})
+        mask_da = sc.DataArray(monitor_mask, coords={dim: monitor.coords[dim]})
+        if dim in detector_coord.dims:
+            # Use rebin to reshape the mask to the detector.
+            mask = mask_da.rebin({dim: detector_coord}).data != sc.scalar(0, unit=None)
+            return detector.assign_masks(_monitor_mask=mask)
+        # else: need to use lookup to apply mask at matching coord elements
+        return detector.assign_masks(
+            _monitor_mask=sc.lookup(mask_da)[_compute_bin_centers(detector, dim)]
+        )
 
     # else: Apply the mask to the events.
     if dim not in detector.bins.coords:
@@ -197,7 +254,7 @@ def _mask_detector_for_norm(
     event_mask = sc.lookup(
         sc.DataArray(monitor_mask, coords={dim: monitor.coords[dim]})
     )[detector.bins.coords[dim]]
-    return detector.bins.assign_masks({"_monitor_mask": event_mask})
+    return detector.bins.assign_masks(_monitor_mask=event_mask)
 
 
 def _monitor_mask(monitor: sc.DataArray) -> sc.Variable | None:
@@ -213,3 +270,74 @@ def _monitor_mask(monitor: sc.DataArray) -> sc.Variable | None:
     if not masks:
         return None
     return functools.reduce(sc.logical_or, masks)
+
+
+def _histogram_monitor_term(
+    monitor: sc.DataArray,
+    dim: str,
+    *,
+    broadcast_to: sc.DataArray | None = None,
+    uncertainty_broadcast_mode: UncertaintyBroadcastMode,
+) -> sc.DataArray:
+    if not monitor.coords.is_edges(dim, dim):
+        raise sc.CoordError(
+            f"Monitor coordinage {dim} must be bin-edges for normalization."
+        )
+    coord = monitor.coords[dim]
+    delta_w = sc.DataArray(coord[1:] - coord[:-1], masks=monitor.masks)
+    norm = monitor / delta_w
+
+    if broadcast_to is not None:
+        return broadcast_uncertainties(
+            norm, prototype=broadcast_to, mode=uncertainty_broadcast_mode
+        )
+
+    match uncertainty_broadcast_mode:
+        case UncertaintyBroadcastMode.fail:
+            return norm
+        case UncertaintyBroadcastMode.drop:
+            return sc.values(norm)
+        case _:
+            warnings.warn(
+                "Cannot broadcast uncertainties in this case.",
+                UserWarning,
+                stacklevel=3,
+            )
+            return norm
+
+
+class _HistogramNormalizationMode(enum.Enum):
+    Events = enum.auto()
+    """Use an event coordinate to lookup monitor values."""
+    BinsCommonDim = enum.auto()
+    """Use a bin coordinate which contains the monitor dimension.
+
+    The coordinate may be multi-dimensional but one dimension matches
+    the dimension of the monitor.
+    """
+    BinsDifferentDim = enum.auto()
+    """Use a bin coordinate which does not contain the monitor dimension.
+
+    The coordinate may be multi-dimensions, e.g., in the DREAM powder workflow
+    where it has dims (two_theta, dspacing [bin-edges]).
+    """
+
+    @classmethod
+    def deduce(cls, detector: sc.DataArray, dim: str) -> _HistogramNormalizationMode:
+        # Use an event-coord when available:
+        if detector.bins is not None and dim in detector.bins.coords:
+            return _HistogramNormalizationMode.Events
+        # else: use a bin-coord.
+
+        det_coord = detector.coords[dim]
+        if dim in det_coord.dims:
+            return _HistogramNormalizationMode.BinsCommonDim
+        return _HistogramNormalizationMode.BinsDifferentDim
+
+
+def _compute_bin_centers(da: sc.DataArray, name: str) -> sc.Variable:
+    coord = da.coords[name]
+    for dim in coord.dims:
+        if da.coords.is_edges(name, dim):
+            coord = sc.midpoints(coord, dim=dim)
+    return coord

{essreduce-25.12.0 → essreduce-26.1.0}/src/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",

{essreduce-25.12.0 → essreduce-26.1.0}/src/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:
@@ -317,7 +317,19 @@ def _time_of_flight_data_events(
     parts = da.bins.constituents
     parts["data"] = tofs
     result = da.bins.assign_coords(tof=sc.bins(**parts, validate_indices=False))
-    return result.bins.drop_coords("event_time_offset")
+    out = result.bins.drop_coords("event_time_offset")
+
+    # The result may still have an 'event_time_zero' dimension (in the case of an
+    # event monitor where events were not grouped by pixel).
+    if "event_time_zero" in out.dims:
+        if ("event_time_zero" in out.coords) and (
+            "event_time_zero" not in out.bins.coords
+        ):
+            out.bins.coords["event_time_zero"] = sc.bins_like(
+                out, out.coords["event_time_zero"]
+            )
+        out = out.bins.concat("event_time_zero")
+    return out
 
 
 def detector_ltotal_from_straight_line_approximation(
@@ -357,6 +369,7 @@ def detector_ltotal_from_straight_line_approximation(
 
 def monitor_ltotal_from_straight_line_approximation(
     monitor_beamline: EmptyMonitor[RunType, MonitorType],
+    source_position: Position[snx.NXsource, RunType],
 ) -> MonitorLtotal[RunType, MonitorType]:
     """
     Compute Ltotal for the monitor.
@@ -369,7 +382,10 @@ def monitor_ltotal_from_straight_line_approximation(
         Beamline data for the monitor that contains the positions necessary to compute
         the straight-line approximation to Ltotal (source and monitor positions).
     """
-    graph = scn.conversion.graph.beamline.beamline(scatter=False)
+    graph = {
+        **scn.conversion.graph.beamline.beamline(scatter=False),
+        'source_position': lambda: source_position,
+    }
     return MonitorLtotal[RunType, MonitorType](
         monitor_beamline.transform_coords(
             "Ltotal", graph=graph, keep_intermediate=False
@@ -379,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:
@@ -397,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]:
@@ -431,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]:
@@ -465,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]:

{essreduce-25.12.0 → essreduce-26.1.0}/src/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
@@ -230,7 +230,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.
@@ -372,7 +372,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 +398,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.