Use scn.Measurement instead of separate variables

Author: jl-wynen

src/ess/isissans/general.py

@@ -20,14 +20,13 @@
     DetectorPixelShape,
     DetectorPositionOffset,
     Incident,
+    Measurement,
     MonitorData,
     MonitorPositionOffset,
     MonitorType,
     NeXusComponent,
     NeXusMonitorName,
     NonBackgroundWavelengthRange,
-    RunNumber,
-    RunTitle,
     RunType,
     SampleRun,
     ScatteringRunType,
@@ -174,14 +173,12 @@ def monitor_to_tof(
     return TofMonitor[RunType, MonitorType](da)
 
 
-def run_number(dg: LoadedFileContents[SampleRun]) -> RunNumber:
-    """Get the run number from the raw sample data."""
-    return RunNumber(int(dg['run_number']))
-
-
-def run_title(dg: LoadedFileContents[SampleRun]) -> RunTitle:
-    """Get the run title from the raw sample data."""
-    return RunTitle(dg['run_title'].value)
+def experiment_metadata(dg: LoadedFileContents[SampleRun]) -> Measurement:
+    """Get experiment metadata from the raw sample data."""
+    return Measurement(
+        title=dg['run_title'].value,
+        run_number=dg['run_number'],
+    )
 
 
 def helium3_tube_detector_pixel_shape() -> DetectorPixelShape[ScatteringRunType]:
@@ -235,6 +232,7 @@ def get_detector_ids_from_sample_run(data: TofData[SampleRun]) -> DetectorIDs:
 providers = (
     dummy_assemble_detector_data,
     dummy_assemble_monitor_data,
+    experiment_metadata,
     to_detector_position_offset,
     to_monitor_position_offset,
     get_source_position,
@@ -245,8 +243,6 @@ def get_detector_ids_from_sample_run(data: TofData[SampleRun]) -> DetectorIDs:
     get_monitor_data,
     data_to_tof,
     monitor_to_tof,
-    run_number,
-    run_title,
     lab_frame_transform,
     helium3_tube_detector_pixel_shape,
 )

src/ess/sans/io.py

@@ -8,19 +8,17 @@
 from .types import (
     BackgroundSubtractedIofQ,
     MaskedDetectorIDs,
+    Measurement,
     OutFilename,
     PixelMaskFilename,
-    RunNumber,
-    RunTitle,
 )
 
 
 def save_background_subtracted_iofq(
     *,
     iofq: BackgroundSubtractedIofQ,
     out_filename: OutFilename,
-    run_number: RunNumber,
-    run_title: RunTitle,
+    measurement: Measurement,
 ) -> None:
     """Save background-subtracted I(Q) histogram as an NXcanSAS file."""
     if iofq.bins is None:
@@ -30,7 +28,9 @@ def save_background_subtracted_iofq(
     if da.coords.is_edges('Q'):
         da.coords['Q'] = sc.midpoints(da.coords['Q'])
     with snx.File(out_filename, 'w') as f:
-        f['sasentry'] = nxcansas.SASentry(title=run_title, run=run_number)
+        f['sasentry'] = nxcansas.SASentry(
+            title=measurement.title, run=measurement.run_number_maybe_int
+        )
         f['sasentry']['sasdata'] = nxcansas.SASdata(da, Q_variances='resolutions')
 
 

src/ess/sans/types.py

@@ -285,8 +285,5 @@ class CleanMonitor(
 
 # 4  Metadata
 
-RunTitle = NewType('RunTitle', str)
-"""Title of the run."""
-
-RunNumber = NewType('RunNumber', int)
-"""Run number."""
+Beamline = reduce_t.Beamline
+Measurement = reduce_t.Measurement

tests/io_test.py

@@ -9,7 +9,7 @@
 from scippnexus.application_definitions import nxcansas
 
 from ess.sans.io import save_background_subtracted_iofq
-from ess.sans.types import BackgroundSubtractedIofQ, OutFilename, RunNumber, RunTitle
+from ess.sans.types import BackgroundSubtractedIofQ, Measurement, OutFilename
 
 
 @pytest.mark.parametrize('use_edges', [True, False])
@@ -26,15 +26,15 @@ def background_subtracted_iofq() -> BackgroundSubtractedIofQ:
             )
         )
 
-    def run_number() -> RunNumber:
-        return RunNumber(7419)
-
-    def run_title() -> RunTitle:
-        return RunTitle('Test-title')
+    def experiment_metadata() -> Measurement:
+        return Measurement(
+            title='Test-title',
+            run_number='7419',
+        )
 
     out_filename = tmp_path / 'test.nxs'
 
-    providers = (background_subtracted_iofq, run_number, run_title)
+    providers = (background_subtracted_iofq, experiment_metadata)
     params = {OutFilename: str(out_filename)}
     pipeline = sciline.Pipeline(providers=providers, params=params)
     pipeline.bind_and_call(save_background_subtracted_iofq)