Change names to standard scheme

Author: jl-wynen

docs/user-guide/tof/dream.ipynb

@@ -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:

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

@@ -199,25 +199,23 @@ 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 CalibratedMonitor(
-    sciline.Scope[RunType, MonitorType, sc.DataArray], sc.DataArray
-):
-    """Calibrated data from a monitor."""
+class EmptyMonitor(sciline.Scope[RunType, MonitorType, sc.DataArray], sc.DataArray):
+    """Monitor without neutron data."""
 
 
-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."""
 
 

docs/user-guide/tof/wfm.ipynb

@@ -21,16 +21,14 @@
     AllNeXusComponents,
     Beamline,
     CalibratedBeamline,
-    CalibratedDetector,
-    CalibratedMonitor,
     Component,
     DetectorBankSizes,
-    DetectorData,
     DetectorPositionOffset,
+    EmptyDetector,
+    EmptyMonitor,
     Filename,
     GravityVector,
     Measurement,
-    MonitorData,
     MonitorPositionOffset,
     MonitorType,
     NeXusAllComponentLocationSpec,
@@ -46,6 +44,8 @@
     Position,
     PreopenNeXusFile,
     RawChoppers,
+    RawDetector,
+    RawMonitor,
     RunType,
     TimeInterval,
     UniqueComponent,
@@ -360,7 +360,7 @@ def get_calibrated_detector(
     # all.
     offset: DetectorPositionOffset[RunType],
     bank_sizes: DetectorBankSizes,
-) -> CalibratedDetector[RunType]:
+) -> EmptyDetector[RunType]:
     """
     Extract the data array corresponding to a detector's signal field.
 
@@ -395,13 +395,13 @@ def get_calibrated_detector(
     else:
         transform_value = transform.value
     position = transform_value * offsets
-    return CalibratedDetector[RunType](
+    return EmptyDetector[RunType](
         da.assign_coords(position=position + offset.to(unit=position.unit))
     )
 
 
 def assemble_beamline(
-    detector: CalibratedDetector[RunType],
+    detector: EmptyDetector[RunType],
     source_position: Position[snx.NXsource, RunType],
     sample_position: Position[snx.NXsample, RunType],
     gravity: GravityVector,
@@ -438,7 +438,7 @@ def assemble_beamline(
 def assemble_detector_data(
     detector: CalibratedBeamline[RunType],
     event_data: NeXusData[snx.NXdetector, RunType],
-) -> DetectorData[RunType]:
+) -> RawDetector[RunType]:
     """
     Assemble a detector data array with event data.
 
@@ -454,7 +454,7 @@ def assemble_detector_data(
     grouped = nexus.group_event_data(
         event_data=event_data, detector_number=detector.coords['detector_number']
     )
-    return DetectorData[RunType](
+    return RawDetector[RunType](
         _add_variances(grouped)
         .assign_coords(detector.coords)
         .assign_masks(detector.masks)
@@ -465,7 +465,7 @@ def get_calibrated_monitor(
     monitor: NeXusComponent[MonitorType, RunType],
     offset: MonitorPositionOffset[RunType, MonitorType],
     source_position: Position[snx.NXsource, RunType],
-) -> CalibratedMonitor[RunType, MonitorType]:
+) -> EmptyMonitor[RunType, MonitorType]:
     """
     Extract the data array corresponding to a monitor's signal field.
 
@@ -482,7 +482,7 @@ def get_calibrated_monitor(
         Position of the neutron source.
     """
     monitor = nexus.compute_component_position(monitor)
-    return CalibratedMonitor[RunType, MonitorType](
+    return EmptyMonitor[RunType, MonitorType](
         nexus.extract_signal_data_array(monitor).assign_coords(
             position=monitor['position'] + offset.to(unit=monitor['position'].unit),
             source_position=source_position,
@@ -491,9 +491,9 @@ def get_calibrated_monitor(
 
 
 def assemble_monitor_data(
-    monitor: CalibratedMonitor[RunType, MonitorType],
+    monitor: EmptyMonitor[RunType, MonitorType],
     data: NeXusData[MonitorType, RunType],
-) -> MonitorData[RunType, MonitorType]:
+) -> RawMonitor[RunType, MonitorType]:
     """
     Assemble a monitor data array with event data.
 
@@ -507,7 +507,7 @@ def assemble_monitor_data(
         Data array with neutron counts.
     """
     da = data.assign_coords(monitor.coords).assign_masks(monitor.masks)
-    return MonitorData[RunType, MonitorType](_add_variances(da))
+    return RawMonitor[RunType, MonitorType](_add_variances(da))
 
 
 def parse_disk_choppers(

src/ess/reduce/live/raw.py

@@ -24,25 +24,23 @@
 )
 from .types import (
     DetectorLtotal,
-    DetectorTofData,
     MonitorLtotal,
-    MonitorTofData,
     PulseStrideOffset,
     TimeOfFlightLookupTable,
     TimeOfFlightLookupTableFilename,
+    TofDetector,
+    TofMonitor,
 )
 from .workflow import GenericTofWorkflow
 
 __all__ = [
     "DetectorLtotal",
-    "DetectorTofData",
     "DiskChoppers",
     "DistanceResolution",
     "GenericTofWorkflow",
     "LookupTableRelativeErrorThreshold",
     "LtotalRange",
     "MonitorLtotal",
-    "MonitorTofData",
     "NumberOfSimulatedNeutrons",
     "PulsePeriod",
     "PulseStride",
@@ -53,7 +51,9 @@
     "TimeOfFlightLookupTable",
     "TimeOfFlightLookupTableFilename",
     "TimeResolution",
+    "TofDetector",
     "TofLookupTableWorkflow",
+    "TofMonitor",
     "providers",
     "simulate_chopper_cascade_using_tof",
 ]

src/ess/reduce/nexus/types.py

@@ -21,20 +21,20 @@
 
 from ..nexus.types import (
     CalibratedBeamline,
-    CalibratedMonitor,
-    DetectorData,
-    MonitorData,
+    EmptyMonitor,
     MonitorType,
+    RawDetector,
+    RawMonitor,
     RunType,
 )
 from .resample import rebin_strictly_increasing
 from .types import (
     DetectorLtotal,
-    DetectorTofData,
     MonitorLtotal,
-    MonitorTofData,
     PulseStrideOffset,
     TimeOfFlightLookupTable,
+    TofDetector,
+    TofMonitor,
 )
 
 
@@ -294,7 +294,7 @@ def detector_ltotal_from_straight_line_approximation(
 
 
 def monitor_ltotal_from_straight_line_approximation(
-    monitor_beamline: CalibratedMonitor[RunType, MonitorType],
+    monitor_beamline: EmptyMonitor[RunType, MonitorType],
 ) -> MonitorLtotal[RunType, MonitorType]:
     """
     Compute Ltotal for the monitor.
@@ -334,11 +334,11 @@ def _compute_tof_data(
 
 
 def detector_time_of_flight_data(
-    detector_data: DetectorData[RunType],
+    detector_data: RawDetector[RunType],
     lookup: TimeOfFlightLookupTable,
     ltotal: DetectorLtotal[RunType],
     pulse_stride_offset: PulseStrideOffset,
-) -> DetectorTofData[RunType]:
+) -> TofDetector[RunType]:
     """
     Convert the time-of-arrival data to time-of-flight data using a lookup table.
     The output data will have a time-of-flight coordinate.
@@ -357,7 +357,7 @@ def detector_time_of_flight_data(
         When pulse-skipping, the offset of the first pulse in the stride. This is
         typically zero but can be a small integer < pulse_stride.
     """
-    return DetectorTofData[RunType](
+    return TofDetector[RunType](
         _compute_tof_data(
             da=detector_data,
             lookup=lookup,
@@ -368,11 +368,11 @@ def detector_time_of_flight_data(
 
 
 def monitor_time_of_flight_data(
-    monitor_data: MonitorData[RunType, MonitorType],
+    monitor_data: RawMonitor[RunType, MonitorType],
     lookup: TimeOfFlightLookupTable,
     ltotal: MonitorLtotal[RunType, MonitorType],
     pulse_stride_offset: PulseStrideOffset,
-) -> MonitorTofData[RunType, MonitorType]:
+) -> TofMonitor[RunType, MonitorType]:
     """
     Convert the time-of-arrival data to time-of-flight data using a lookup table.
     The output data will have a time-of-flight coordinate.
@@ -391,7 +391,7 @@ def monitor_time_of_flight_data(
         When pulse-skipping, the offset of the first pulse in the stride. This is
         typically zero but can be a small integer < pulse_stride.
     """
-    return MonitorTofData[RunType, MonitorType](
+    return TofMonitor[RunType, MonitorType](
         _compute_tof_data(
             da=monitor_data,
             lookup=lookup,

src/ess/reduce/nexus/workflow.py

@@ -33,9 +33,9 @@ class MonitorLtotal(sl.Scope[RunType, MonitorType, sc.Variable], sc.Variable):
     """Total path length of neutrons from source to monitor."""
 
 
-class DetectorTofData(sl.Scope[RunType, sc.DataArray], sc.DataArray):
+class TofDetector(sl.Scope[RunType, sc.DataArray], sc.DataArray):
     """Detector data with time-of-flight coordinate."""
 
 
-class MonitorTofData(sl.Scope[RunType, MonitorType, sc.DataArray], sc.DataArray):
+class TofMonitor(sl.Scope[RunType, MonitorType, sc.DataArray], sc.DataArray):
     """Monitor data with time-of-flight coordinate."""