/
ExponentialCorrection.h
90 lines (76 loc) · 3.4 KB
/
ExponentialCorrection.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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
#ifndef MANTID_ALGORITHMS_EXPONENTIALCORRECTION_H_
#define MANTID_ALGORITHMS_EXPONENTIALCORRECTION_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAlgorithms/UnaryOperation.h"
namespace Mantid {
namespace Algorithms {
/**
Corrects the data and error values on a workspace by the value of an exponential
function
which is evaluated at the X value of each data point: c0*exp(-c1*x).
The data and error values are either divided or multiplied by the value of this
function.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the workspace to correct</LI>
<LI> OutputWorkspace - The name of the corrected workspace (can be the same as
the input one)</LI>
<LI> c0 - The value by which the entire exponent calculation is
multiplied (see above)</LI>
<LI> c1 - The value by which the x value is multiplied prior to
exponentiation (see above)</LI>
<LI> Operation - Whether to divide (the default) or multiply the data by
the correction function</LI>
</UL>
@author Russell Taylor, Tessella plc
@date 24/03/2009
Copyright © 2009 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
National Laboratory & European Spallation Source
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://github.com/mantidproject/mantid>
*/
class DLLExport ExponentialCorrection : public UnaryOperation {
public:
/// Default constructor
ExponentialCorrection();
/// Destructor
~ExponentialCorrection() override{};
/// Algorithm's name for identification
const std::string name() const override { return "ExponentialCorrection"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Corrects the data in a workspace by the value of an "
"exponential function which is evaluated at the X value of each "
"data point.";
}
/// Algorithm's version for identification
int version() const override { return 1; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "CorrectionFunctions"; }
private:
// Overridden UnaryOperation methods
void defineProperties() override;
void retrieveProperties() override;
void performUnaryOperation(const double XIn, const double YIn,
const double EIn, double &YOut,
double &EOut) override;
double m_c0, ///< The constant by which to multiply the exponential
m_c1; ///< The constant term in the exponent
bool m_divide; ///< Whether the data should be divided by the correction
///(true) or multiplied by it (false)
};
} // namespace Algorithms
} // namespace Mantid
#endif /*MANTID_ALGORITHMS_EXPONENTIALCORRECTION_H_*/