Use custom run and monitor types

Author: jl-wynen

docs/user-guide/dream/dream-advanced-powder-reduction.ipynb

@@ -56,12 +56,12 @@
     "\n",
     "workflow[Filename[SampleRun]] = dream.data.simulated_diamond_sample()\n",
     "workflow[Filename[VanadiumRun]] = dream.data.simulated_vanadium_sample()\n",
-    "workflow[Filename[BackgroundRun]] = dream.data.simulated_empty_can()\n",
+    "workflow[Filename[EmptyCanRun]] = dream.data.simulated_empty_can()\n",
     "workflow[CalibrationFilename] = None\n",
     "\n",
     "workflow[MonitorFilename[SampleRun]] = dream.data.simulated_monitor_diamond_sample()\n",
     "workflow[MonitorFilename[VanadiumRun]] = dream.data.simulated_monitor_vanadium_sample()\n",
-    "workflow[MonitorFilename[BackgroundRun]] = dream.data.simulated_monitor_empty_can()\n",
+    "workflow[MonitorFilename[EmptyCanRun]] = dream.data.simulated_monitor_empty_can()\n",
     "workflow[CaveMonitorPosition] = sc.vector([0.0, 0.0, -4220.0], unit=\"mm\")\n",
     "\n",
     "workflow[dream.InstrumentConfiguration] = dream.InstrumentConfiguration.high_flux\n",
@@ -174,12 +174,12 @@
     "\n",
     "workflow[Filename[SampleRun]] = dream.data.simulated_diamond_sample()\n",
     "workflow[Filename[VanadiumRun]] = dream.data.simulated_vanadium_sample()\n",
-    "workflow[Filename[BackgroundRun]] = dream.data.simulated_empty_can()\n",
+    "workflow[Filename[EmptyCanRun]] = dream.data.simulated_empty_can()\n",
     "workflow[CalibrationFilename] = None\n",
     "\n",
     "workflow[MonitorFilename[SampleRun]] = dream.data.simulated_monitor_diamond_sample()\n",
     "workflow[MonitorFilename[VanadiumRun]] = dream.data.simulated_monitor_vanadium_sample()\n",
-    "workflow[MonitorFilename[BackgroundRun]] = dream.data.simulated_monitor_empty_can()\n",
+    "workflow[MonitorFilename[EmptyCanRun]] = dream.data.simulated_monitor_empty_can()\n",
     "workflow[CaveMonitorPosition] = sc.vector([0.0, 0.0, -4220.0], unit=\"mm\")\n",
     "\n",
     "workflow[dream.InstrumentConfiguration] = dream.InstrumentConfiguration.high_flux\n",
@@ -254,7 +254,7 @@
     "\n",
     "workflow[Filename[SampleRun]] = dream.data.simulated_diamond_sample()\n",
     "workflow[Filename[VanadiumRun]] = dream.data.simulated_vanadium_sample()\n",
-    "workflow[Filename[BackgroundRun]] = dream.data.simulated_empty_can()\n",
+    "workflow[Filename[EmptyCanRun]] = dream.data.simulated_empty_can()\n",
     "workflow[CalibrationFilename] = None\n",
     "\n",
     "workflow[dream.InstrumentConfiguration] = dream.InstrumentConfiguration.high_flux\n",
@@ -374,7 +374,7 @@
     "\n",
     "workflow[Filename[SampleRun]] = dream.data.simulated_diamond_sample()\n",
     "workflow[Filename[VanadiumRun]] = dream.data.simulated_vanadium_sample()\n",
-    "workflow[Filename[BackgroundRun]] = dream.data.simulated_empty_can()\n",
+    "workflow[Filename[EmptyCanRun]] = dream.data.simulated_empty_can()\n",
     "workflow[CalibrationFilename] = None\n",
     "\n",
     "workflow[dream.InstrumentConfiguration] = dream.InstrumentConfiguration.high_flux\n",

docs/user-guide/dream/dream-powder-reduction.ipynb

@@ -79,12 +79,12 @@
    "source": [
     "workflow[Filename[SampleRun]] = dream.data.simulated_diamond_sample()\n",
     "workflow[Filename[VanadiumRun]] = dream.data.simulated_vanadium_sample()\n",
-    "workflow[Filename[BackgroundRun]] = dream.data.simulated_empty_can()\n",
+    "workflow[Filename[EmptyCanRun]] = dream.data.simulated_empty_can()\n",
     "workflow[CalibrationFilename] = None\n",
     "\n",
     "workflow[MonitorFilename[SampleRun]] = dream.data.simulated_monitor_diamond_sample()\n",
     "workflow[MonitorFilename[VanadiumRun]] = dream.data.simulated_monitor_vanadium_sample()\n",
-    "workflow[MonitorFilename[BackgroundRun]] = dream.data.simulated_monitor_empty_can()\n",
+    "workflow[MonitorFilename[EmptyCanRun]] = dream.data.simulated_monitor_empty_can()\n",
     "workflow[CaveMonitorPosition] = sc.vector([0.0, 0.0, -4220.0], unit=\"mm\")\n",
     "\n",
     "workflow[dream.InstrumentConfiguration] = dream.InstrumentConfiguration.high_flux\n",

src/ess/dream/io/cif.py

@@ -71,7 +71,7 @@ def prepare_reduced_empty_can_subtracted_tof_cif(
     authors: CIFAuthors,
     beamline: Beamline,
     source: Source,
-    reducers: ReducerSoftwares,
+    reducers: ReducerSoftware,
     calibration: OutputCalibrationData,
 ) -> ReducedEmptyCanSubtractedTofCIF:
     """Construct a CIF builder with reduced data in d-spacing.
@@ -117,7 +117,7 @@ def _prepare_reduced_tof_cif_impl(
     authors: CIFAuthors,
     beamline: Beamline,
     source: Source,
-    reducers: ReducerSoftwares,
+    reducers: ReducerSoftware,
     calibration: OutputCalibrationData,
 ) -> ReducedTofCIF:
     to_save = _prepare_data(da)

src/ess/dream/io/geant4.py

@@ -8,7 +8,6 @@
 from scippneutron.metadata import ESS_SOURCE
 
 from ess.powder.types import (
-    BackgroundRun,
     Beamline,
     CalibratedBeamline,
     CalibratedDetector,
@@ -18,6 +17,7 @@
     CaveMonitor,
     CaveMonitorPosition,
     DetectorData,
+    EmptyCanRun,
     Filename,
     MonitorData,
     MonitorFilename,
@@ -321,7 +321,7 @@ def LoadGeant4Workflow() -> sciline.Pipeline:
     Workflow for loading NeXus data.
     """
     wf = GenericTofWorkflow(
-        run_types=[SampleRun, VanadiumRun, BackgroundRun], monitor_types=[CaveMonitor]
+        run_types=[SampleRun, VanadiumRun, EmptyCanRun], monitor_types=[CaveMonitor]
     )
     wf.insert(extract_geant4_detector)
     wf.insert(load_geant4_csv)

src/ess/dream/io/nexus.py

@@ -15,7 +15,13 @@
 
 import sciline
 
-from ess.powder.types import BunkerMonitor, CaveMonitor
+from ess.powder.types import (
+    BunkerMonitor,
+    CaveMonitor,
+    EmptyCanRun,
+    SampleRun,
+    VanadiumRun,
+)
 from ess.reduce.nexus.types import DetectorBankSizes, NeXusName
 from ess.reduce.nexus.workflow import GenericNeXusWorkflow
 
@@ -50,7 +56,10 @@ def LoadNeXusWorkflow() -> sciline.Pipeline:
     """
     Workflow for loading NeXus data.
     """
-    wf = GenericNeXusWorkflow()
+    wf = GenericNeXusWorkflow(
+        run_types=(SampleRun, VanadiumRun, EmptyCanRun),
+        monitor_types=(BunkerMonitor, CaveMonitor),
+    )
     wf[DetectorBankSizes] = DETECTOR_BANK_SIZES
     wf[NeXusName[BunkerMonitor]] = "monitor_bunker"
     wf[NeXusName[CaveMonitor]] = "monitor_cave"

src/ess/dream/parameters.py

@@ -5,9 +5,9 @@
 from __future__ import annotations
 
 from ess.powder.types import (
-    BackgroundRun,
     CalibrationFilename,
     DspacingBins,
+    EmptyCanRun,
     Filename,
     IofDspacing,
     IofDspacingTwoTheta,
@@ -36,8 +36,8 @@
 parameter_registry[Filename[VanadiumRun]] = FilenameParameter.from_type(
     Filename[VanadiumRun]
 )
-parameter_registry[Filename[BackgroundRun]] = FilenameParameter.from_type(
-    Filename[BackgroundRun]
+parameter_registry[Filename[EmptyCanRun]] = FilenameParameter.from_type(
+    Filename[EmptyCanRun]
 )
 parameter_registry[CalibrationFilename] = FilenameParameter.from_type(
     CalibrationFilename

src/ess/dream/workflow.py

@@ -19,8 +19,8 @@
 )
 from ess.powder.types import (
     AccumulatedProtonCharge,
-    BackgroundRun,
     CaveMonitorPosition,  # Should this be a DREAM-only parameter?
+    EmptyCanRun,
     MonitorType,
     PixelMaskFilename,
     Position,
@@ -81,13 +81,13 @@ def default_parameters() -> dict:
     return {
         Position[snx.NXsample, SampleRun]: sample_position,
         Position[snx.NXsample, VanadiumRun]: sample_position,
-        Position[snx.NXsample, BackgroundRun]: sample_position,
+        Position[snx.NXsample, EmptyCanRun]: sample_position,
         Position[snx.NXsource, SampleRun]: source_position,
         Position[snx.NXsource, VanadiumRun]: source_position,
-        Position[snx.NXsource, BackgroundRun]: source_position,
+        Position[snx.NXsource, EmptyCanRun]: source_position,
         AccumulatedProtonCharge[SampleRun]: charge,
         AccumulatedProtonCharge[VanadiumRun]: charge,
-        AccumulatedProtonCharge[BackgroundRun]: charge,
+        AccumulatedProtonCharge[EmptyCanRun]: charge,
         TofMask: None,
         WavelengthMask: None,
         TwoThetaMask: None,

src/ess/powder/correction.py

@@ -13,9 +13,9 @@
 from ._util import event_or_outer_coord
 from .types import (
     AccumulatedProtonCharge,
-    BackgroundRun,
     CaveMonitor,
     DataWithScatteringCoordinates,
+    EmptyCanRun,
     EmptyCanSubtractedIofDspacing,
     EmptyCanSubtractedIofDspacingTwoTheta,
     FocussedDataDspacing,
@@ -342,16 +342,16 @@ def _shallow_copy(da: sc.DataArray) -> sc.DataArray:
     return out
 
 
-def subtract_background(
+def subtract_empty_can(
     data: IofDspacing[SampleRun],
-    background: IofDspacing[BackgroundRun],
+    background: IofDspacing[EmptyCanRun],
 ) -> EmptyCanSubtractedIofDspacing[SampleRun]:
     return EmptyCanSubtractedIofDspacing(data.bins.concatenate(-background))
 
 
-def subtract_background_two_theta(
+def subtract_empty_can_two_theta(
     data: IofDspacingTwoTheta[SampleRun],
-    background: IofDspacingTwoTheta[BackgroundRun],
+    background: IofDspacingTwoTheta[EmptyCanRun],
 ) -> EmptyCanSubtractedIofDspacingTwoTheta[SampleRun]:
     return EmptyCanSubtractedIofDspacingTwoTheta(data.bins.concatenate(-background))
 
@@ -381,7 +381,7 @@ def insert_run_normalization(
     normalize_by_proton_charge,
     normalize_by_vanadium_dspacing,
     normalize_by_vanadium_dspacing_and_two_theta,
-    subtract_background,
-    subtract_background_two_theta,
+    subtract_empty_can,
+    subtract_empty_can_two_theta,
 )
 """Sciline providers for powder diffraction corrections."""

src/ess/powder/types.py

@@ -20,27 +20,18 @@
 from ess.reduce.time_of_flight import types as tof_t
 from ess.reduce.uncertainty import UncertaintyBroadcastMode as _UncertaintyBroadcastMode
 
-# 1 TypeVars used to parametrize the generic parts of the workflow
-
-BackgroundRun = reduce_t.BackgroundRun
-BunkerMonitor = reduce_t.Monitor2
 CalibratedBeamline = reduce_t.CalibratedBeamline
 CalibratedDetector = reduce_t.CalibratedDetector
-CalibratedBeamline = reduce_t.CalibratedBeamline
 CalibratedMonitor = reduce_t.CalibratedMonitor
 DetectorData = reduce_t.DetectorData
 DetectorPositionOffset = reduce_t.DetectorPositionOffset
-EmptyBeamRun = reduce_t.EmptyBeamRun
 Filename = reduce_t.Filename
-CaveMonitor = reduce_t.Monitor1
 MonitorData = reduce_t.MonitorData
 MonitorPositionOffset = reduce_t.MonitorPositionOffset
 NeXusDetectorName = reduce_t.NeXusDetectorName
 NeXusMonitorName = reduce_t.NeXusName
 NeXusComponent = reduce_t.NeXusComponent
-SampleRun = reduce_t.SampleRun
 Position = reduce_t.Position
-VanadiumRun = reduce_t.VanadiumRun
 
 DetectorBankSizes = reduce_t.DetectorBankSizes
 
@@ -58,20 +49,23 @@
 TimeOfFlightLookupTableFilename = tof_t.TimeOfFlightLookupTableFilename
 SimulationResults = tof_t.SimulationResults
 
-RunType = TypeVar("RunType", SampleRun, VanadiumRun, BackgroundRun)
-MonitorType = TypeVar("MonitorType", CaveMonitor, BunkerMonitor)
+SampleRun = reduce_t.SampleRun
+VanadiumRun = reduce_t.VanadiumRun
+EmptyCanRun = NewType("EmptyCanRun", int)
+
+CaveMonitor = reduce_t.CaveMonitor
+BunkerMonitor = NewType("BunkerMonitor", int)
 
+RunType = TypeVar("RunType", SampleRun, VanadiumRun, EmptyCanRun)
+MonitorType = TypeVar("MonitorType", CaveMonitor, BunkerMonitor)
 
-# 2 Workflow parameters
 
 CalibrationFilename = NewType("CalibrationFilename", str | None)
 """Filename of the instrument calibration file."""
 
-
 DspacingBins = NewType("DspacingBins", sc.Variable)
 """Bin edges for d-spacing."""
 
-
 OutFilename = NewType("OutFilename", str)
 """Filename of the output."""
 

tests/dream/geant4_reduction_test.py

@@ -21,13 +21,13 @@
 )
 from ess.powder.types import (
     AccumulatedProtonCharge,
-    BackgroundRun,
     CalibrationFilename,
     CaveMonitorPosition,
     CIFAuthors,
     DistanceResolution,
     DspacingBins,
     DspacingData,
+    EmptyCanRun,
     EmptyCanSubtractedIofDspacing,
     Filename,
     FocussedDataDspacing,
@@ -64,10 +64,10 @@
 params = {
     Filename[SampleRun]: dream.data.simulated_diamond_sample(small=True),
     Filename[VanadiumRun]: dream.data.simulated_vanadium_sample(small=True),
-    Filename[BackgroundRun]: dream.data.simulated_empty_can(small=True),
+    Filename[EmptyCanRun]: dream.data.simulated_empty_can(small=True),
     MonitorFilename[SampleRun]: dream.data.simulated_monitor_diamond_sample(),
     MonitorFilename[VanadiumRun]: dream.data.simulated_monitor_vanadium_sample(),
-    MonitorFilename[BackgroundRun]: dream.data.simulated_monitor_empty_can(),
+    MonitorFilename[EmptyCanRun]: dream.data.simulated_monitor_empty_can(),
     dream.InstrumentConfiguration: dream.beamline.InstrumentConfiguration.high_flux,
     CalibrationFilename: None,
     UncertaintyBroadcastMode: UncertaintyBroadcastMode.drop,
@@ -122,8 +122,8 @@ def test_pipeline_can_compute_dspacing_result(workflow):
 
 
 def test_pipeline_can_compute_dspacing_result_without_empty_can(workflow):
-    workflow[Filename[BackgroundRun]] = None
-    workflow[MonitorFilename[BackgroundRun]] = None
+    workflow[Filename[EmptyCanRun]] = None
+    workflow[MonitorFilename[EmptyCanRun]] = None
     workflow = powder.with_pixel_mask_filenames(workflow, [])
     result = workflow.compute(IofDspacing[SampleRun])
     assert result.sizes == {'dspacing': len(params[DspacingBins]) - 1}
@@ -352,4 +352,4 @@ def test_dream_workflow_parameters_returns_filtered_params():
     wf = DreamGeant4ProtonChargeWorkflow()
     parameters = reduce_workflow.get_parameters(wf, (DspacingData[SampleRun],))
     assert Filename[SampleRun] in parameters
-    assert Filename[BackgroundRun] not in parameters
+    assert Filename[EmptyCanRun] not in parameters