\(\renewcommand\AA{\unicode{x212B}}\)
ReflectometryISISCreateTransmission v1¶
Summary¶
Create a transmission workspace for ISIS reflectometry data, including optional flood and background corrections.
See Also¶
ApplyFloodWorkspace, ReflectometryBackgroundSubtraction, CreateTransmissionWorkspaceAuto
Properties¶
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
InputRuns |
Input |
str list |
Mandatory |
A list of input run numbers. Multiple runs will be summed after loading |
ProcessingInstructions |
Input |
string |
Grouping pattern of spectrum numbers to yield only the detectors of interest. See GroupDetectors for syntax. |
|
I0MonitorIndex |
Input |
number |
Optional |
I0 monitor workspace index |
MonitorIntegrationWavelengthMin |
Input |
number |
Optional |
Wavelength minimum for integration in angstroms. |
MonitorIntegrationWavelengthMax |
Input |
number |
Optional |
Wavelength maximum for integration in angstroms. |
FloodWorkspace |
Input |
The workspace to be used for the flood correction. If this property is not set then no flood correction is performed. |
||
BackgroundProcessingInstructions |
Input |
string |
The set of workspace indices to be passed to the ProcessingInstructions property of the ReflectometryBackgroundSubtraction algorithm. If this property is not set then no background subtraction is performed. |
|
OutputWorkspace |
Output |
Mandatory |
The output transmission workspace |
Description¶
This algorithm creates a transmission workspace for ISIS reflectometry data. It is intended primarily for creating input transmission workspaces that are compatible with the PolarizationEfficienciesWildes v1 algorithm.
The InputRuns property takes a list of one or more run numbers. These are loaded and summed (if more than one) using LoadAndMerge v1.
If a FloodWorkspace is provided then a flood correction is performed using the ApplyFloodWorkspace v1 algorithm.
If workspace indices are provided to the BackgroundProcessingInstructions property then a background subtraction is performed using the ReflectometryBackgroundSubtraction v1 algorithm.
The subtraction uses PerDetectorAverage as the calculation method.
Finally, the transmission workspace is created by running CreateTransmissionWorkspaceAuto v2.
Usage¶
Example - ReflectometryISISCreateTransmission
transmission_grp = ReflectometryISISCreateTransmission(InputRuns="POLREF4699", ProcessingInstructions="5-244")
print(f"Output workspace group contains {transmission_grp.size()} single spectrum transmission workspaces.")
Output:
Output workspace group contains 2 single spectrum transmission workspaces.
Categories: AlgorithmIndex | Reflectometry\ISIS | Workflow\Reflectometry