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 IofQ
Denominator	Denominator of IofQ
IofQPart	TypeVar used for specifying Numerator or Denominator of IofQ
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
RunTitle	Title of the run.
RunNumber	Run number.

Classes

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.
DetectorPixelShape(*args, **kwargs)	Geometry of the detector from description in nexus file.
IofQ(x)	I(Q)
IofQxy(x)	I(Qx, Qy)
MaskedData(x)	Raw data with pixel-specific masks applied
MaskedSolidAngle(x)	Same as SolidAngle, but with pixel masks applied
MonitorTerm(x)	Monitor-dependent factor of the Normalization term (numerator) for IofQ.
ReducedQ(x)	Result of reducing CleanSummedQ over the wavelength dimensions
ReducedQxy(x)	Result of reducing CleanSummedQxy over the wavelength dimensions
SolidAngle(x)	Solid angle of detector pixels seen from sample 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
WavelengthMonitor(x)	Monitor data converted to wavelength
WavelengthScaledQ(x)	Result of applying wavelength scaling/masking to CleanSummedQ
WavelengthScaledQxy(x)	Result of applying wavelength scaling/masking to CleanSummedQxy