-
Notifications
You must be signed in to change notification settings - Fork 122
/
BackToBackExponential.h
95 lines (78 loc) · 3.64 KB
/
BackToBackExponential.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
91
92
93
94
95
#ifndef MANTID_CURVEFITTING_BACKTOBACKEXPONENTIAL_H_
#define MANTID_CURVEFITTING_BACKTOBACKEXPONENTIAL_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/IPeakFunction.h"
namespace Mantid {
namespace CurveFitting {
namespace Functions {
/**
Provide BackToBackExponential peak shape function interface to IPeakFunction.
That is the function:
I*(A*B/(A+B)/2)*(exp(A/2*(A*S^2+2*(x-X0)))*erfc((A*S^2+(x-X0))/sqrt(2*S^2))+exp(B/2*(B*S^2-2*(x-X0)))*erfc((B*S^2-(x-X0))/sqrt(2*S^2))).
Function parameters:
<UL>
<LI> I - Integrated intensity of peak (default 0.0)</LI>
<LI> A - exponential constant of rising part of neutron pulse (default 1.0)</LI>
<LI> B - exponential constant of decaying part of neutron pulse (default
0.05)</LI>
<LI> X0 - peak position (default 0.0)</LI>
<LI> S - standard deviation of gaussian part of peakshape function (default
1.0)</LI>
</UL>
@author Anders Markvardsen, ISIS, RAL
@date 9/11/2009
Copyright © 2007-8 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>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport BackToBackExponential : public API::IPeakFunction {
public:
/// Default constructor.
BackToBackExponential() : API::IPeakFunction() {}
/// overwrite IPeakFunction base class methods
double centre() const override { return getParameter("X0"); }
void setCentre(const double c) override { setParameter("X0", c); }
double height() const override;
void setHeight(const double h) override;
double fwhm() const override;
void setFwhm(const double w) override;
double intensity() const override { return getParameter("I"); }
void setIntensity(const double newIntensity) override {
setParameter("I", newIntensity);
}
/// overwrite IFunction base class methods
std::string name() const override { return "BackToBackExponential"; }
const std::string category() const override { return "Peak"; }
void function1D(double *out, const double *xValues,
const size_t nData) const override;
void functionDeriv1D(API::Jacobian *jacobian, const double *xValues,
const size_t nData) override;
protected:
/// overwrite IFunction base class method, which declare function parameters
void init() override;
/// Function evaluation method to be implemented in the inherited classes
void functionLocal(double *, const double *, const size_t) const override {}
/// Derivative evaluation method to be implemented in the inherited classes
void functionDerivLocal(API::Jacobian *, const double *,
const size_t) override {}
double expWidth() const;
};
typedef boost::shared_ptr<BackToBackExponential> BackToBackExponential_sptr;
} // namespace Functions
} // namespace CurveFitting
} // namespace Mantid
#endif /*MANTID_CURVEFITTING_BACKTOBACKEXPONENTIAL_H_*/