AsymmetryCalc v1¶
Summary¶
Calculates the asymmetry between two groups of detectors for a muon workspace.
See Also¶
Properties¶
Name |
Direction |
Type |
Default |
Description |
---|---|---|---|---|
InputWorkspace |
Input |
Mandatory |
Name of the input workspace |
|
OutputWorkspace |
Output |
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) |
Description¶
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,
where
The error in
Then the error in the asymmetry is given by;
using the fact that the errors on counts
If any bins have
The output workspace contains one set of data for the time of flight: the asymmetry and the asymmetry errors.
Usage¶
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: AlgorithmIndex | Muon
Source¶
C++ header: AsymmetryCalc.h
C++ source: AsymmetryCalc.cpp