GenerateFlatCellWorkspaceLOQ v1¶
Summary¶
Generates the FlatCell workspace for ISIS SANS reduction of LOQ.
Properties¶
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
InputWorkspace |
Input |
Mandatory |
An input event workspace. |
|
OutputWorkspace |
Output |
Mandatory |
An output event workspace. |
|
CreateMaskWorkspace |
Input |
boolean |
True |
Determines if masked workspace needs to be created. |
LABThresholdMultiplier |
Input |
number |
1 |
The parameter that is used to scale the standard deviation in order to set the masking threshold of the low angle bank. |
HABThresholdMultiplier |
Input |
number |
0.5 |
The parameter that is used to scale the standard deviation in order to set the masking threshold of the high angle bank. |
ApplyMaskDirectlyToWorkspace |
Input |
boolean |
False |
Determines if mask is directly applied to workspace. |
OutputMaskFilePath |
Input |
string |
Path to the detector mask XML file. It must be provided for the algorithm to create the xml file. |
Description¶
Creates the FlatCell workspace for the ISIS SANS reduction for LOQ. Outputs two Workspaces - The FlatCell and the MaskedBins Workspaces.
Usage¶
Running the GenerateFlatCellWorkspaceLOQ Algorithm with an event Workspace
# Load event workspace
LoadNexus(Filename="LOQ00113953.nxs", OutputWorkspace="FlatCellInput")
# Run the GenerateFlatCellWorkspaceLOQ Algorithm and save into output workspaces
GenerateFlatCellWorkspaceLOQ(InputWorkspace="FlatCellInput", OutputWorkspace="FlatCellOuput")
# Verify the changes are correct
print("The range of the output values is {}.".format(np.ptp(mtd['FlatCellOuput'].readY(0))))
Output:
The range of the output values is 1390.912709106737.
Categories: AlgorithmIndex | SANS
Source¶
C++ header: GenerateFlatCellWorkspaceLOQ.h
C++ source: GenerateFlatCellWorkspaceLOQ.cpp