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

Numerator	Numerator of IntensityQ
Denominator	Denominator of IntensityQ
IofQPart	TypeVar used for specifying Numerator or Denominator of IntensityQ
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, else and array of ones.
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

Classes

BinnedQ(x)	Result of histogramming/binning QDetector over all pixels into Q bins
BinnedQxQy(x)	Result of histogramming/binning QxyDetector over all pixels into Qx and Qy bins
CorrectedDetector(x)	Data with masks and corrections applied, used for numerator or denominator of IofQ.
CorrectedMonitor(x)	Monitor data cleaned of background counts
DetectorPixelShape(*args, **kwargs)	Geometry of the detector from description in nexus file.
IntensityQ(x)	I(Q)
IntensityQxQy(x)	I(Qx, Qy)
MonitorTerm(x)	Monitor-dependent factor of the Normalization term (numerator) for IofQ.
NormalizedQ(x)	Result of applying wavelength scaling/masking to BinnedQ
NormalizedQxQy(x)	Result of applying wavelength scaling/masking to BinnedQxQy
QDetector(x)	Result of converting WavelengthDetectorMasked to Q
QxyDetector(x)	Result of converting WavelengthDetectorMasked to Qx and Qy
ReducedQ(x)	Result of reducing BinnedQ over the wavelength dimensions
ReducedQxQy(x)	Result of reducing BinnedQxQy over the wavelength dimensions
SolidAngle(x)	Solid angle of detector pixels seen from sample position
TofDetector(x)	Data with a time-of-flight coordinate
TofMonitor(*args, **kwargs)	Monitor data with a time-of-flight coordinate
TransmissionFraction(x)	Transmission fraction
WavelengthDetector(x)	Prerequisite for IofQ numerator or denominator.
WavelengthMonitor(x)	Monitor data converted to wavelength