MathUtils::Gaussian Class Reference

Gaussian function functor: f(x) = a * exp(-((x-mu)^2)/(2*sigma^2)). More...

#include <MathUtils_FunctorScalar.hxx>

Public Member Functions
	Gaussian (double theAmplitude=1.0, double theMean=0.0, double theSigma=1.0)
	Constructor with full parameters.
bool	Value (double theX, double &theY) const
	Evaluates Gaussian function.
bool	Values (double theX, double &theY, double &theDY) const
	Evaluates Gaussian function and derivative.

Detailed Description

Gaussian function functor: f(x) = a * exp(-((x-mu)^2)/(2*sigma^2)).

Constructor & Destructor Documentation

Gaussian()

MathUtils::Gaussian::Gaussian ( double theAmplitude = 1.0, double theMean = 0.0, double theSigma = 1.0 )

inline

Constructor with full parameters.

Parameters

theAmplitude	amplitude a (peak height)
theMean	mean mu (center)
theSigma	standard deviation sigma (width)

Member Function Documentation

Value()

bool MathUtils::Gaussian::Value ( double theX, double & theY ) const

inline

Evaluates Gaussian function.

Parameters

[in]	theX	input value
[out]	theY	function value

Returns

false if sigma is zero

Values()

bool MathUtils::Gaussian::Values ( double theX, double & theY, double & theDY ) const

inline

Evaluates Gaussian function and derivative.

Parameters

[in]	theX	input value
[out]	theY	function value
[out]	theDY	derivative value

Returns

false if sigma is zero

---

The documentation for this class was generated from the following file:

• MathUtils_FunctorScalar.hxx