CreateTransmissionWorkspaceAuto dialog.
Table of Contents
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| AnalysisMode | Input | string | PointDetectorAnalysis | Analysis Mode to Choose. Allowed values: [‘PointDetectorAnalysis’, ‘MultiDetectorAnalysis’] |
| FirstTransmissionRun | Input | MatrixWorkspace | Mandatory | Input workspace. |
| SecondTransmissionRun | Input | MatrixWorkspace | Second transmission run workspace in TOF. | |
| OutputWorkspace | Output | MatrixWorkspace | Mandatory | Output transmission workspace in wavelength. |
| Params | Input | dbl list | A comma separated list of first bin boundary, width, last bin boundary. These parameters are used for stitching together transmission runs. Values are in wavelength (angstroms). This input is only needed if a SecondTransmission run is provided. | |
| StartOverlap | Input | number | Optional | Start wavelength for stitching transmission runs together |
| EndOverlap | Input | number | Optional | End wavelength (angstroms) for stitching transmission runs together |
| I0MonitorIndex | Input | number | Optional | I0 monitor workspace index. Optional. |
| ProcessingInstructions | Input | string | Grouping pattern on workspace indexes to yield only the detectors of interest. See GroupDetectors for details. | |
| WavelengthMin | Input | number | Optional | Wavelength Min in angstroms |
| WavelengthMax | Input | number | Optional | Wavelength Max in angstroms |
| MonitorBackgroundWavelengthMin | Input | number | Optional | Monitor wavelength background min in angstroms |
| MonitorBackgroundWavelengthMax | Input | number | Optional | Monitor wavelength background max in angstroms |
| MonitorIntegrationWavelengthMin | Input | number | Optional | Monitor integral min in angstroms |
| MonitorIntegrationWavelengthMax | Input | number | Optional | Monitor integral max in angstroms |
Facade over CreateTransmissionWorkspace v2. Pulls numeric parameters out of the instrument parameters where possible. You can override any of these automatically applied defaults by providing your own value for the input.
If ProcessingInstructions is not set its value is inferred from other properties:
See CreateTransmissionWorkspace v2 for more information on the wrapped algorithm.
Note
To run these usage examples please first download the usage data, and add these to your path. In MantidPlot this is done using Manage User Directories.
Example - Create a transmission run
trans = Load(Filename='INTER00013463.nxs')
# Reduction overriding the default values for MonitorBackgroundWavelengthMin and MonitorBackgroundWavelengthMax which would otherwise be retirieved from the workspace
transWS = CreateTransmissionWorkspaceAuto(FirstTransmissionRun=trans, Version=1)
print("The first four transWS Y values are:")
for i in range (4):
print("{:.4f}".format(transWS.readY(0)[i]))
Output:
The first four transWS Y values are:
0.1647
0.1683
0.1761
0.1836
Example - Create a transmission run, overloading default parameters
trans = Load(Filename='INTER00013463.nxs')
# Reduction overriding the default values for MonitorBackgroundWavelengthMin and MonitorBackgroundWavelengthMax which would otherwise be retirieved from the workspace
transWS = CreateTransmissionWorkspaceAuto(FirstTransmissionRun=trans, MonitorBackgroundWavelengthMin=0.0, MonitorBackgroundWavelengthMax=1.0, Version=1)
print("The first four transWS Y values are:")
for i in range (4):
print("{:.4f}".format(transWS.readY(0)[i]))
Output:
The first four transWS Y values are:
0.1647
0.1683
0.1761
0.1836
Example - Create a transmission run from two runs
trans1 = Load(Filename='INTER00013463.nxs')
trans2 = Load(Filename='INTER00013464.nxs')
# Reduction overriding the default values for MonitorBackgroundWavelengthMin and MonitorBackgroundWavelengthMax which would otherwise be retirieved from the workspace
transWS = CreateTransmissionWorkspaceAuto(FirstTransmissionRun=trans1, SecondTransmissionRun=trans2, Params=[1.5,0.02,17], StartOverlap=10.0, EndOverlap=12.0, Version=1)
print("The first four transWS Y values are:")
for i in range (4):
print("{:.4f}".format(transWS.readY(0)[i]))
Output:
The first four transWS Y values are:
0.0000
0.0126
0.0579
0.0579
Categories: AlgorithmIndex | Reflectometry\ISIS
C++ source: CreateTransmissionWorkspaceAuto.cpp (last modified: 2019-07-17)
C++ header: CreateTransmissionWorkspaceAuto.h (last modified: 2018-10-05)