SANSCreateAdjustmentWorkspaces dialog.
Table of Contents
Calculates wavelength adjustment, pixel adjustment workspaces and wavelength-and-pixel adjustment workspaces.
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| SANSState | Input | Dictionary | A property manager which fulfills the SANSState contract. | |
| TransmissionWorkspace | Input | MatrixWorkspace | The transmission workspace. | |
| DirectWorkspace | Input | MatrixWorkspace | The direct workspace. | |
| MonitorWorkspace | Input | MatrixWorkspace | The scatter monitor workspace. This workspace only contains monitors. | |
| SampleData | Input | MatrixWorkspace | A workspace cropped to the detector to be reduced (the SAME as the input to Q1D). This used to verify the solid angle. The workspace is not modified, just inspected. | |
| Component | Input | string | LAB | The component of the instrument which is currently being investigated. Allowed values: [‘HAB’, ‘LAB’] |
| DataType | Input | string | Sample | The component of the instrument which is to be reduced. Allowed values: [‘Sample’, ‘Can’] |
| SliceEventFactor | Input | number | 1 | The slice factor for the monitor normalization. This factor is the one obtained from event slicing. |
| OutputWorkspaceWavelengthAdjustment | Output | MatrixWorkspace | Mandatory | The workspace for wavelength-based adjustments. |
| OutputWorkspacePixelAdjustment | Output | MatrixWorkspace | Mandatory | The workspace for wavelength-based adjustments. |
| OutputWorkspaceWavelengthAndPixelAdjustment | Output | MatrixWorkspace | Mandatory | The workspace for, both, wavelength- and pixel-based adjustments. |
| CalculatedTransmissionWorkspace | Output | MatrixWorkspace | The calculated transmission workspace | |
| UnfittedTransmissionWorkspace | Output | MatrixWorkspace | The unfitted transmission workspace |
This algorithm provides a wavelength-adjustment workspace, a pixel-adjustment workspace and a wavelength-and-pixel-adjustment workspace which are used in Q1D v2 or Qxy v1. The wavelength-adjustment and the pixel-adjustment workspaces are obtained from SANSCreateWavelengthAndPixelAdjustment v1 and the wavelength-and-pixel-adjustment workspace is obtained from SANSWideAngleCorrection v1. The relevant settings are provided via the state object. Note that none of these workspaces is required for a minimal reduction.
Currently the mask mechanism is implemented for SANS2D, LOQ and LARMOR.
The required information for the creation of the wavelength-adjustment workspace, the pixel-adjustment workspace and the wavelength-and-pixel-adjustment workspace is retrieved from a state object. Note that this state is a composite of states which are consumed in the child algorithms.
The elements are:
| Entry | Type | Description | Mandatory | Default |
|---|---|---|---|---|
| calculate_transmission | sub state | State used in SANSCalculateTransmission v1 | Yes | None |
| normalize_to_monitor | sub state | State used in SANSNormalizeToMonitor v1 | Yes | None |
| wavelength_and_pixel_adjustment | sub state | State used in SANSCreateWavelengthAndPixelAdjustment v1 | Yes | None |
| wide_angle_correction | Bool | The wavelength step type | No | False |
Note that these settings should be only populated via the GUI or the Python Interface of ISIS SANS.
Categories: Algorithm Index | SANS\Adjust
Python: SANSCreateAdjustmentWorkspaces.py (last modified: 2019-01-30)