HFIRPowderReduction v1¶
Summary¶
Powder reduction for HFIR instruments
Properties¶
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
SampleFilename |
Input |
list of str lists |
Sample files to Load. Allowed extensions: [‘.nxs.h5’] |
|
SampleIPTS |
Input |
number |
Optional |
Sample IPTS number to load from |
SampleRunNumbers |
Input |
int list |
Sample run numbers to load |
|
VanadiumFilename |
Input |
list of str lists |
Vanadium files to Load. Allowed extensions: [‘.nxs.h5’] |
|
VanadiumIPTS |
Input |
number |
Optional |
Vanadium IPTS number to load from |
VanadiumRunNumbers |
Input |
int list |
Vanadium run numbers to load |
|
VanadiumBackgroundFilename |
Input |
list of str lists |
Vanadium background files to Load. Allowed extensions: [‘.nxs.h5’] |
|
VanadiumBackgroundIPTS |
Input |
number |
Optional |
Vanadium background IPTS number to load from |
VanadiumBackgroundRunNumbers |
Input |
int list |
Vanadium background run numbers to load |
|
SampleBackgroundFilename |
Input |
list of str lists |
Sample background files to Load. Allowed extensions: [‘.nxs.h5’] |
|
SampleBackgroundIPTS |
Input |
number |
Optional |
Sample background IPTS number to load from |
SampleBackgroundRunNumbers |
Input |
int list |
Sample background run numbers to load |
|
ApplyMask |
Input |
boolean |
True |
If True standard masking will be applied to the workspace |
Grouping |
Input |
string |
None |
Group pixels. Allowed values: [‘None’, ‘2x2’, ‘4x4’] |
Instrument |
Input |
string |
HB2 Instrument. Allowed values: [‘’, ‘MIDAS’, ‘WAND^2’] |
|
Wavelength |
Input |
number |
Optional |
Incident wavelength (A) |
VanadiumDiameter |
Input |
number |
Optional |
Vanadium rod diamter (cm) |
XUnits |
Input |
string |
2Theta |
The unit to which spectrum axis is converted to. Allowed values: [‘2Theta’, ‘d-spacing’, ‘Q’] |
XMin |
Input |
dbl list |
A comma separated list of the XMin for every spectrum. (Optional) |
|
XMax |
Input |
dbl list |
A comma separated list of the XMax for every spectrum. (Optional) |
|
XBinWidth |
Input |
number |
0 |
Bin width for each spectrum |
Scale |
Input |
number |
1 |
The background will be scaled by this number before being subtracted. |
NormaliseBy |
Input |
string |
Monitor |
Normalise to monitor or time. Allowed values: [‘None’, ‘Time’, ‘Monitor’] |
MaskWorkspace |
Input |
MaskWorkspace |
The mask from this workspace will be applied before reduction |
|
MaskAngle |
Input |
number |
Optional |
Out of plane (phi) angle above which data will be masked |
AttenuationmuR |
Input |
number |
Optional |
muR for sample attenuation correction |
Sum |
Input |
boolean |
False |
Specifies either single output workspace or output group workspace containing several workspaces. |
Description¶
This algorithm is used to reduce powder diffraction data from the HFIR instruments at ORNL. It is a workflow algorithm that uses several other algorithms to perform the reduction. The input data can be specified either as a list of files or as an IPTS number and a list of run numbers. This works for both WAND and MIDAS instruments.
Categories: AlgorithmIndex | DataHandling\Nexus
Source¶
Python: HFIRPowderReduction.py