Properly use generic DiskChoppers

Author: jl-wynen

docs/user-guide/tof/dream.ipynb

@@ -24,7 +24,7 @@
     "import plopp as pp\n",
     "import scipp as sc\n",
     "from scippneutron.chopper import DiskChopper\n",
-    "from ess.reduce.nexus.types import DetectorData, SampleRun\n",
+    "from ess.reduce.nexus.types import AnyRun, DetectorData, SampleRun\n",
     "from ess.reduce.time_of_flight import *"
    ]
   },
@@ -340,7 +340,7 @@
    "outputs": [],
    "source": [
     "lut_wf = TofLookupTableWorkflow()\n",
-    "lut_wf[DiskChoppers] = disk_choppers\n",
+    "lut_wf[DiskChoppers[AnyRun]] = disk_choppers\n",
     "lut_wf[SourcePosition] = source_position\n",
     "lut_wf[LtotalRange] = (\n",
     "    sc.scalar(75.5, unit=\"m\"),\n",
@@ -713,7 +713,7 @@
    "outputs": [],
    "source": [
     "# Update workflow\n",
-    "lut_wf[DiskChoppers] = disk_choppers\n",
+    "lut_wf[DiskChoppers[AnyRun]] = disk_choppers\n",
     "\n",
     "sim = lut_wf.compute(SimulationResults)\n",
     "\n",

docs/user-guide/tof/frame-unwrapping.ipynb

@@ -32,7 +32,7 @@
     "import plopp as pp\n",
     "import scipp as sc\n",
     "from scippneutron.chopper import DiskChopper\n",
-    "from ess.reduce.nexus.types import DetectorData, SampleRun\n",
+    "from ess.reduce.nexus.types import AnyRun, DetectorData, SampleRun\n",
     "from ess.reduce.time_of_flight import *\n",
     "import tof\n",
     "\n",
@@ -212,7 +212,7 @@
    "source": [
     "lut_wf = TofLookupTableWorkflow()\n",
     "lut_wf[LtotalRange] = detectors[0].distance, detectors[-1].distance\n",
-    "lut_wf[DiskChoppers] = {\n",
+    "lut_wf[DiskChoppers[AnyRun]] = {\n",
     "    \"chopper\": DiskChopper(\n",
     "        frequency=-chopper.frequency,\n",
     "        beam_position=sc.scalar(0.0, unit=\"deg\"),\n",
@@ -399,7 +399,7 @@
     "lut_wf = TofLookupTableWorkflow()\n",
     "lut_wf[PulseStride] = 2\n",
     "lut_wf[LtotalRange] = detectors[0].distance, detectors[-1].distance\n",
-    "lut_wf[DiskChoppers] = {\n",
+    "lut_wf[DiskChoppers[AnyRun]] = {\n",
     "    ch.name: DiskChopper(\n",
     "        frequency=-ch.frequency,\n",
     "        beam_position=sc.scalar(0.0, unit=\"deg\"),\n",

docs/user-guide/tof/wfm.ipynb

@@ -25,7 +25,7 @@
     "import plopp as pp\n",
     "import scipp as sc\n",
     "from scippneutron.chopper import DiskChopper\n",
-    "from ess.reduce.nexus.types import DetectorData, SampleRun\n",
+    "from ess.reduce.nexus.types import AnyRun, DetectorData, SampleRun\n",
     "from ess.reduce.time_of_flight import *"
    ]
   },
@@ -361,7 +361,7 @@
    "outputs": [],
    "source": [
     "lut_wf = TofLookupTableWorkflow()\n",
-    "lut_wf[DiskChoppers] = disk_choppers\n",
+    "lut_wf[DiskChoppers[AnyRun]] = disk_choppers\n",
     "lut_wf[SourcePosition] = source_position\n",
     "lut_wf[LtotalRange] = Ltotal, Ltotal\n",
     "lut_wf[LookupTableRelativeErrorThreshold] = 0.1\n",

src/ess/reduce/nexus/types.py

@@ -40,6 +40,14 @@
 # 1  TypeVars used to parametrize the generic parts of the workflow
 
 # 1.1  Run types
+
+AnyRun = NewType("AnyRun", int)
+"""RunType that does not represent a specific measurement run.
+
+This can be used in cases where it makes no sense to use an 'actual' run type
+like ``SampleRun`` or ``BackgroundRun``.
+"""
+
 BackgroundRun = NewType('BackgroundRun', int)
 """Background run such as a run with only a solvent which the sample is placed in."""
 EmptyBeamRun = NewType('EmptyBeamRun', int)

src/ess/reduce/time_of_flight/lut.py

@@ -12,7 +12,7 @@
 import sciline as sl
 import scipp as sc
 
-from ..nexus.types import DiskChoppers
+from ..nexus.types import AnyRun, DiskChoppers
 from .types import TimeOfFlightLookupTable
 
 
@@ -380,7 +380,7 @@ def make_tof_lookup_table(
 
 
 def simulate_chopper_cascade_using_tof(
-    choppers: DiskChoppers,
+    choppers: DiskChoppers[AnyRun],
     source_position: SourcePosition,
     neutrons: NumberOfSimulatedNeutrons,
     pulse_stride: PulseStride,

tests/time_of_flight/lut_test.py

@@ -4,14 +4,15 @@
 import scipp as sc
 
 from ess.reduce import time_of_flight
+from ess.reduce.nexus.types import AnyRun
 from ess.reduce.time_of_flight import TofLookupTableWorkflow
 
 sl = pytest.importorskip("sciline")
 
 
 def test_lut_workflow_computes_table():
     wf = TofLookupTableWorkflow()
-    wf[time_of_flight.DiskChoppers] = {}
+    wf[time_of_flight.DiskChoppers[AnyRun]] = {}
     wf[time_of_flight.SourcePosition] = sc.vector([0, 0, 0], unit='m')
     wf[time_of_flight.NumberOfSimulatedNeutrons] = 100_000
     wf[time_of_flight.SimulationSeed] = 60
@@ -40,7 +41,7 @@ def test_lut_workflow_computes_table():
 
 def test_lut_workflow_computes_table_in_chunks():
     wf = TofLookupTableWorkflow()
-    wf[time_of_flight.DiskChoppers] = {}
+    wf[time_of_flight.DiskChoppers[AnyRun]] = {}
     wf[time_of_flight.SourcePosition] = sc.vector([0, 0, 0], unit='m')
     # Lots of neutrons activates chunking
     wf[time_of_flight.NumberOfSimulatedNeutrons] = 1_000_000
@@ -70,7 +71,7 @@ def test_lut_workflow_computes_table_in_chunks():
 
 def test_lut_workflow_pulse_skipping():
     wf = TofLookupTableWorkflow()
-    wf[time_of_flight.DiskChoppers] = {}
+    wf[time_of_flight.DiskChoppers[AnyRun]] = {}
     wf[time_of_flight.SourcePosition] = sc.vector([0, 0, 0], unit='m')
     wf[time_of_flight.NumberOfSimulatedNeutrons] = 100_000
     wf[time_of_flight.SimulationSeed] = 62
@@ -93,7 +94,7 @@ def test_lut_workflow_pulse_skipping():
 
 def test_lut_workflow_non_exact_distance_range():
     wf = TofLookupTableWorkflow()
-    wf[time_of_flight.DiskChoppers] = {}
+    wf[time_of_flight.DiskChoppers[AnyRun]] = {}
     wf[time_of_flight.SourcePosition] = sc.vector([0, 0, 0], unit='m')
     wf[time_of_flight.NumberOfSimulatedNeutrons] = 100_000
     wf[time_of_flight.SimulationSeed] = 63

tests/time_of_flight/unwrap_test.py

@@ -8,15 +8,15 @@
 from scippneutron.conversion.graph.tof import elastic as elastic_graph
 
 from ess.reduce import time_of_flight
-from ess.reduce.nexus.types import DetectorData, SampleRun
+from ess.reduce.nexus.types import AnyRun, DetectorData, SampleRun
 from ess.reduce.time_of_flight import GenericTofWorkflow, TofLookupTableWorkflow, fakes
 
 sl = pytest.importorskip("sciline")
 
 
 def make_lut_workflow(choppers, neutrons, seed, pulse_stride):
     lut_wf = TofLookupTableWorkflow()
-    lut_wf[time_of_flight.DiskChoppers] = choppers
+    lut_wf[time_of_flight.DiskChoppers[AnyRun]] = choppers
     lut_wf[time_of_flight.SourcePosition] = fakes.source_position()
     lut_wf[time_of_flight.NumberOfSimulatedNeutrons] = neutrons
     lut_wf[time_of_flight.SimulationSeed] = seed

tests/time_of_flight/wfm_test.py

@@ -9,7 +9,7 @@
 from scippneutron.conversion.graph.tof import elastic as elastic_graph
 
 from ess.reduce import time_of_flight
-from ess.reduce.nexus.types import DetectorData, SampleRun
+from ess.reduce.nexus.types import AnyRun, DetectorData, SampleRun
 from ess.reduce.time_of_flight import GenericTofWorkflow, TofLookupTableWorkflow, fakes
 
 sl = pytest.importorskip("sciline")
@@ -112,7 +112,7 @@ def dream_source_position() -> sc.Variable:
 @pytest.fixture(scope="module")
 def lut_workflow_dream_choppers() -> sl.Pipeline:
     lut_wf = TofLookupTableWorkflow()
-    lut_wf[time_of_flight.DiskChoppers] = dream_choppers()
+    lut_wf[time_of_flight.DiskChoppers[AnyRun]] = dream_choppers()
     lut_wf[time_of_flight.SourcePosition] = dream_source_position()
     lut_wf[time_of_flight.NumberOfSimulatedNeutrons] = 100_000
     lut_wf[time_of_flight.SimulationSeed] = 432
@@ -213,7 +213,7 @@ def test_dream_wfm(
 @pytest.fixture(scope="module")
 def lut_workflow_dream_choppers_time_overlap():
     lut_wf = TofLookupTableWorkflow()
-    lut_wf[time_of_flight.DiskChoppers] = dream_choppers_with_frame_overlap()
+    lut_wf[time_of_flight.DiskChoppers[AnyRun]] = dream_choppers_with_frame_overlap()
     lut_wf[time_of_flight.SourcePosition] = dream_source_position()
     lut_wf[time_of_flight.NumberOfSimulatedNeutrons] = 100_000
     lut_wf[time_of_flight.SimulationSeed] = 432
@@ -405,7 +405,7 @@ def v20_source_position():
 @pytest.fixture(scope="module")
 def lut_workflow_v20_choppers():
     lut_wf = TofLookupTableWorkflow()
-    lut_wf[time_of_flight.DiskChoppers] = v20_choppers()
+    lut_wf[time_of_flight.DiskChoppers[AnyRun]] = v20_choppers()
     lut_wf[time_of_flight.SourcePosition] = v20_source_position()
     lut_wf[time_of_flight.NumberOfSimulatedNeutrons] = 300_000
     lut_wf[time_of_flight.SimulationSeed] = 431

tests/time_of_flight/workflow_test.py

@@ -9,13 +9,18 @@
 
 from ess.reduce import time_of_flight
 from ess.reduce.nexus.types import (
+    AnyRun,
     CalibratedBeamline,
     DetectorData,
     DiskChoppers,
     NeXusData,
     SampleRun,
 )
-from ess.reduce.time_of_flight import GenericTofWorkflow, TofLookupTableWorkflow, fakes
+from ess.reduce.time_of_flight import (
+    GenericTofWorkflow,
+    TofLookupTableWorkflow,
+    fakes,
+)
 
 sl = pytest.importorskip("sciline")
 
@@ -57,7 +62,7 @@ def nexus_data():
 
 def test_TofLookupTableWorkflow_can_compute_tof_lut():
     wf = TofLookupTableWorkflow()
-    wf[DiskChoppers] = fakes.psc_choppers()
+    wf[DiskChoppers[AnyRun]] = fakes.psc_choppers()
     wf[time_of_flight.NumberOfSimulatedNeutrons] = 10_000
     wf[time_of_flight.LtotalRange] = (
         sc.scalar(0.0, unit="m"),
@@ -85,7 +90,7 @@ def test_GenericTofWorkflow_with_tof_lut_from_tof_simulation(
         _ = wf.compute(time_of_flight.DetectorTofData[SampleRun])
 
     lut_wf = TofLookupTableWorkflow()
-    lut_wf[DiskChoppers] = fakes.psc_choppers()
+    lut_wf[DiskChoppers[AnyRun]] = fakes.psc_choppers()
     lut_wf[time_of_flight.NumberOfSimulatedNeutrons] = 10_000
     lut_wf[time_of_flight.LtotalRange] = (
         sc.scalar(0.0, unit="m"),
@@ -106,7 +111,7 @@ def test_GenericTofWorkflow_with_tof_lut_from_file(
     tmp_path: pytest.TempPathFactory,
 ):
     lut_wf = TofLookupTableWorkflow()
-    lut_wf[DiskChoppers] = fakes.psc_choppers()
+    lut_wf[DiskChoppers[AnyRun]] = fakes.psc_choppers()
     lut_wf[time_of_flight.NumberOfSimulatedNeutrons] = 10_000
     lut_wf[time_of_flight.LtotalRange] = (
         sc.scalar(0.0, unit="m"),