\(\renewcommand\AA{\unicode{x212B}}\)
LiquidsReflectometryReduction v1¶
Summary¶
Liquids Reflectometer (REFL) reduction
Properties¶
Name |
Direction |
Type |
Default |
Description |
---|---|---|---|---|
RunNumbers |
Input |
str list |
List of run numbers to process |
|
InputWorkspace |
Input |
Optionally, we can provide a workspace directly |
||
NormalizationRunNumber |
Input |
long |
0 |
Run number of the normalization run to use |
SignalPeakPixelRange |
Input |
long 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 |
long list |
123,137 |
Pixel range defining the background. Default:(123,137) |
ErrorWeighting |
Input |
boolean |
False |
If True, a weighted average is used to to estimate the subtracted background.Otherwise, a simple average is used. |
NormFlag |
Input |
boolean |
True |
If true, the data will be normalized |
NormPeakPixelRange |
Input |
long 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 |
long list |
127,137 |
Pixel range defining the background for the normalization |
LowResDataAxisPixelRangeFlag |
Input |
boolean |
True |
If true, the low resolution direction of the data will be cropped according to the lowResDataAxisPixelRange property |
LowResDataAxisPixelRange |
Input |
long list |
115,210 |
Pixel range to use in the low resolution direction of the data |
LowResNormAxisPixelRangeFlag |
Input |
boolean |
True |
If true, the low resolution direction of the normalization run will be cropped according to the LowResNormAxisPixelRange property |
LowResNormAxisPixelRange |
Input |
long list |
115,210 |
Pixel range to use in the low resolution direction of the normalizaion run |
TOFRange |
Input |
dbl list |
0,340000 |
TOF range to use |
TOFRangeFlag |
Input |
boolean |
True |
If true, the TOF will be cropped according to the TOF range property |
QMin |
Input |
number |
0.05 |
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 (degrees) |
AngleOffsetError |
Input |
number |
0 |
Angle offset error (degrees) |
OutputWorkspace |
Output |
Mandatory |
Output workspace |
|
ApplyScalingFactor |
Input |
boolean |
True |
If true, the scaling from Scaling Factor file will be applied |
ScalingFactorFile |
Input |
string |
Scaling factor configuration file |
|
SlitTolerance |
Input |
number |
0.02 |
Tolerance for matching slit positions |
SlitsWidthFlag |
Input |
boolean |
True |
Looking for perfect match of slits width when using Scaling Factor file |
IncidentMediumSelected |
Input |
string |
Incident medium used for those runs |
|
GeometryCorrectionFlag |
Input |
boolean |
False |
Use or not the geometry correction |
FrontSlitName |
Input |
string |
S1 |
Name of the front slit |
BackSlitName |
Input |
string |
Si |
Name of the back slit |
TOFSteps |
Input |
number |
40 |
TOF step size |
CropFirstAndLastPoints |
Input |
boolean |
True |
If true, we crop the first and last points |
ApplyPrimaryFraction |
Input |
boolean |
False |
If true, the primary fraction correction will be applied |
PrimaryFractionRange |
Input |
long list |
117,197 |
Pixel range to use for calculating the primary fraction correction. |
Description¶
The workflow proceeds as follows:
Load the data to be reduced.
Crop to the specified TOF range.
Subtract the background and integrate over the low-resolution axis.
Normalize by the integrated current.
Crop to the reflectivity peak using the specified range.
Repeat steps 1 to 6 for the direct beam normalization run.
Sum up the pixels contained in the peak of the normalization run to obtain a TOF distribution.
Divide the TOF distribution of each signal pixel by the normalization distribution.
Apply the scaling factor.
Sum up the pixels within the reflectivity peak of the data.
Convert to Q.
Rebin the Q axis to the specified binning and crop out the first and last Q point.
Categories: AlgorithmIndex | Reflectometry\SNS
Source¶
Python: LiquidsReflectometryReduction.py