-
Notifications
You must be signed in to change notification settings - Fork 122
/
Lorentzian.h
75 lines (67 loc) · 3.03 KB
/
Lorentzian.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
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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/IPeakFunction.h"
#include "MantidCurveFitting/DllConfig.h"
namespace Mantid {
namespace CurveFitting {
namespace Functions {
/**
Provide lorentzian peak shape function interface to IPeakFunction.
I.e. the function: \f$ \frac{A}{\pi}( \Gamma/2((x-PeakCentre)^2+(\Gamma/2)^2)
)\f$.
\f$\Gamma/2\f$ (HWHM) - half-width at half-maximum
Lorentzian parameters:
<UL>
<LI> Amplitude - Intensity scaling (default 1.0)</LI>
<LI> PeakCentre - centre of peak (default 0.0)</LI>
<LI> FWHM - Full-width half-maximum (default 0.0)</LI>
</UL>
*/
class MANTID_CURVEFITTING_DLL Lorentzian : public API::IPeakFunction {
public:
Lorentzian();
/// overwrite IPeakFunction base class methods
double centre() const override { return getParameter("PeakCentre"); }
double height() const override;
double fwhm() const override { return getParameter("FWHM"); }
double intensity() const override { return getParameter("Amplitude"); }
double intensityError() const override { return getError("Amplitude"); }
void setCentre(const double c) override { setParameter("PeakCentre", c); }
void setHeight(const double h) override;
void setFwhm(const double w) override;
void setIntensity(const double i) override { setParameter("Amplitude", i); }
void fixCentre(bool isDefault = false) override;
void unfixCentre() override;
void fixIntensity(bool isDefault = false) override;
void unfixIntensity() override;
/// overwrite IFunction base class methods
std::string name() const override { return "Lorentzian"; }
const std::string category() const override { return "Peak; Muon\\MuonModelling"; }
protected:
void functionLocal(double *out, const double *xValues, const size_t nData) const override;
void functionDerivLocal(API::Jacobian *out, const double *xValues, const size_t nData) override;
/// overwrite IFunction base class method, which declare function parameters
void init() override;
/// Calculate histogram data.
void histogram1D(double *out, double left, const double *right, const size_t nBins) const override;
/// Devivatives of the histogram.
void histogramDerivative1D(API::Jacobian *jacobian, double left, const double *right,
const size_t nBins) const override;
private:
/// When Amplitude is set via setHeight() and fwhm() == 0 height is made equal
/// to Amplitude.
/// The flag is used after that when FWHM is set to non-zero value.
/// The height in this case must remain the same but amplitude change.
bool m_amplitudeEqualHeight;
};
} // namespace Functions
} // namespace CurveFitting
} // namespace Mantid