Table of Contents
Name | Direction | Type | Default | Description |
---|---|---|---|---|
InputWorkspace | Input | MatrixWorkspace | Mandatory | An input workspace. |
ComponentNames | Input | str list | Mandatory | List of instrument components to perform the corrections for. |
OutputWorkspace | Output | MatrixWorkspace | Mandatory | An output workspace. |
This algorithm performs a geometrical correction for the so-called parallax effect in tube based SANS instruments.
The correction formula must be specified in the IPF as follows:
if direction is y, and
if direction is x.
are the coordinates of the detector pixel in the system where sample is at
and
is the beam axis.
in radians.
The correction will be calculated for each pixel and the input data will be divided by the correction and stored in the output.
The instrument parameters must be defined for detector components and without loss of generality, different components can have different formulae.
At least one component name must be given as input.
<component-link name="some_bank">
<parameter name="parallax" type="string">
<!-- Normally, the function would be increasing with t -->
<value val="1 + 0.01 * t"/>
</parameter>
<parameter name="direction" type="string">
<value val="x"/>
</parameter>
</component-link>
Example - ParallaxCorrection
CreateSampleWorkspace(NumBanks=1, XMin=1, XMax=2, BinWidth=1, BankPixelWidth=100, Function="One Peak", XUnit="Wavelength", OutputWorkspace="in")
SetInstrumentParameter(Workspace="in", ParameterName="direction", ComponentName="bank1", ParameterType="String", Value="y")
SetInstrumentParameter(Workspace="in", ParameterName="parallax", ComponentName="bank1", ParameterType="String", Value="1+0.1*t")
ParallaxCorrection(InputWorkspace="in", ComponentNames="bank1", OutputWorkspace="out")
Divide(LHSWorkspace="in", RHSWorkspace="out", OutputWorkspace="corr")
print("The correction is {0:.4f} for the spectrum {1}".format(mtd["corr"].readY(1000)[0], 1000))
Output:
The correction is 1.0016 for the spectrum 1000
Below is an example of the corrections for the instrument D22. The tubes are vertical, the magnitude depends only on the horizontal coordinate. The correction increases with increasing angle from the beam, reaching about 10% for the outmost tube for detector distance of 1.5 meters.
Categories: Algorithm Index | SANS
C++ source: ParallaxCorrection.cpp (last modified: 2018-12-04)
C++ header: ParallaxCorrection.h (last modified: 2018-12-03)