\(\renewcommand\AA{\unicode{x212B}}\)

CorrectToFile v1

../_images/CorrectToFile-v1_dlg.png

CorrectToFile dialog.

Summary

Correct data using a file in the LOQ RKH format

Properties

Name

Direction

Type

Default

Description

WorkspaceToCorrect

Input

MatrixWorkspace

Mandatory

Name of the input workspace

Filename

Input

string

Mandatory

The file containing the correction factors

FirstColumnValue

Input

string

Wavelength

The units of the first column of the correction file (default wavelength). Allowed values: [‘AtomicDistance’, ‘Degrees’, ‘DeltaE’, ‘DeltaE_inFrequency’, ‘DeltaE_inWavenumber’, ‘dSpacing’, ‘dSpacingPerpendicular’, ‘Empty’, ‘Energy’, ‘Energy_inWavenumber’, ‘Label’, ‘Momentum’, ‘MomentumTransfer’, ‘Phi’, ‘QSquared’, ‘SpinEchoLength’, ‘SpinEchoTime’, ‘Temperature’, ‘Time’, ‘TOF’, ‘Wavelength’, ‘SpectrumNumber’]

WorkspaceOperation

Input

string

Divide

Allowed values: Divide, Multiply (default is divide). Allowed values: [‘Divide’, ‘Multiply’]

OutputWorkspace

Output

MatrixWorkspace

Mandatory

Name of the output workspace to store the results in

Description

Use data from the supplied file, written in the RKH format, to correct the input data. The operations allowed for the correction are multiply and divide.

Allowed correction files may contain one spectrum with many bins or many spectra each with one bin. If the are many bins then the FirstColumnValue must match the units of the (X-values on the) workspace on the InputWorkspace. When there are many spectra (e.g. flood correction files) FirstColumnValue must be set to “SpectrumNumber” and the number of spectra in the file and workspace must match.

Categories: AlgorithmIndex | SANS | CorrectionFunctions

Source

C++ header: CorrectToFile.h

C++ source: CorrectToFile.cpp