-
Notifications
You must be signed in to change notification settings - Fork 122
/
AsymmetryCalc.h
64 lines (55 loc) · 2.2 KB
/
AsymmetryCalc.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
59
60
61
62
63
64
// 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 {
/**Takes a muon workspace as input and sums all the spectra into two spectra
which represent
the two detector groupings. The resultant spectra are used to calculate
(F-aB) / (F+aB) the results of which
are stored in the output workspace.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the Workspace2D to take as input </LI>
<LI> OutputWorkspace - The name of the workspace in which to store the result
</LI>
<LI> ForwardSpectra - The detector number of the first group </LI>
<LI> BackwardSpectra - The detector number of the second group </LI>
<LI> Alpha - ?? </LI>
</UL>
@author
@date 11/07/2008
*/
class MANTID_MUON_DLL AsymmetryCalc : public API::Algorithm {
public:
virtual ~AsymmetryCalc() = default;
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "AsymmetryCalc"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Calculates the asymmetry between two groups of detectors for a "
"muon workspace.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override { return {"CalculateMuonAsymmetry"}; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Muon"; }
protected:
std::map<std::string, std::string> validateInputs() override;
private:
// Overridden Algorithm methods
void init() override;
void exec() override;
};
} // namespace Algorithms
} // namespace Mantid