# SPDX-License-Identifier: BSD-3-Clause
# Copyright (c) 2025 Scipp contributors (https://github.com/scipp)
"""Domain types for spectroscopy."""
from typing import Any, NewType, TypeVar
import sciline
import scipp as sc
from ess.reduce import time_of_flight
from ess.reduce.nexus import types as reduce_t
# NeXus types
Beamline = reduce_t.Beamline
DetectorPositionOffset = reduce_t.DetectorPositionOffset
EmptyDetector = reduce_t.EmptyDetector
Filename = reduce_t.Filename
GravityVector = reduce_t.GravityVector
Measurement = reduce_t.Measurement
NeXusClass = reduce_t.NeXusClass
NeXusComponentLocationSpec = reduce_t.NeXusComponentLocationSpec
NeXusComponent = reduce_t.NeXusComponent
NeXusData = reduce_t.NeXusData
NeXusDetectorName = reduce_t.NeXusDetectorName
NeXusFileSpec = reduce_t.NeXusFileSpec
NeXusMonitorName = reduce_t.NeXusName
NeXusTransformation = reduce_t.NeXusTransformation
Position = reduce_t.Position
PreopenNeXusFile = reduce_t.PreopenNeXusFile
RawDetector = reduce_t.RawDetector
RawMonitor = reduce_t.RawMonitor
SampleRun = reduce_t.SampleRun
VanadiumRun = reduce_t.VanadiumRun
FrameMonitor0 = reduce_t.FrameMonitor0
FrameMonitor1 = reduce_t.FrameMonitor1
FrameMonitor2 = reduce_t.FrameMonitor2
FrameMonitor3 = reduce_t.FrameMonitor3
# Type vars
RunType = TypeVar("RunType", SampleRun, VanadiumRun)
MonitorType = TypeVar(
"MonitorType",
FrameMonitor0,
FrameMonitor1,
FrameMonitor2,
FrameMonitor3,
)
# Time-of-flight types
TofDetector = time_of_flight.TofDetector
TofMonitor = time_of_flight.TofMonitor
MonitorLtotal = time_of_flight.MonitorLtotal
PulseStride = time_of_flight.PulseStride
PulseStrideOffset = time_of_flight.PulseStrideOffset
PulsePeriod = time_of_flight.PulsePeriod
TimeOfFlightLookupTable = time_of_flight.TimeOfFlightLookupTable
TimeOfFlightLookupTableFilename = time_of_flight.TimeOfFlightLookupTableFilename
# Custom types
[docs]
class Analyzer(sciline.Scope[RunType, sc.DataGroup[Any]], sc.DataGroup[Any]):
"""A single wavelength analyzer loaded from an NXcrystal.
Can be obtained from ``Analyzers``.
"""
[docs]
class Analyzers(sciline.Scope[RunType, sc.DataGroup[Any]], sc.DataGroup[Any]):
"""All wavelength analyzers loaded from a NXcrystals."""
[docs]
class DataAtSample(sciline.Scope[RunType, sc.DataArray], sc.DataArray): ...
[docs]
class DataGroupedByRotation(sciline.Scope[RunType, sc.DataArray], sc.DataArray): ...
[docs]
class QDetector(sciline.Scope[RunType, sc.DataArray], sc.DataArray):
"""Detector counts with a momentum transfer coordinate."""
EnergyBins = NewType('EnergyBins', sc.Variable)
[docs]
class EnergyData(sciline.Scope[RunType, sc.DataArray], sc.DataArray): ...
[docs]
class EnergyQDetector(sciline.Scope[RunType, sc.DataArray], sc.DataArray):
"""Detector counts with a momentum transfer and energy transfer coordinates."""
[docs]
class IncidentEnergyDetector(sciline.Scope[RunType, sc.DataArray], sc.DataArray):
"""Detector counts with an incident energy coordinate."""
[docs]
class SampleAngle(sciline.Scope[RunType, sc.DataArray], sc.DataArray):
"""Rotation angle of the sample, possibly as a function of time.
For BIFROST, this is angle "a3".
"""
[docs]
class InstrumentAngle(sciline.Scope[RunType, sc.DataArray], sc.DataArray):
"""Rotation angle of the instrument, possibly as a function of time.
For BIFROST, this is angle "a4".
"""
MonitorCoordTransformGraph = NewType('MonitorCoordTransformGraph', dict)
NXspeFileName = NewType('NXspeFileName', str)
NXspeFileNames = NewType('NXspeFileNames', list[NXspeFileName])
OutFilename = NewType("OutFilename", str)
InelasticCoordTransformGraph = NewType('InelasticCoordTransformGraph', dict)
SQWBinSizes = NewType('SQWBinSizes', dict[str, int])
[docs]
class WavelengthMonitor(
sciline.Scope[RunType, MonitorType, sc.DataArray], sc.DataArray
): ...
