\(\renewcommand\AA{\unicode{x212B}}\)

MagnetismReflectometryReduction v1¶

Summary ¶

Magnetism Reflectometer (REFM) reduction

Properties ¶

Name	Direction	Type	Default	Description
InputWorkspace	Input	Workspace		Optionally, we can provide a scattering workspace directly
NormalizationRunNumber	Input	number	0	Run number of the normalization run to use
NormalizationWorkspace	Input	Workspace		Optionally, we can provide a normalization workspace directly
SignalPeakPixelRange	Input	int list	123,137	Pixel range defining the data peak
SubtractSignalBackground	Input	boolean	True	If true, the background will be subtracted from the data peak
SignalBackgroundPixelRange	Input	int list	123,137	Pixel range defining the background. Default:(123,137)
ApplyNormalization	Input	boolean	True	If true, the data will be normalized
NormPeakPixelRange	Input	int list	127,133	Pixel range defining the normalization peak
SubtractNormBackground	Input	boolean	True	If true, the background will be subtracted from the normalization peak
NormBackgroundPixelRange	Input	int list	127,137	Pixel range defining the background for the normalization
CutLowResDataAxis	Input	boolean	True	If true, the low resolution direction of the data will be cropped according to the lowResDataAxisPixelRange property
LowResDataAxisPixelRange	Input	int list	115,210	Pixel range to use in the low resolution direction of the data
CutLowResNormAxis	Input	boolean	True	If true, the low resolution direction of the normalization run will be cropped according to the LowResNormAxisPixelRange property
LowResNormAxisPixelRange	Input	int list	115,210	Pixel range to use in the low resolution direction of the normalizaion run
TimeAxisRange	Input	dbl list	0,340000	TOF/wavelength range to use with detector binning
UseWLTimeAxis	Input	boolean	False	For const-Q, if true, wavelength will be used as the time axis, otherwise TOF is used
ErrorWeightedBackground	Input	boolean	True	If true, use an error weighted average for the background estimate
CutTimeAxis	Input	boolean	True	If true, the TOF/wavelength dimension will be cropped according to the TimeAxisRange property
RoundUpPixel	Input	boolean	True	If True, round up pixel position of the specular reflectivity
UseSANGLE	Input	boolean	False	If True, use SANGLE as the scattering angle
SpecularPixel	Input	number	180	Pixel position of the specular reflectivity
FinalRebin	Input	boolean	True	If True, the final reflectivity will be rebinned
QMin	Input	number	0.005	Minimum Q-value
QStep	Input	number	0.02	Step size in Q. Enter a negative value to get a log scale
AngleOffset	Input	number	0	angle offset (rad)
TimeAxisStep	Input	number	40	Binning step size for the time axis. TOF for detector binning, wavelength for constant Q
CropFirstAndLastPoints	Input	boolean	True	If true, we crop the first and last points
CleanupBadData	Input	boolean	True	If true, we crop the points consistent with R=0
AcceptNullReflectivity	Input	boolean	False	If true, reflectivity curves consisting of all zeros are accepted as valid
ConstQTrim	Input	number	0.5	With const-Q binning, cut Q bins with contributions fewer than ConstQTrim of WL bins
SampleLength	Input	number	10	Length of the sample in mm
ConstantQBinning	Input	boolean	False	If true, we convert to Q before summing
DirectPixelOverwrite	Input	number	Optional	DIRPIX overwrite value
DAngle0Overwrite	Input	number	Optional	DANGLE0 overwrite value (degrees)
OutputWorkspace	Output	Workspace	Mandatory	Output workspace