-
Notifications
You must be signed in to change notification settings - Fork 122
/
ConvertFitFunctionForMuonTFAsymmetry.h
76 lines (68 loc) · 2.71 KB
/
ConvertFitFunctionForMuonTFAsymmetry.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
65
66
67
68
69
70
71
72
73
74
75
76
// 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 "MantidAPI/IFunction.h"
#include "MantidMuon/DllConfig.h"
namespace Mantid {
namespace Muon {
/**Takes a fitting function and returns a modified fitting function.
To be used as part of TF asymmetry calculations
Required Properties:
<UL>
<LI> InputFunction - The function we want to change </LI>
<LI> NormalisationTable - The name of the table workspace that contains the
normalization constants
</LI>
<LI> WorkspaceList - The workspaces we are interested in </LI>
<LI> Mode - If constructing or destructing the TF asymmetry function </LI>
<LI> OutputFunction - The transformed function </LI>
</UL>
@author Anthony Lim
@date 22/05/2018
*/
class MANTID_MUON_DLL ConvertFitFunctionForMuonTFAsymmetry
: public API::Algorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override {
return "ConvertFitFunctionForMuonTFAsymmetry";
}
/// Summary of algorithms purpose
const std::string summary() const override {
return "This algorithm converts adds/removes "
"the normalisation to the fit function for calculating the TF "
"asymmetry.";
}
/// 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"; }
/// Algorithm's seeAlso
const std::vector<std::string> seeAlso() const override {
return {"Fit", "EstimateMuonAsymmetryFromCounts", "CalculateMuonAsymmetry"};
}
private:
// Overridden Algorithm methods
void init() override;
void exec() override;
std::map<std::string, std::string> validateInputs() override;
Mantid::API::IFunction_sptr
getTFAsymmFitFunction(const Mantid::API::IFunction_sptr &original,
const std::vector<double> &norms);
Mantid::API::IFunction_sptr
extractFromTFAsymmFitFunction(const Mantid::API::IFunction_sptr &original);
Mantid::API::IFunction_sptr
extractUserFunction(const Mantid::API::IFunction_sptr &TFFunc);
void setOutput(const Mantid::API::IFunction_sptr &function);
std::vector<double> getNorms();
};
} // namespace Muon
} // namespace Mantid