ess.reduce.nexus.types

Domain types for use with Sciline, parametrized by run- and monitor-type.

Module Attributes

FilePath	Full path to a NeXus file on disk.
NeXusFile	An open NeXus file.
NeXusGroup	A ScippNexus group in an open file.
NeXusEntryName	Name of an entry in a NeXus file.
NeXusSourceName	Name of a source in a NeXus file.
PreopenNeXusFile	Whether to preopen NeXus files before passing them to the rest of the workflow.
BackgroundRun	Background run such as a run with only a solvent which the sample is placed in.
EmptyBeamRun	Run with empty sample holder, sometimes called 'direct run'.
SampleRun	Sample run.
VanadiumRun	Vanadium run.
RunType	TypeVar used for specifying BackgroundRun, EmptyBeamRun or SampleRun
Monitor1	Identifier for an arbitrary monitor
Monitor2	Identifier for an arbitrary monitor
Monitor3	Identifier for an arbitrary monitor
Monitor4	Identifier for an arbitrary monitor
Monitor5	Identifier for an arbitrary monitor
IncidentMonitor	Incident monitor
TransmissionMonitor	Transmission monitor
MonitorType	TypeVar used for specifying the monitor type such as Incident or Transmission
UniqueComponent	Components that can be identified by their type as there will only be one.
NeXusDetectorName	Name of a detector (bank) in a NeXus file.

Classes

CalibratedBeamline(x)	Calibrated beamline with detector and other components.
CalibratedDetector(x)	Calibrated data from a detector.
CalibratedMonitor(x)	Calibrated data from a monitor.
DetectorData(x)	Calibrated detector merged with neutron event or histogram data.
DetectorPositionOffset(x)	Offset for the detector position, added to base position.
Filename(x)
MonitorData(x)	Calibrated monitor merged with neutron event or histogram data.
MonitorPositionOffset(x)	Offset for the monitor position, added to base position.
NeXusClass(x)	NX_class of a component in a NeXus file.
NeXusComponent(*args, **kwargs)	Raw data from a NeXus component.
NeXusComponentLocationSpec(filename[, ...])	NeXus filename and optional parameters to identify (parts of) a component to load.
NeXusData(x)	Data array loaded from an NXevent_data or NXdata group.
NeXusDataLocationSpec(filename[, ...])	NeXus filename and parameters to identify (parts of) detector data to load.
NeXusFileSpec(value)
NeXusLocationSpec(filename[, entry_name, ...])	NeXus filename and optional parameters to identify (parts of) a component to load.
NeXusName(x)	Name of a component in a NeXus file.
NeXusTransformation(value)
NeXusTransformationChain(parent, value[, ...])
Position(x)	Position of a component such as source, sample, monitor, or detector.
PulseSelection(value)	Range of neutron pulses to load from NXevent_data or NXdata groups.
TransmissionRun()	Mapping between ScatteringRunType and transmission run.