SANSCreateWavelengthAndPixelAdjustment v1¶

SANSCreateWavelengthAndPixelAdjustment dialog.

Table of Contents

Summary
Properties
Description
- Relevant SANSState entries for SANSCreateWavelengthAndPixelAdjustment
Source

Summary ¶

Calculates wavelength adjustment and pixel adjustment workspaces.

Properties ¶

Name	Direction	Type	Default	Description
SANSState	Input	Dictionary		A property manager which fulfills the SANSState contract.
TransmissionWorkspace	Input	MatrixWorkspace		The calculated transmission workspace in wavelength units.
NormalizeToMonitorWorkspace	Input	MatrixWorkspace	Mandatory	The monitor normalization workspace in wavelength units.
Component	Input	string	LAB	The component of the instrument which is currently being investigated. Allowed values: [‘HAB’, ‘LAB’]
OutputWorkspaceWavelengthAdjustment	Output	MatrixWorkspace	Mandatory	A wavelength adjustment output workspace.
OutputWorkspacePixelAdjustment	Output	MatrixWorkspace	Mandatory	A pixel adjustment output workspace.

This algorithm provides a wavelength-adjustment workspace and a pixel-adjustment workspace which are used in Q1D v2 or Qxy v1. The wavelength-adjustment workspace is created by combining the transmission workspace obtained from SANSCalculateTransmission v1, the monitor normalization workspace obtained from SANSNormalizeToMonitor v1 and efficiency correction files which are provided by the state object. The pixel-adjustment settings are also obtained from the state object.

Currently the mask mechanism is implemented for SANS2D, LOQ and LARMOR.

Relevant SANSState entries for SANSCreateWavelengthAndPixelAdjustment ¶

The required information for the creation of the wavelength-adjustment workspace and the pixel-adjustment workspace is retrieved from a state object.

The elements are:

Entry	Type	Description	Mandatory	Default
wavelength_low	Float	Lower wavelength bound	No	None
wavelength_high	Float	Upper wavelength bound	No	None
wavelength_step	Float	Wavelength step	No	None
wavelength_step_type	RangeStepType enum	The wavelength step type	No	None
adjustment_files	Dict	Detector vs StateAdjustmentFiles object	No	None
idf_path	String	The path to the IDF	auto setup	auto