ess.sans.types

This modules defines the domain types uses in esssans.

The domain types are used to define parameters and to request results from a Sciline pipeline.

Module Attributes

BackgroundRun	the run with only the solvent which the sample is placed in.
EmptyBeamRun	Run (sometimes called 'direct run') where the sample holder was empty.
SampleRun	the run with the sample placed in the solvent inside the sample holder.
RunType	TypeVar used for specifying BackgroundRun, EmptyBeamRun or SampleRun
Incident	Incident monitor
Transmission	Transmission monitor
MonitorType	TypeVar used for specifying Incident or Transmission monitor type
Numerator	Numerator of IofQ
Denominator	Denominator of IofQ
IofQPart	TypeVar used for specifying Numerator or Denominator of IofQ
NeXusDetectorName	Name of detector entry in NeXus file
PixelShapePath	Name of the entry where the pixel shape is stored in the NeXus file
TransformationPath	Name of the entry where the transformation computed from the transformation chain is stored, for the detectors and the monitors
ReturnEvents	Whether to return events in the output I(Q)
WavelengthBins	Wavelength binning
WavelengthBands	Wavelength bands.
ProcessedWavelengthBands	Processed wavelength bands, as a two-dimensional variable, with the first dimension being the band index and the second dimension being the wavelength.
QBins	Q binning used when computing IofQ
QxBins	Qx binning used when computing IofQxy
QyBins	Qy binning used when computing IofQxy
NonBackgroundWavelengthRange	Range of wavelengths that are not considered background in the monitor
DirectBeamFilename	Filename of direct beam correction
BeamCenter	Beam center, may be set directly or computed using beam-center finder
WavelengthMask	Optional wavelength mask
CorrectForGravity	Whether to correct for gravity when computing wavelength and Q.
DimsToKeep	Dimensions that should not be reduced and thus still be present in the final I(Q) result (this is typically the layer dimension).
OutFilename	Filename of the output
DetectorIDs	1-D variable listing all detector IDs.
MaskedDetectorIDs	1-D variable listing all masked detector IDs.
DetectorMasks	Masks for detector pixels
DirectBeam	Direct beam
CleanDirectBeam	Direct beam after resampling to required wavelength bins
BackgroundSubtractedIofQ	I(Q) with background (given by I(Q) of the background run) subtracted
BackgroundSubtractedIofQxy	I(Qx, Qy) with background (given by I(Qx, Qy) of the background run) subtracted
RunTitle	Title of the run.
RunNumber	Run number.

Classes

CalibratedDetector(x)	Calibrated version of raw detector
CleanMonitor(x)	Monitor data cleaned of background counts
CleanQ(x)	Result of converting CleanWavelengthMasked to Q
CleanQxy(x)	Result of converting CleanWavelengthMasked to Qx and Qy
CleanSummedQ(x)	Result of histogramming/binning CleanQ over all pixels into Q bins
CleanSummedQxy(x)	Result of histogramming/binning CleanQxy over all pixels into Qx and Qy bins
CleanWavelength(x)	Prerequisite for IofQ numerator or denominator.
CleanWavelengthMasked(x)	Result of applying wavelength masking to CleanWavelength
DetectorData(x)	Calibrated detector with added raw event data
DetectorEventData(x)	Event data loaded from a detector in a NeXus file
DetectorPixelShape(*args, **kwargs)	Geometry of the detector from description in nexus file.
Filename(x)	Filename of a run
IofQ(x)	I(Q)
IofQxy(x)	I(Qx, Qy)
LabFrameTransform(x)	Coordinate transformation from detector local coordinates to the sample frame of reference.
MaskedData(x)	Raw data with pixel-specific masks applied
MaskedSolidAngle(x)	Same as SolidAngle, but with pixel masks applied
MonitorEventData(x)	Event data loaded from a monitor in a NeXus file
NeXusDetector(*args, **kwargs)	Detector data, loaded from a NeXus file, containing not only neutron events but also pixel shape information, transformations, ...
NeXusMonitor(*args, **kwargs)	Monitor data loaded from a NeXus file, containing not only neutron events but also transformations, ...
NeXusMonitorName(x)	Name of Incident|Transmission monitor in NeXus file
NormWavelengthTerm(x)	Normalization term (numerator) for IofQ before scaling with solid-angle.
RawDetector(x)	Raw detector component extracted from NeXusDetector
RawMonitor(x)	Raw monitor data
RawMonitorData(x)	Raw monitor data where variances and necessary coordinates (e.g. source position) have been added, and where optionally some user configuration was applied to some of the coordinates.
RawSample(*args, **kwargs)	Raw sample from NeXus file
RawSource(*args, **kwargs)	Raw source from NeXus file
SamplePosition(x)	Sample position
SolidAngle(x)	Solid angle of detector pixels seen from sample position
SourcePosition(x)	Source position
TofData(x)	Data with a time-of-flight coordinate
TofMonitor(*args, **kwargs)	Monitor data with a time-of-flight coordinate
TransmissionFraction(x)	Transmission fraction
TransmissionRun(x)	Mapping between ScatteringRunType and transmission run.
WavelengthMonitor(x)	Monitor data converted to wavelength