SANSBeamSpreaderTransmission v1¶
Summary¶
Compute transmission using the beam spreader method
Properties¶
Name |
Direction |
Type |
Default |
Description |
---|---|---|---|---|
InputWorkspace |
Input |
Mandatory |
||
SampleSpreaderFilename |
Input |
string |
Mandatory |
Allowed values: [‘xml’, ‘nxs’, ‘nxs.h5’] |
DirectSpreaderFilename |
Input |
string |
Mandatory |
Allowed values: [‘xml’, ‘nxs’, ‘nxs.h5’] |
SampleScatteringFilename |
Input |
string |
Mandatory |
Allowed values: [‘xml’, ‘nxs’, ‘nxs.h5’] |
DirectScatteringFilename |
Input |
string |
Mandatory |
Allowed values: [‘xml’, ‘nxs’, ‘nxs.h5’] |
SpreaderTransmissionValue |
Input |
number |
1 |
Transmission of the beam spreader |
SpreaderTransmissionError |
Input |
number |
0 |
Error on the transmission of the beam spreader |
ThetaDependent |
Input |
boolean |
True |
If true, a theta-dependent correction will be applied |
DarkCurrentFilename |
Input |
string |
Allowed values: [‘xml’, ‘nxs’, ‘nxs.h5’] |
|
UseSampleDarkCurrent |
Input |
boolean |
False |
If true, the sample dark current will be used |
ReductionProperties |
Input |
string |
__sans_reduction_properties |
Property manager name for the reduction |
OutputWorkspace |
Output |
Mandatory |
||
MeasuredTransmission |
Output |
number |
||
MeasuredError |
Output |
number |
||
OutputMessage |
Output |
string |
Output message |
Description¶
Worfklow algorithm used to compute and apply the sample transmission correction using the beam spreader (“glassy carbon”) method. The transmission is calculated by the CalculateTransmission as follows:
where
For each detector pixel, the transmission correction is applied by the ApplyTransmissionCorrection as follows:
This algorithm is rarely called directly. It is called by HFIRSANSReduction.
Categories: AlgorithmIndex | Workflow\SANS\UsesPropertyManager
Source¶
Python: SANSBeamSpreaderTransmission.py