Use new domain types from ESSreduce

Author: jl-wynen

docs/user-guide/offspec/offspec_reduction.ipynb

@@ -113,8 +113,8 @@
     "header.data_source.measurement = fileio.data_source.Measurement(\n",
     "    instrument_settings=fileio.data_source.InstrumentSettings(\n",
     "        incident_angle=fileio.base.Value(\n",
-    "            wf.compute(DetectorData[SampleRun]).coords[\"theta\"].value,\n",
-    "            wf.compute(DetectorData[SampleRun]).coords[\"theta\"].unit\n",
+    "            wf.compute(RawDetector[SampleRun]).coords[\"theta\"].value,\n",
+    "            wf.compute(RawDetector[SampleRun]).coords[\"theta\"].unit\n",
     "        ),\n",
     "        wavelength=None,\n",
     "        polarization=\"unpolarized\",\n",
@@ -183,8 +183,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "wf.compute(DetectorData[SampleRun]).hist(tof=50).plot(norm='log') \\\n",
-    "+ wf.compute(DetectorData[ReferenceRun]).hist(tof=50).plot(norm='log')"
+    "wf.compute(RawDetector[SampleRun]).hist(tof=50).plot(norm='log') \\\n",
+    "+ wf.compute(RawDetector[ReferenceRun]).hist(tof=50).plot(norm='log')"
    ]
   },
   {

src/ess/amor/__init__.py

@@ -14,8 +14,10 @@
     DetectorSpatialResolution,
     NeXusDetectorName,
     Position,
+    ReferenceRun,
     RunType,
     SampleRotationOffset,
+    SampleRun,
 )
 from . import (
     conversions,
@@ -81,7 +83,11 @@ def AmorWorkflow() -> sciline.Pipeline:
     """
     Workflow with default parameters for the Amor PSI instrument.
     """
-    return sciline.Pipeline(providers=providers, params=default_parameters())
+    return sciline.Pipeline(
+        providers=providers,
+        params=default_parameters(),
+        constraints={RunType: [SampleRun, ReferenceRun]},
+    )
 
 
 __all__ = [

src/ess/amor/load.py

@@ -10,14 +10,14 @@
 from ..reflectometry.types import (
     Beamline,
     BeamSize,
-    DetectorData,
     DetectorRotation,
     Filename,
     Measurement,
     NeXusComponent,
     NeXusDetectorName,
     ProtonCurrent,
     RawChopper,
+    RawDetector,
     RawSampleRotation,
     RunType,
     SampleRotation,
@@ -49,7 +49,7 @@ def load_events(
     chopper_separation: ChopperSeparation[RunType],
     sample_size: SampleSize[RunType],
     beam_size: BeamSize[RunType],
-) -> DetectorData[RunType]:
+) -> RawDetector[RunType]:
     event_data = detector["data"]
     if 'event_time_zero' in event_data.coords:
         event_data.bins.coords['event_time_zero'] = sc.bins_like(
@@ -77,7 +77,7 @@ def load_events(
     data.coords["chopper_distance"] = chopper_distance
     data.coords["sample_size"] = sample_size
     data.coords["beam_size"] = beam_size
-    return DetectorData[RunType](data)
+    return RawDetector[RunType](data)
 
 
 def amor_chopper(f: Filename[RunType]) -> RawChopper[RunType]:
@@ -133,13 +133,13 @@ def load_amor_proton_current(
     return pc
 
 
-def load_beamline_metadata(filename: Filename[SampleRun]) -> Beamline:
+def load_beamline_metadata(filename: Filename[RunType]) -> Beamline[RunType]:
     return nexus_workflow.load_beamline_metadata_from_nexus(
         NeXusFileSpec[SampleRun](filename)
     )
 
 
-def load_measurement_metadata(filename: Filename[SampleRun]) -> Measurement:
+def load_measurement_metadata(filename: Filename[RunType]) -> Measurement[RunType]:
     return nexus_workflow.load_measurement_metadata_from_nexus(
         NeXusFileSpec[SampleRun](filename)
     )

src/ess/amor/workflow.py

@@ -8,8 +8,8 @@
 from ..reflectometry.types import (
     BeamDivergenceLimits,
     CoordTransformationGraph,
-    DetectorData,
     ProtonCurrent,
+    RawDetector,
     ReducibleData,
     RunType,
     WavelengthBins,
@@ -20,7 +20,7 @@
 
 
 def add_coords_masks_and_apply_corrections(
-    da: DetectorData[RunType],
+    da: RawDetector[RunType],
     ylim: YIndexLimits,
     zlims: ZIndexLimits,
     bdlim: BeamDivergenceLimits,

src/ess/estia/corrections.py

@@ -11,8 +11,8 @@
 from ..reflectometry.types import (
     BeamDivergenceLimits,
     CoordTransformationGraph,
-    DetectorData,
     ProtonCurrent,
+    RawDetector,
     ReducibleData,
     RunType,
     WavelengthBins,
@@ -23,7 +23,7 @@
 
 
 def add_coords_masks_and_apply_corrections(
-    da: DetectorData[RunType],
+    da: RawDetector[RunType],
     ylim: YIndexLimits,
     zlims: ZIndexLimits,
     bdlim: BeamDivergenceLimits,

src/ess/estia/load.py

@@ -4,8 +4,8 @@
 import scipp as sc
 
 from ..reflectometry.types import (
-    DetectorData,
     Filename,
+    RawDetector,
     RunType,
     SampleRotationOffset,
 )
@@ -16,7 +16,7 @@
 def load_mcstas_events(
     filename: Filename[RunType],
     sample_rotation_offset: SampleRotationOffset[RunType],
-) -> DetectorData[RunType]:
+) -> RawDetector[RunType]:
     """
     Load event data from a McStas run and reshape it
     to look like what we would expect if
@@ -96,7 +96,7 @@ def load_mcstas_events(
     )
     da.bins.coords.pop('L')
     da.bins.coords.pop('t')
-    return DetectorData[RunType](da)
+    return RawDetector[RunType](da)
 
 
 providers = ()

src/ess/estia/workflow.py

@@ -10,8 +10,10 @@
     BeamDivergenceLimits,
     DetectorSpatialResolution,
     NeXusDetectorName,
+    ReferenceRun,
     RunType,
     SampleRotationOffset,
+    SampleRun,
 )
 from . import beamline, conversions, corrections, load, maskings, normalization, orso
 
@@ -66,7 +68,9 @@ def default_parameters() -> dict:
 def EstiaMcStasWorkflow() -> sciline.Pipeline:
     """Workflow for reduction of McStas data for the Estia instrument."""
     return sciline.Pipeline(
-        providers=mcstas_providers, params=mcstas_default_parameters()
+        providers=mcstas_providers,
+        params=mcstas_default_parameters(),
+        constraints={RunType: [SampleRun, ReferenceRun]},
     )
 
 

src/ess/offspec/load.py

@@ -2,13 +2,13 @@
 # Copyright (c) 2025 Scipp contributors (https://github.com/scipp)
 import scipp as sc
 
-from ..reflectometry.types import DetectorData, Filename, ReferenceRun, RunType
+from ..reflectometry.types import Filename, RawDetector, ReferenceRun, RunType
 from .types import CoordTransformationGraph, MonitorData, NeXusMonitorName
 
 
 def load_offspec_events(
     filename: Filename[RunType],
-) -> DetectorData[RunType]:
+) -> RawDetector[RunType]:
     full = sc.io.load_hdf5(filename)
     da = full['data']
     da.coords['theta'] = full.pop('Theta')[-1].data

src/ess/offspec/types.py

@@ -4,6 +4,7 @@
 
 import sciline
 import scipp as sc
+import scippnexus as snx
 
 from ess.reduce.nexus import types as reduce_t
 
@@ -21,4 +22,4 @@ class MonitorData(sciline.Scope[RunType, sc.DataArray], sc.DataArray):
     """ "Monitor data from the run file, with background subtracted"""
 
 
-NeXusMonitorName = reduce_t.NeXusName
+NeXusMonitorName = reduce_t.NeXusName[snx.NXmonitor]

src/ess/offspec/workflow.py

@@ -4,9 +4,11 @@
 
 from ..reflectometry import providers as reflectometry_providers
 from ..reflectometry.types import (
-    DetectorData,
+    RawDetector,
     ReducibleData,
+    ReferenceRun,
     RunType,
+    SampleRun,
     WavelengthBins,
 )
 from . import conversions, load, maskings, normalization
@@ -33,11 +35,15 @@ def OffspecWorkflow() -> sciline.Pipeline:
         *maskings.providers,
         *normalization.providers,
     )
-    return sciline.Pipeline(providers=ps, params={NeXusMonitorName: 'monitor2'})
+    return sciline.Pipeline(
+        providers=ps,
+        params={NeXusMonitorName: 'monitor2'},
+        constraints={RunType: [SampleRun, ReferenceRun]},
+    )
 
 
 def add_coords_masks_and_apply_corrections(
-    da: DetectorData[RunType],
+    da: RawDetector[RunType],
     spectrum_limits: SpectrumLimits,
     wlims: WavelengthBins,
     wbmin: BackgroundMinWavelength,