\(\renewcommand\AA{\unicode{x212B}}\)
AssertSpinStateOrder v1¶
Summary¶
Assert that the given Polarized SANS data has the given spin state order using DetermineSpinStateOrder.
See Also¶
Properties¶
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
InputWorkspace |
Input |
WorkspaceGroup |
Mandatory |
Polarized SANS runs with 4 periods (workspace group with 4 entries). |
ExpectedSpinStates |
Input |
string |
Mandatory |
Comma separate list of spin states (e.g “00,01,10,11”) in the expected order of the group workspace periods. |
Reorder |
Input |
boolean |
False |
If set to true, if the workspace has its periods in a different order, reorder the workspace to match ExpectedSpinStates. |
Result |
Output |
boolean |
Bool value stating whether the input workspace was found to have the same ordering as the ExpectSpinStates string |
Description¶
Assert that the given Polarized SANS data (from either ZOOM or LARMOR) has the expected spin state order using DetermineSpinStateOrder. If the order of the data is found to be different from the given spin state order string, and Reorder is True, then the child workspaces of the input group will be reordered to match the input string.
Categories: AlgorithmIndex | SANS
Source¶
Python: AssertSpinStateOrder.py