AsymmetryCalc dialog.
Table of Contents
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| InputWorkspace | Input | MatrixWorkspace | Mandatory | Name of the input workspace |
| OutputWorkspace | Output | MatrixWorkspace | Mandatory | The name of the workspace to be created as the output of the algorithm |
| ForwardSpectra | Input | int list | The spectra numbers of the forward group | |
| BackwardSpectra | Input | int list | The spectra numbers of the backward group | |
| Alpha | Input | number | 1 | The balance parameter (default 1) |
This algorithm is used to calculate the asymmetry for a Muon workspace. It first groups the input workspace according to the spectra numbers provided as ForwardSpectra and BackwardSpectra. If these properties are not supplied, the algorithm assumes that the first spectrum in the workspace is the forward group and the second one is the backward group. It then calculates the asymmetry as:
, where 
is the front spectra, 
is the back spectra
and 
is the balance parameter [1].
The errors in 
and 
are calculated
by adding the errors in and in quadrature; any
errors in are ignored. The errors for the asymmetry are
then calculated using the fractional error method with the values for
the errors in and .
The output workspace contains one set of data for the time of flight: the asymmetry and the asymmetry errors.
| [1] | See AlphaCalc v1 |
Example - Calculating asymmetry:
y = [1,2,3] + [3,1,12]
x = [1,2,3,4] * 2
e = [1,1,1] * 2
input = CreateWorkspace(x, y, e, NSpec=2)
asymmetry = AsymmetryCalc(input, Alpha=0.5)
print('Asymmetry: {}'.format(asymmetry.readY(0)))
print('Errors: {}'.format(asymmetry.readE(0)))
Output:
Asymmetry: [-0.2 0.6 -0.33333333]
Errors: [ 0.5396295 0.69971423 0.28688766]
Categories: Algorithms | Muon
C++ source: AsymmetryCalc.cpp (last modified: 2017-09-05)
C++ header: AsymmetryCalc.h (last modified: 2016-06-07)