SANSSubtract v1#
Summary#
Subtract background from an I(Q) distribution.
See Also#
Properties#
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
DataDistribution |
Input |
string |
Name of the input workspace or file path |
|
Background |
Input |
string |
Name of the background workspace or file path |
|
ScaleFactor |
Input |
number |
1 |
Scaling factor [Default: 1] |
Constant |
Input |
number |
0 |
Additive constant [Default:0] |
OutputDirectory |
Input |
string |
Directory to write the output files in [optional] |
|
OutputWorkspace |
Output |
Mandatory |
Workspace containing data from detectors |
Description#
Subtract background from an I(Q) distribution.
The DataDistribution and Background properties can either be the name of a workspace or a file path. If a file path is provided, it will be loaded and assumed to be in units of Q.
The output workspace will be equal to:
The Dq values are propagated from the DataDistribution workspace to the output workspace as-is.
If the OutputDirectory property is filled, the output workspace will be written to disk. Two files will be produced, a 4 column ASCII file and a CanSAS XML file.
Categories: AlgorithmIndex | SANS
Source#
Python: SANSSubtract.py