Remove CalibratedBeamline

Author: jl-wynen

src/ess/reduce/nexus/types.py

@@ -203,10 +203,6 @@ class EmptyDetector(sciline.Scope[RunType, sc.DataArray], sc.DataArray):
     """Detector without neutron data."""
 
 
-class CalibratedBeamline(sciline.Scope[RunType, sc.DataArray], sc.DataArray):
-    """Calibrated beamline with detector and other components."""
-
-
 class EmptyMonitor(sciline.Scope[RunType, MonitorType, sc.DataArray], sc.DataArray):
     """Monitor without neutron data."""
 

src/ess/reduce/nexus/workflow.py

@@ -20,7 +20,6 @@
     COMPONENT_CONSTRAINTS,
     AllNeXusComponents,
     Beamline,
-    CalibratedBeamline,
     Component,
     DetectorBankSizes,
     DetectorPositionOffset,
@@ -364,9 +363,7 @@ def get_calibrated_detector(
     """
     Extract the data array corresponding to a detector's signal field.
 
-    The returned data array includes coords and masks pertaining directly to the
-    signal values array, but not additional information about the detector. The
-    data array is reshaped to the logical detector shape, which by folding the data
+    The data array is reshaped to the logical detector shape, by folding the data
     array along the detector_number dimension.
 
     Parameters
@@ -400,43 +397,8 @@ def get_calibrated_detector(
     )
 
 
-def assemble_beamline(
-    detector: EmptyDetector[RunType],
-    source_position: Position[snx.NXsource, RunType],
-    sample_position: Position[snx.NXsample, RunType],
-    gravity: GravityVector,
-) -> CalibratedBeamline[RunType]:
-    """
-    Add beamline information (gravity vector, source- and sample-position) to detector.
-
-    This is performed separately and after :py:func:`get_calibrated_detector` to avoid
-    as false dependency of, e.g., the reshaped detector numbers on the sample position.
-    The latter can change during a run, e.g., for a rotating sample. The detector
-    numbers might be used, e.g., to mask certain detector pixels, and should not depend
-    on the sample position.
-
-    Parameters
-    ----------
-    detector:
-        NeXus detector group.
-    source_position:
-        Position of the neutron source.
-    sample_position:
-        Position of the sample.
-    gravity:
-        Gravity vector.
-    """
-    return CalibratedBeamline[RunType](
-        detector.assign_coords(
-            source_position=source_position,
-            sample_position=sample_position,
-            gravity=gravity,
-        )
-    )
-
-
 def assemble_detector_data(
-    detector: CalibratedBeamline[RunType],
+    detector: EmptyDetector[RunType],
     event_data: NeXusData[snx.NXdetector, RunType],
 ) -> RawDetector[RunType]:
     """
@@ -655,7 +617,6 @@ def load_measurement_metadata_from_nexus(
     no_detector_position_offset,
     load_nexus_sample,
     get_calibrated_detector,
-    assemble_beamline,
     assemble_detector_data,
 )
 

src/ess/reduce/time_of_flight/eto_to_tof.py

@@ -12,6 +12,7 @@
 import numpy as np
 import scipp as sc
 import scippneutron as scn
+import scippnexus as snx
 from scippneutron._utils import elem_unit
 
 try:
@@ -20,9 +21,11 @@
     from .interpolator_scipy import Interpolator as InterpolatorImpl
 
 from ..nexus.types import (
-    CalibratedBeamline,
+    EmptyDetector,
     EmptyMonitor,
+    GravityVector,
     MonitorType,
+    Position,
     RawDetector,
     RawMonitor,
     RunType,
@@ -271,23 +274,35 @@ def _time_of_flight_data_events(
 
 
 def detector_ltotal_from_straight_line_approximation(
-    detector_beamline: CalibratedBeamline[RunType],
+    detector: EmptyDetector[RunType],
+    source_position: Position[snx.NXsource, RunType],
+    sample_position: Position[snx.NXsample, RunType],
+    gravity: GravityVector,
 ) -> DetectorLtotal[RunType]:
-    """
-    Compute Ltotal for the detector pixels.
+    """Compute Ltotal for the detector pixels.
+
     This is a naive straight-line approximation to Ltotal based on basic component
     positions.
 
     Parameters
     ----------
-    detector_beamline:
-        Beamline data for the detector that contains the positions necessary to compute
-        the straight-line approximation to Ltotal (source, sample, and detector
-        positions).
+    detector:
+        Data array with detector positions.
+    source_position:
+        Position of the neutron source.
+    sample_position:
+        Position of the sample.
+    gravity:
+        Gravity vector.
     """
-    graph = scn.conversion.graph.beamline.beamline(scatter=True)
+    graph = {
+        **scn.conversion.graph.beamline.beamline(scatter=True),
+        'source_position': lambda: source_position,
+        'sample_position': lambda: sample_position,
+        'gravity': lambda: gravity,
+    }
     return DetectorLtotal[RunType](
-        detector_beamline.transform_coords(
+        detector.transform_coords(
             "Ltotal", graph=graph, keep_intermediate=False
         ).coords["Ltotal"]
     )

tests/nexus/workflow_test.py

@@ -581,8 +581,6 @@ def test_load_detector_workflow(loki_tutorial_sample_run_60250: Path) -> None:
     wf[NeXusName[snx.NXdetector]] = 'larmor_detector'
     da = wf.compute(RawDetector[SampleRun])
     assert 'position' in da.coords
-    assert 'sample_position' in da.coords
-    assert 'source_position' in da.coords
     assert da.bins is not None
     assert da.dims == ('detector_number',)
 
@@ -598,8 +596,6 @@ def test_generic_nexus_workflow(
     wf[PreopenNeXusFile] = preopen
     da = wf.compute(RawDetector[SampleRun])
     assert 'position' in da.coords
-    assert 'sample_position' in da.coords
-    assert 'source_position' in da.coords
     assert da.bins is not None
     assert da.dims == ('detector_number',)
     da = wf.compute(RawMonitor[SampleRun, FrameMonitor1])

tests/time_of_flight/workflow_test.py

@@ -10,9 +10,10 @@
 from ess.reduce import time_of_flight
 from ess.reduce.nexus.types import (
     AnyRun,
-    CalibratedBeamline,
     DiskChoppers,
+    EmptyDetector,
     NeXusData,
+    Position,
     RawDetector,
     SampleRun,
 )
@@ -77,8 +78,11 @@ def test_GenericTofWorkflow_with_tof_lut_from_tof_simulation(
     calibrated_beamline: sc.DataArray, nexus_data: sc.DataArray
 ):
     wf = GenericTofWorkflow(run_types=[SampleRun], monitor_types=[])
-    wf[CalibratedBeamline[SampleRun]] = calibrated_beamline
+    wf[EmptyDetector[SampleRun]] = calibrated_beamline
     wf[NeXusData[snx.NXdetector, SampleRun]] = nexus_data
+    # Unused because calibrated_beamline contains Ltotal but needed by wf structure
+    wf[Position[snx.NXsample, SampleRun]] = sc.vector([1e10, 1e10, 1e10], unit='m')
+    wf[Position[snx.NXsource, SampleRun]] = sc.vector([1e10, 1e10, 1e10], unit='m')
 
     # Should be able to compute DetectorData without chopper and simulation params
     # This contains event_time_offset (time-of-arrival).
@@ -122,11 +126,14 @@ def test_GenericTofWorkflow_with_tof_lut_from_file(
     lut.save_hdf5(filename=tmp_path / "lut.h5")
 
     wf = GenericTofWorkflow(run_types=[SampleRun], monitor_types=[])
-    wf[CalibratedBeamline[SampleRun]] = calibrated_beamline
+    wf[EmptyDetector[SampleRun]] = calibrated_beamline
     wf[NeXusData[snx.NXdetector, SampleRun]] = nexus_data
     wf[time_of_flight.TimeOfFlightLookupTableFilename] = (
         tmp_path / "lut.h5"
     ).as_posix()
+    # Unused because calibrated_beamline contains Ltotal but needed by wf structure
+    wf[Position[snx.NXsample, SampleRun]] = sc.vector([1e10, 1e10, 1e10], unit='m')
+    wf[Position[snx.NXsource, SampleRun]] = sc.vector([1e10, 1e10, 1e10], unit='m')
 
     loaded_lut = wf.compute(time_of_flight.TimeOfFlightLookupTable)
     assert_identical(lut, loaded_lut)