Mantid
Loading...
Searching...
No Matches
Voigt.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2012 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
10#include "MantidCurveFitting/DllConfig.h"
11
12namespace Mantid {
13namespace CurveFitting {
14namespace Functions {
15
21class MANTID_CURVEFITTING_DLL Voigt : public API::IPeakFunction {
22private:
24 std::string name() const override { return "Voigt"; }
26 void declareParameters() override;
27
29 void functionLocal(double *out, const double *xValues, const size_t nData) const override;
31 void functionDerivLocal(API::Jacobian *out, const double *xValues, const size_t nData) override;
32
34 void calculateFunctionAndDerivative(const double *xValues, const size_t nData, double *functionValues,
35 API::Jacobian *derivatives) const;
36
38 double centre() const override;
40 double height() const override;
42 double fwhm() const override;
44 void setCentre(const double value) override;
46 void setHeight(const double value) override;
48 void setFwhm(const double value) override;
50 double intensity() const override;
52 void setIntensity(const double value) override;
53};
54
55} // namespace Functions
56} // namespace CurveFitting
57} // namespace Mantid
double value
The value of the point.
Definition: FitMW.cpp:51
double height
Definition: GetAllEi.cpp:155
An interface to a peak function, which extend the interface of IFunctionWithLocation by adding method...
Definition: IPeakFunction.h:51
Represents the Jacobian in IFitFunction::functionDeriv.
Definition: Jacobian.h:22
Implements an analytical approximation to the Voigt function.
Definition: Voigt.h:21
std::string name() const override
Return a string identifier for the function.
Definition: Voigt.h:24
Helper class which provides the Collimation Length for SANS instruments.