ess.reduce.nexus.workflow.get_calibrated_monitor#
- ess.reduce.nexus.workflow.get_calibrated_monitor(monitor, offset, source_position)[source]#
Extract the data array corresponding to a monitor’s signal field.
The returned data array includes coords pertaining directly to the signal values array, but not additional information about the monitor.
- Parameters:
monitor (
NeXusComponent[TypeVar(MonitorType,nexus.types.Monitor1(int),nexus.types.Monitor2(int),nexus.types.Monitor3(int),nexus.types.Monitor4(int),nexus.types.Monitor5(int),nexus.types.Monitor6(int),nexus.types.IncidentMonitor(int),nexus.types.TransmissionMonitor(int),nexus.types.FrameMonitor(int),nexus.types.FrameMonitor(int),nexus.types.FrameMonitor(int),nexus.types.FrameMonitor(int),nexus.types.CaveMonitor(int)),TypeVar(RunType,nexus.types.BackgroundRun(int),nexus.types.EmptyBeamRun(int),nexus.types.SampleRun(int),TransmissionRun[nexus.types.SampleRun(int)],TransmissionRun[nexus.types.BackgroundRun(int)],nexus.types.VanadiumRun(int))]) – NeXus monitor group.offset (
MonitorPositionOffset[TypeVar(RunType,nexus.types.BackgroundRun(int),nexus.types.EmptyBeamRun(int),nexus.types.SampleRun(int),TransmissionRun[nexus.types.SampleRun(int)],TransmissionRun[nexus.types.BackgroundRun(int)],nexus.types.VanadiumRun(int)),TypeVar(MonitorType,nexus.types.Monitor1(int),nexus.types.Monitor2(int),nexus.types.Monitor3(int),nexus.types.Monitor4(int),nexus.types.Monitor5(int),nexus.types.Monitor6(int),nexus.types.IncidentMonitor(int),nexus.types.TransmissionMonitor(int),nexus.types.FrameMonitor(int),nexus.types.FrameMonitor(int),nexus.types.FrameMonitor(int),nexus.types.FrameMonitor(int),nexus.types.CaveMonitor(int))]) – Offset to add to the monitor position.source_position (
Position[NXsource,TypeVar(RunType,nexus.types.BackgroundRun(int),nexus.types.EmptyBeamRun(int),nexus.types.SampleRun(int),TransmissionRun[nexus.types.SampleRun(int)],TransmissionRun[nexus.types.BackgroundRun(int)],nexus.types.VanadiumRun(int))]) – Position of the neutron source.
- Return type:
CalibratedMonitor[TypeVar(RunType,nexus.types.BackgroundRun(int),nexus.types.EmptyBeamRun(int),nexus.types.SampleRun(int),TransmissionRun[nexus.types.SampleRun(int)],TransmissionRun[nexus.types.BackgroundRun(int)],nexus.types.VanadiumRun(int)),TypeVar(MonitorType,nexus.types.Monitor1(int),nexus.types.Monitor2(int),nexus.types.Monitor3(int),nexus.types.Monitor4(int),nexus.types.Monitor5(int),nexus.types.Monitor6(int),nexus.types.IncidentMonitor(int),nexus.types.TransmissionMonitor(int),nexus.types.FrameMonitor(int),nexus.types.FrameMonitor(int),nexus.types.FrameMonitor(int),nexus.types.FrameMonitor(int),nexus.types.CaveMonitor(int))]