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’] |
|
IDFFilename |
Input |
string |
Optional instrument definition file (IDF). If provided, it overrides the instrument geometry that would otherwise be determined by the sample file. Allowed extensions: [‘.xml’] |
|
Wavelength |
Input |
number |
Optional |
Incident wavelength (A) |
VanadiumDiameter |
Input |
number |
Optional |
Vanadium rod diamter (cm) |
VanadiumHeight |
Input |
number |
3 |
Vanadium rod height (cm) |
DoAttenuationCorrection |
Input |
boolean |
False |
If True, apply sample attenuation (absorption) correction using CylinderAbsorptionCW |
DoMultipleScatteringCorrection |
Input |
boolean |
False |
If True, calculate and apply multiple scattering correction for the sample |
AbsoluteIntensityUnits |
Input |
boolean |
False |
If True, output in absolute intensity units (mb/sr/f.u.) |
SampleChemicalFormula |
Input |
string |
Chemical formula of the sample (e.g. ‘Fe2O3’) |
|
SampleCrystalDensity |
Input |
number |
Optional |
Crystal density of the sample (g/cm3) |
SamplePackingFraction |
Input |
number |
0.5 |
Packing fraction for the sample powder (default 0.5) |
SampleDiameter |
Input |
number |
Optional |
Sample diameter (cm) |
SampleHeight |
Input |
number |
0 |
Sample height (cm). Required for multiple scattering and absolute intensity units. |
SampleBackgroundScaleFactor |
Input |
number |
1 |
Scale factor (fB) applied to sample background before subtraction |
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.1 |
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 |
Sum |
Input |
boolean |
False |
Specifies either single output workspace or output group workspace containing several workspaces. |
OutputWorkspace |
Output |
Mandatory |
Output Workspace |
|
OutputDirectory |
Input |
string |
~/HFIRPowderReductionOutput |
Allowed extensions: [‘.dat’] |
Overwrite |
Input |
boolean |
True |
If True previous file will be overwritten |
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. Reducing WAND^2 data with HFIRPowderReduction is very similar to using WANDPowderReduction v1, but with some differences in the input parameters, and reduction steps are slightly modified.
By default the instrument geometry is determined by the sample file. An instrument definition file (IDF) can
optionally be supplied through the IDFFilename property to override the geometry used by the sample file.
Categories: AlgorithmIndex | DataHandling\Nexus
Source#
Python: HFIRPowderReduction.py