Gauss function object. More...

#include <JGauss.hh>

Inheritance diagram for JMATH::JGauss:

Public Types
typedef double JGauss::*	parameter_type
	Type definition of fit parameter. More...

Public Member Functions
	JGauss ()
	Default constructor. More...

	JGauss (const JGauss_t &gauss)
	Copy constructor. More...

	JGauss (const double mean, const double sigma, const double signal=1.0, const double background=0.0)
	Constructor. More...

double	getValue (const double x) const
	Function value. More...

double	getDerivative (const double x) const
	Derivative value. More...

double	operator() (const double x) const
	Function value. More...

JGauss_t	getGradient (const double x) const
	Get gradient. More...

bool	equals (const JGauss_t &gauss, const double eps=std::numeric_limits< double >::min()) const
	Equality. More...

JGauss_t &	add (const JGauss_t &gauss)
	Add gauss. More...

JGauss_t &	sub (const JGauss_t &gauss)
	Subtract gauss. More...

JGauss_t &	mul (const double factor)
	Scale gauss. More...

JGauss_t &	mul (const JNullType &object)
	Multiply with object. More...

Public Attributes
double	mean

double	sigma

double	signal

double	background

Private Member Functions
double	get_signal (const double u) const
	Get signal. More...

Detailed Description

Gauss function object.

Evaluates function, derivative and gradient values.

Definition at line 173 of file JGauss.hh.

Member Typedef Documentation

typedef double JGauss::* JMATH::JGauss::parameter_type

Type definition of fit parameter.

Definition at line 179 of file JGauss.hh.

Constructor & Destructor Documentation

JMATH::JGauss::JGauss ( )

inline

Default constructor.

Definition at line 185 of file JGauss.hh.

              :
       JGauss_t()
     {}

JMATH::JGauss::JGauss ( const JGauss_t & gauss )

inline

Copy constructor.

Parameters

gauss gauss

Definition at line 195 of file JGauss.hh.

                                   :
       JGauss_t(gauss)
     {}

JMATH::JGauss::JGauss	(	const double	mean,
		const double	sigma,
		const double	signal = `1.0`,
		const double	background = `0.0`
	)

inline

Constructor.

Parameters

mean	mean
sigma	sigma
signal	signal
background	background

Definition at line 208 of file JGauss.hh.

                                           :
       JGauss_t(mean, sigma, signal, background)
     {}

Member Function Documentation

double JMATH::JGauss::getValue ( const double x ) const

inline

Function value.

Parameters

x	abscissa value

Returns: function value

Definition at line 222 of file JGauss.hh.

     {
       const double u  = (x - mean) / sigma;
 
       return get_signal(u) + background;
     }

double JMATH::JGauss::getDerivative ( const double x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns: derivative value

Definition at line 236 of file JGauss.hh.

     {
       const double u  = (x - mean) / sigma;
 
       return get_signal(u) * -u;
     }

double JMATH::JGauss::operator() ( const double x ) const

inline

Function value.

Parameters

x	abscissa value

Returns: function value

Definition at line 250 of file JGauss.hh.

     {
       return getValue(x);
     }

JGauss_t JMATH::JGauss::getGradient ( const double x ) const

inline

Get gradient.

Parameters

x	abscissa value

Returns: gradient

Definition at line 262 of file JGauss.hh.

     {
       JGauss_t gradient;
 
       const double u  = (x - mean) / sigma;
       const double fs =  get_signal(u);
 
       gradient.mean       =  fs * u   / sigma;                           // d(f)/d(mean)
       gradient.sigma      =  fs * u*u / sigma  -  fs / sigma;            // d(f)/d(sigma)
       gradient.signal     =  fs       / signal;                          // d(f)/d(signal)
       gradient.background =  1.0;                                        // d(f)/d(background)
 
       return gradient;
     }

double JMATH::JGauss::get_signal ( const double u ) const

inlineprivate

Get signal.

Parameters

u value

Returns: signal

Definition at line 284 of file JGauss.hh.

     {
       return signal * exp(-0.5*u*u) / (sqrt(2.0*PI) * sigma);
     }

bool JMATH::JGauss_t::equals	(	const JGauss_t &	gauss,
		const double	eps = `std::numeric_limits<double>::min()`
	)		const

inlineinherited

Equality.

Parameters

gauss	gauss
eps	numerical precision

Returns: true if gauss's identical; else false

Definition at line 70 of file JGauss.hh.

     {
       return (fabs(mean       - gauss.mean)       <=  eps  &&
               fabs(sigma      - gauss.sigma)      <=  eps  &&
               fabs(signal     - gauss.signal)     <=  eps  &&
               fabs(background - gauss.background) <=  eps);
     }

JGauss_t& JMATH::JGauss_t::add ( const JGauss_t & gauss )

inlineinherited

Add gauss.

Parameters

gauss gauss

Returns: this gauss

Definition at line 86 of file JGauss.hh.

     {
       mean       += gauss.mean;
       sigma      += gauss.sigma;
       signal     += gauss.signal;
       background += gauss.background;
 
       return *this;
     }

JGauss_t& JMATH::JGauss_t::sub ( const JGauss_t & gauss )

inlineinherited

Subtract gauss.

Parameters

gauss gauss

Returns: this gauss

Definition at line 103 of file JGauss.hh.

     {
       mean       -= gauss.mean;
       sigma      -= gauss.sigma;
       signal     -= gauss.signal;
       background -= gauss.background;
 
       return *this;
     }

JGauss_t& JMATH::JGauss_t::mul ( const double factor )

inlineinherited

Scale gauss.

Parameters

factor multiplication factor

Returns: this gauss

Definition at line 120 of file JGauss.hh.

     {
       mean       *= factor;
       sigma      *= factor;
       signal     *= factor;
       background *= factor;
 
       return *this;
     }

JGauss_t & JMATH::JMath< JGauss_t , JNullType >::mul ( const JNullType & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 354 of file JMath.hh.

     {
       return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
     }

Member Data Documentation

double JMATH::JGauss_t::mean

inherited

Definition at line 161 of file JGauss.hh.

double JMATH::JGauss_t::sigma

inherited

Definition at line 162 of file JGauss.hh.

double JMATH::JGauss_t::signal

inherited

Definition at line 163 of file JGauss.hh.

double JMATH::JGauss_t::background

inherited

Definition at line 164 of file JGauss.hh.

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

JGauss.hh

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation