Mantid
Loading...
Searching...
No Matches
Framework
CurveFitting
inc
MantidCurveFitting
Functions
PeakParameterFunction.h
Go to the documentation of this file.
1
// Mantid Repository : https://github.com/mantidproject/mantid
2
//
3
// Copyright © 2015 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
9
#include "
MantidAPI/FunctionParameterDecorator.h
"
10
#include "
MantidAPI/IFunction1D.h
"
11
#include "
MantidAPI/IPeakFunction.h
"
12
#include "MantidCurveFitting/DllConfig.h"
13
14
namespace
Mantid
{
15
namespace
CurveFitting {
16
namespace
Functions {
17
31
class
MANTID_CURVEFITTING_DLL
PeakParameterFunction
:
virtual
public
API::IFunction1D
,
32
virtual
public
API::FunctionParameterDecorator
{
33
public
:
34
PeakParameterFunction
() :
FunctionParameterDecorator
() {}
35
36
std::string
name
()
const override
{
return
"PeakParameterFunction"
; }
37
38
void
function1D(
double
*out,
const
double
*xValues,
const
size_t
nData)
const override
;
39
40
void
functionDeriv(
const
API::FunctionDomain
&domain,
API::Jacobian
&jacobian)
override
;
41
42
protected
:
43
void
beforeDecoratedFunctionSet(
const
API::IFunction_sptr
&fn)
override
;
44
45
API::IPeakFunction_sptr
m_peakFunction
;
46
};
47
48
}
// namespace Functions
49
}
// namespace CurveFitting
50
}
// namespace Mantid
FunctionParameterDecorator.h
IFunction1D.h
IPeakFunction.h
Mantid::API::FunctionDomain
Base class that represents the domain of a function.
Definition:
FunctionDomain.h:31
Mantid::API::FunctionParameterDecorator
FunctionParameterDecorator.
Definition:
FunctionParameterDecorator.h:28
Mantid::API::IFunction1D
This is a specialization of IFunction for functions of one real argument.
Definition:
IFunction1D.h:43
Mantid::API::Jacobian
Represents the Jacobian in IFitFunction::functionDeriv.
Definition:
Jacobian.h:22
Mantid::CurveFitting::Functions::PeakParameterFunction
PeakParameterFunction :
Definition:
PeakParameterFunction.h:32
Mantid::CurveFitting::Functions::PeakParameterFunction::name
std::string name() const override
Returns the function's name.
Definition:
PeakParameterFunction.h:36
Mantid::CurveFitting::Functions::PeakParameterFunction::PeakParameterFunction
PeakParameterFunction()
Definition:
PeakParameterFunction.h:34
Mantid::CurveFitting::Functions::PeakParameterFunction::m_peakFunction
API::IPeakFunction_sptr m_peakFunction
Definition:
PeakParameterFunction.h:45
Mantid::API::IPeakFunction_sptr
std::shared_ptr< IPeakFunction > IPeakFunction_sptr
Definition:
IPeakFunction.h:141
Mantid::API::IFunction_sptr
std::shared_ptr< IFunction > IFunction_sptr
shared pointer to the function base class
Definition:
IFunction.h:732
Mantid
Helper class which provides the Collimation Length for SANS instruments.
Definition:
AbsorptionCorrection.h:18
Generated on Tue Jan 3 2023 11:57:26 for Mantid by
1.9.5