Merge pull request #271 from scipp/standard-domain-type-names

Change domain names to standard scheme

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 AnyRun, DetectorData, SampleRun\n",
+    "from ess.reduce.nexus.types import AnyRun, RawDetector, SampleRun\n",
     "from ess.reduce.time_of_flight import *"
    ]
   },
@@ -300,10 +300,10 @@
    "source": [
     "wf = GenericTofWorkflow(run_types=[SampleRun], monitor_types=[])\n",
     "\n",
-    "wf[DetectorData[SampleRun]] = raw_data\n",
+    "wf[RawDetector[SampleRun]] = raw_data\n",
     "wf[DetectorLtotal[SampleRun]] = Ltotal\n",
     "\n",
-    "wf.visualize(DetectorTofData[SampleRun])"
+    "wf.visualize(TofDetector[SampleRun])"
    ]
   },
   {
@@ -436,7 +436,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "30",
    "metadata": {},
@@ -457,7 +456,7 @@
     "wf[TimeOfFlightLookupTable] = table\n",
     "\n",
     "# Compute time-of-flight of neutron events\n",
-    "tofs = wf.compute(DetectorTofData[SampleRun])\n",
+    "tofs = wf.compute(TofDetector[SampleRun])\n",
     "tofs"
    ]
   },
@@ -616,11 +615,11 @@
    "outputs": [],
    "source": [
     "# Update workflow\n",
-    "wf[DetectorData[SampleRun]] = raw_data\n",
+    "wf[RawDetector[SampleRun]] = raw_data\n",
     "wf[DetectorLtotal[SampleRun]] = Ltotal\n",
     "\n",
     "# Compute tofs and wavelengths\n",
-    "tofs = wf.compute(DetectorTofData[SampleRun])\n",
+    "tofs = wf.compute(TofDetector[SampleRun])\n",
     "wav_wfm = tofs.transform_coords(\"wavelength\", graph=graph)\n",
     "\n",
     "# Compare in plot\n",
@@ -795,13 +794,13 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "wf[DetectorData[SampleRun]] = ess_beamline.get_monitor(\"detector\")[0]\n",
+    "wf[RawDetector[SampleRun]] = ess_beamline.get_monitor(\"detector\")[0]\n",
     "wf[DetectorLtotal[SampleRun]] = Ltotal\n",
     "\n",
     "wf[TimeOfFlightLookupTable] = table\n",
     "\n",
     "# Compute time-of-flight\n",
-    "tofs = wf.compute(DetectorTofData[SampleRun])\n",
+    "tofs = wf.compute(TofDetector[SampleRun])\n",
     "# Compute wavelength\n",
     "wav_wfm = tofs.transform_coords(\"wavelength\", graph=graph)\n",
     "\n",
@@ -823,17 +822,6 @@
    "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
   }
  },
  "nbformat": 4,

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

@@ -1,7 +1,6 @@
 {
  "cells": [
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "0",
    "metadata": {},
@@ -32,7 +31,7 @@
     "import plopp as pp\n",
     "import scipp as sc\n",
     "from scippneutron.chopper import DiskChopper\n",
-    "from ess.reduce.nexus.types import AnyRun, DetectorData, SampleRun\n",
+    "from ess.reduce.nexus.types import AnyRun, RawDetector, SampleRun\n",
     "from ess.reduce.time_of_flight import *\n",
     "import tof\n",
     "\n",
@@ -161,10 +160,10 @@
    "source": [
     "wf = GenericTofWorkflow(run_types=[SampleRun], monitor_types=[])\n",
     "\n",
-    "wf[DetectorData[SampleRun]] = nxevent_data\n",
+    "wf[RawDetector[SampleRun]] = nxevent_data\n",
     "wf[DetectorLtotal[SampleRun]] = nxevent_data.coords[\"Ltotal\"]\n",
     "\n",
-    "wf.visualize(DetectorTofData[SampleRun])"
+    "wf.visualize(TofDetector[SampleRun])"
    ]
   },
   {
@@ -271,7 +270,7 @@
     "wf[TimeOfFlightLookupTable] = table\n",
     "\n",
     "# Compute neutron tofs\n",
-    "tofs = wf.compute(DetectorTofData[SampleRun])\n",
+    "tofs = wf.compute(TofDetector[SampleRun])\n",
     "\n",
     "tof_hist = tofs.hist(tof=sc.scalar(500.0, unit=\"us\"))\n",
     "pp.plot({det.name: tof_hist[\"detector_number\", i] for i, det in enumerate(detectors)})"
@@ -456,11 +455,11 @@
     "# Reduction workflow\n",
     "wf = GenericTofWorkflow(run_types=[SampleRun], monitor_types=[])\n",
     "nxevent_data = results.to_nxevent_data()\n",
-    "wf[DetectorData[SampleRun]] = nxevent_data\n",
+    "wf[RawDetector[SampleRun]] = nxevent_data\n",
     "wf[DetectorLtotal[SampleRun]] = nxevent_data.coords[\"Ltotal\"]\n",
     "wf[TimeOfFlightLookupTable] = table\n",
     "\n",
-    "tofs = wf.compute(DetectorTofData[SampleRun])\n",
+    "tofs = wf.compute(TofDetector[SampleRun])\n",
     "\n",
     "tof_hist = tofs.hist(tof=sc.scalar(500.0, unit=\"us\"))\n",
     "pp.plot({det.name: tof_hist[\"detector_number\", i] for i, det in enumerate(detectors)})"
@@ -500,24 +499,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
 }

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 AnyRun, DetectorData, SampleRun\n",
+    "from ess.reduce.nexus.types import AnyRun, RawDetector, SampleRun\n",
     "from ess.reduce.time_of_flight import *"
    ]
   },
@@ -321,10 +321,10 @@
    "source": [
     "wf = GenericTofWorkflow(run_types=[SampleRun], monitor_types=[])\n",
     "\n",
-    "wf[DetectorData[SampleRun]] = raw_data\n",
+    "wf[RawDetector[SampleRun]] = raw_data\n",
     "wf[DetectorLtotal[SampleRun]] = Ltotal\n",
     "\n",
-    "wf.visualize(DetectorTofData[SampleRun])"
+    "wf.visualize(TofDetector[SampleRun])"
    ]
   },
   {
@@ -442,7 +442,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "27",
    "metadata": {},
@@ -466,7 +465,7 @@
    "source": [
     "wf[TimeOfFlightLookupTable] = table\n",
     "\n",
-    "tofs = wf.compute(DetectorTofData[SampleRun])\n",
+    "tofs = wf.compute(TofDetector[SampleRun])\n",
     "tofs"
    ]
   },
@@ -549,24 +548,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
 }

src/ess/reduce/live/raw.py

@@ -29,7 +29,7 @@
 import scippnexus as snx
 
 from ess.reduce.nexus.types import (
-    CalibratedDetector,
+    EmptyDetector,
     Filename,
     NeXusComponent,
     NeXusDetectorName,
@@ -305,7 +305,7 @@ def transform_weights(
 
     @staticmethod
     def from_detector_and_histogrammer(
-        detector: CalibratedDetector[SampleRun],
+        detector: EmptyDetector[SampleRun],
         window: RollingDetectorViewWindow,
         projection: Histogrammer,
     ) -> RollingDetectorView:
@@ -320,10 +320,10 @@ def from_detector_and_histogrammer(
     def from_detector_with_projection(
         projection: Callable[[sc.DataArray], sc.DataArray] | None,
     ) -> Callable[
-        [CalibratedDetector[SampleRun], RollingDetectorViewWindow], RollingDetectorView
+        [EmptyDetector[SampleRun], RollingDetectorViewWindow], RollingDetectorView
     ]:
         def factory(
-            detector: CalibratedDetector[SampleRun],
+            detector: EmptyDetector[SampleRun],
             window: RollingDetectorViewWindow,
         ) -> RollingDetectorView:
             """Helper for constructing via a Sciline workflow."""
@@ -591,7 +591,7 @@ def gaussian_position_noise(sigma: PositionNoiseSigma) -> PositionNoise:
 
 def position_with_noisy_replicas(
     *,
-    detector: CalibratedDetector[SampleRun],
+    detector: EmptyDetector[SampleRun],
     position_noise: PositionNoise,
     replicas: PositionNoiseReplicaCount,
 ) -> CalibratedPositionWithNoisyReplicas:

src/ess/reduce/nexus/types.py

@@ -199,25 +199,19 @@ class MonitorPositionOffset(
     """Offset for the monitor position, added to base position."""
 
 
-class CalibratedDetector(sciline.Scope[RunType, sc.DataArray], sc.DataArray):
-    """Calibrated data from a detector."""
+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."""
 
 
-class CalibratedMonitor(
-    sciline.Scope[RunType, MonitorType, sc.DataArray], sc.DataArray
-):
-    """Calibrated data from a monitor."""
-
-
-class DetectorData(sciline.Scope[RunType, sc.DataArray], sc.DataArray):
+class RawDetector(sciline.Scope[RunType, sc.DataArray], sc.DataArray):
     """Calibrated detector merged with neutron event or histogram data."""
 
 
-class MonitorData(sciline.Scope[RunType, MonitorType, sc.DataArray], sc.DataArray):
+class RawMonitor(sciline.Scope[RunType, MonitorType, sc.DataArray], sc.DataArray):
     """Calibrated monitor merged with neutron event or histogram data."""