\(\renewcommand\AA{\unicode{x212B}}\)
Table of Contents
Name | Direction | Type | Default | Description |
---|---|---|---|---|
Filename | Input | string | Data file to reduce. Allowed extensions: [‘.nxs’] | |
InputWorkspace | Input | Workspace | Optionally, we can provide a workspace directly | |
TemplateFile | Input | string | Template reduction file. Allowed extensions: [‘.xml’] | |
ScaleToUnity | Input | boolean | True | If true, the reflectivity under the Q cutoff will be scaled to 1 |
PrimaryFractionRange | Input | long list | 117,197 | Pixel range to use for calculating the primary fraction correction. |
DirectBeamList | Input | long list | List of direct beam run numbers (integers) | |
ScalingFactorFile | Input | string | Scaling factor file. Allowed extensions: [‘.cfg’, ‘.txt’] | |
IncidentMedium | Input | string | medium | Name of the incident medium |
ScalingFactorTOFStep | Input | number | 200 | Bin width in TOF for fitting scaling factors |
WavelengthOffset | Input | number | 0 | Wavelength offset used for TOF range determination |
ScalingWavelengthCutoff | Input | number | 10 | Wavelength above which the scaling factors are assumed to be one |
FindPeaks | Input | boolean | False | Find reflectivity peaks instead of using the template values |
ReadSequenceFromFile | Input | boolean | False | Read the run sequence information from the file, not the title |
ForceSequenceNumber | Input | number | 0 | Force the sequence number value if it’s not available |
OrderDirectBeamsByRunNumber | Input | boolean | False | Force the sequence of direct beam files to be ordered by run number |
OutputFilename | Input | string | Name of the reflectivity file output. Allowed values: [‘txt’] | |
OutputDirectory | Input | string | Mandatory | |
SequenceInfo | Output | long list | Run sequence information (run number, sequence ID, sequence number). | |
SlitTolerance | Input | number | 0.02 | Tolerance for matching slit positions |
NormalizationType | Input | string | DirectBeam | Normalization type for reduction. Allowed values: [‘DirectBeam’, ‘WithReference’] |
Refl1DModelParameters | Input | string | JSON string for Refl1D theoretical model parameters for ‘NormalizationType’==’WithReference’ |
This algorithm gathers the information needed to launch the LR reduction. It is called by the post-processing system after a new data file is created.
If a reduction template file is provided, the reduction will use the options in that file. If no reduction template is provided, reduction parameters will be read from the Nexus file.
For sample data runs, the LiquidsReflectometryReduction algorithm is called to perform the reduction, followed by the LRReflectivityOutput algorithm to put the different pieces of the reduced data into a single reflectivity file.
For direct beams, the LRDirectBeamSort workflow algorithm is called to generate a scaling factor file.
Categories: AlgorithmIndex | Reflectometry\SNS
Python: LRAutoReduction.py (last modified: 2020-06-30)