/
AlphaCalc.h
58 lines (50 loc) · 2.01 KB
/
AlphaCalc.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source,
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidMuon/DllConfig.h"
namespace Mantid {
namespace Algorithms {
/**Muon algorithm for calculating the detector efficiency between two groups of
detectors.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the Workspace2D to take as input </LI>
<LI> ForwardSpectra - The spectra numbers of the forward group </LI>
<LI> BackwardSpectra - The spectra numbers of the backward group </LI>
<LI> FirstGoodValue - First good value </LI>
<LI> LastGoodValue - Last good value </LI>
<LI> Alpha (output) </LI>
</UL>
@author Anders Markvardsen, ISIS, RAL
@date 21/09/2010
*/
class MANTID_MUON_DLL AlphaCalc final : public API::Algorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "AlphaCalc"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Muon algorithm for calculating the detector efficiency between two "
"groups of detectors.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Muon"; }
/// See also
const std::vector<std::string> seeAlso() const override { return {"AsymmetryCalc", "CalculateMuonAsymmetry"}; };
private:
// Overridden Algorithm methods
void init() override;
void exec() override;
};
} // namespace Algorithms
} // namespace Mantid