SANSDirectBeamTransmission v1¶
Summary¶
Compute transmission using the direct beam method
Properties¶
Name |
Direction |
Type |
Default |
Description |
---|---|---|---|---|
InputWorkspace |
Input |
Mandatory |
||
SampleDataFilename |
Input |
string |
Mandatory |
Allowed values: [‘xml’, ‘nxs’, ‘nxs.h5’] |
EmptyDataFilename |
Input |
string |
Mandatory |
Allowed values: [‘xml’, ‘nxs’, ‘nxs.h5’] |
BeamRadius |
Input |
number |
3 |
Beam radius [pixels] |
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 |
BeamCenterX |
Input |
number |
0 |
Beam center position in X |
BeamCenterY |
Input |
number |
0 |
Beam center position in Y |
ReductionProperties |
Input |
string |
__sans_reduction_properties |
Property manager name for the reduction |
OutputWorkspace |
Output |
Mandatory |
Workspace containing the data corrected for the transmission. |
|
TransmissionWorkspace |
Output |
Workspace containing the fitted transmission distribution. |
||
RawTransmissionWorkspace |
Output |
Workspace containing the transmission distribution before fitting. |
||
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 direct beam 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 or EQSANSDirectBeamTransmission.
Categories: AlgorithmIndex | Workflow\SANS\UsesPropertyManager
Source¶
Python: SANSDirectBeamTransmission.py