3D correlated Gauss function. More...

#include <JMathlib3D.hh>

Inheritance diagram for JMATH::JGauss3D< ID_t, normalise >:

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

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

	JGauss3D (const double mean, const double sigma)
	Constructor. More...

double	getValue (const double x, const double y, const double z) const
	Function value. More...

const JGauss3D &	getGradient (const double x, const double y, const double z) const
	Get gradient. More...

double	operator() (const Args &...args) const
	Function value. More...

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

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

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

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

double	operator() (const Args &...args) const
	Function value. More...

const 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< ID_t > &	add (const JGauss< ID_t > &f1)
	Add function. More...

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

JGauss< ID_t > &	sub (const JGauss< ID_t > &f1)
	Subtract function. More...

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

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

JGauss< ID_t > &	mul (const double factor)
	Scale function. More...

JGauss< ID_t > &	negate ()
	Negate function. More...

JGauss< ID_t > &	div (const double factor)
	Scale function. More...

Public Attributes
double	center
	center More...

double	sigma
	sigma More...

double	mean

double	signal

double	background

Static Public Attributes
static const int	ID

static const parameter_list< JGauss >	parameters
	parameters More...

Private Member Functions
double	get (const double u) const
	Get ordinate value. More...

double	get (const double u) const
	Get ordinate value. More...

Private Attributes
JGauss_t	gradient

Detailed Description

template<int ID_t, bool normalise = false>
struct JMATH::JGauss3D< ID_t, normalise >

3D correlated Gauss function.

Definition at line 267 of file JMathlib3D.hh.

Member Typedef Documentation

◆ parameter_type

typedef double JGauss::* JMATH::JGauss< ID_t, normalised >::parameter_type

inherited

Type definition of fit parameter.

Definition at line 179 of file JGauss.hh.

Constructor & Destructor Documentation

◆ JGauss3D() [1/2]

template<int ID_t, bool normalise = false>

JMATH::JGauss3D< ID_t, normalise >::JGauss3D ( )

inline

Default constructor.

Definition at line 277 of file JMathlib3D.hh.

278 {}

◆ JGauss3D() [2/2]

template<int ID_t, bool normalise = false>

JMATH::JGauss3D< ID_t, normalise >::JGauss3D	(	const double	mean,
		const double	sigma
	)

inline

Constructor.

Parameters

mean	mean
sigma	sigma

Definition at line 287 of file JMathlib3D.hh.

                                  :
       JGauss<ID_t, normalise>(mean, sigma)
     {}

Member Function Documentation

◆ getValue() [1/2]

template<int ID_t, bool normalise = false>

double JMATH::JGauss3D< ID_t, normalise >::getValue	(	const double	x,
		const double	y,
		const double	z
	)		const

inline

Function value.

Parameters

x	abscissa value
y	abscissa value
z	abscissa value

Returns: function value

Definition at line 301 of file JMathlib3D.hh.

     {
       typedef JGauss<ID_t, normalise>  JGauss_t;
  
       return (static_cast<const JGauss_t&>(*this).getValue(x) *
               static_cast<const JGauss_t&>(*this).getValue(y) *
               static_cast<const JGauss_t&>(*this).getValue(z));
     }

◆ getGradient() [1/2]

template<int ID_t, bool normalise = false>

const JGauss3D& JMATH::JGauss3D< ID_t, normalise >::getGradient	(	const double	x,
		const double	y,
		const double	z
	)		const

inline

Get gradient.

Parameters

x	abscissa value
y	abscissa value
z	abscissa value

Returns: gradient

Definition at line 319 of file JMathlib3D.hh.

     {
       static JGauss3D gradient;
  
       typedef JGauss<ID_t, normalise>  JGauss_t;
  
       static_cast<JGauss_t&>(gradient)  = JGauss_t(static_cast<const JGauss_t&>(*this).getGradient(x)).mul(static_cast<const JGauss_t&>(*this).getValue(y) * static_cast<const JGauss_t&>(*this).getValue(z));
       static_cast<JGauss_t&>(gradient) += JGauss_t(static_cast<const JGauss_t&>(*this).getGradient(y)).mul(static_cast<const JGauss_t&>(*this).getValue(x) * static_cast<const JGauss_t&>(*this).getValue(z));
       static_cast<JGauss_t&>(gradient) += JGauss_t(static_cast<const JGauss_t&>(*this).getGradient(z)).mul(static_cast<const JGauss_t&>(*this).getValue(x) * static_cast<const JGauss_t&>(*this).getValue(y));
  
       return gradient;
     }

◆ operator()() [1/3]

double JMATH::JMathlib< JGauss3D< ID_t, false > >::operator() ( const Args &... args ) const

inlineinherited

Function value.

Parameters

args	abscissa value(s)

Returns: function value

Definition at line 362 of file JMathlib.hh.

     {
       return static_cast<const JF1_t&>(*this).getValue(args...);
     }

◆ getValue() [2/2]

double JMATH::JGauss< ID_t, normalised >::getValue ( const double x ) const

inlineinherited

Function value.

Parameters

x	abscissa value

Returns: function value

Definition at line 222 of file JGauss.hh.

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

◆ getDerivative() [1/2]

double JMATH::JGauss< ID_t, normalised >::getDerivative ( const double x ) const

inlineinherited

Derivative value.

Parameters

x	abscissa value

Returns: derivative value

Definition at line 236 of file JGauss.hh.

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

◆ getDerivative() [2/2]

double JMATH::JGauss< ID_t, normalised >::getDerivative ( const double x ) const

inlineinherited

Derivative value.

Parameters

x	abscissa value

Returns: derivative value

Definition at line 1635 of file JMathlib.hh.

     {
       const double w  = 1.0 / sigma;
       const double u  = (x - center) / sigma;
  
       return get(u) * -u * w;
     }

◆ operator()() [2/3]

double JMATH::JGauss< ID_t, normalised >::operator() ( const double x ) const

inlineinherited

Function value.

Parameters

x	abscissa value

Returns: function value

Definition at line 250 of file JGauss.hh.

     {
       return getValue(x);
     }

◆ operator()() [3/3]

double JMATH::JMathlib< JGauss< ID_t > >::operator() ( const Args &... args ) const

inlineinherited

Function value.

Parameters

args	abscissa value(s)

Returns: function value

Definition at line 362 of file JMathlib.hh.

     {
       return static_cast<const JF1_t&>(*this).getValue(args...);
     }

◆ getGradient() [2/2]

const JGauss_t& JMATH::JGauss< ID_t, normalised >::getGradient ( const double x ) const

inlineinherited

Get gradient.

Parameters

x	abscissa value

Returns: gradient

Definition at line 262 of file JGauss.hh.

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

◆ get() [1/2]

double JMATH::JGauss< ID_t, normalised >::get ( const double u ) const

inlineprivateinherited

Get ordinate value.

Parameters

u	abscissa value

Returns: ordinate value

Definition at line 284 of file JGauss.hh.

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

◆ get() [2/2]

double JMATH::JGauss< ID_t, normalised >::get ( const double u ) const

inlineprivateinherited

Get ordinate value.

Parameters

u	abscissa value

Returns: ordinate value

Definition at line 1675 of file JMathlib.hh.

     {
       return exp(-0.5*u*u);
     }

◆ equals()

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);
     }

◆ add() [1/2]

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;
     }

◆ add() [2/2]

JGauss< ID_t > & JMATH::JCalculus< JGauss< ID_t > >::add ( const JF1_t & f1 )

inlineinherited

Add function.

Parameters

f1 function

Returns: this function

Definition at line 219 of file JMathlib.hh.

     {
       for (const auto& i : JF1_t::parameters) {
         static_cast<JF1_t&>(*this).*i += f1.*i;
       }
  
       return static_cast<JF1_t&>(*this);
     }

◆ sub() [1/2]

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;
     }

◆ sub() [2/2]

JGauss< ID_t > & JMATH::JCalculus< JGauss< ID_t > >::sub ( const JF1_t & f1 )

inlineinherited

Subtract function.

Parameters

f1 function

Returns: this function

Definition at line 235 of file JMathlib.hh.

     {
       for (const auto& i : JF1_t::parameters) {
         static_cast<JF1_t&>(*this).*i -= f1.*i;
       }
  
       return static_cast<JF1_t&>(*this);
     }

◆ mul() [1/3]

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;
     }

◆ mul() [2/3]

JGauss_t & JMATH::JMath< JGauss_t , JSecond_t >::mul ( const JSecond_t & 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);
     }

◆ mul() [3/3]

JGauss< ID_t > & JMATH::JCalculus< JGauss< ID_t > >::mul ( const double factor )

inlineinherited

Scale function.

Parameters

factor factor

Returns: this function

Definition at line 251 of file JMathlib.hh.

     {
       for (const auto& i : JF1_t::parameters) {
         static_cast<JF1_t&>(*this).*i *= factor;
       }
  
       return static_cast<JF1_t&>(*this);
     }

◆ negate()

JGauss< ID_t > & JMATH::JCalculus< JGauss< ID_t > >::negate ( )

inlineinherited

Negate function.

Returns: this function

Definition at line 203 of file JMathlib.hh.

     {
       for (const auto& i : JF1_t::parameters) {
         static_cast<JF1_t&>(*this).*i = -(static_cast<JF1_t&>(*this).*i);
       }
  
       return static_cast<JF1_t&>(*this);
     }

◆ div()

JGauss< ID_t > & JMATH::JCalculus< JGauss< ID_t > >::div ( const double factor )

inlineinherited

Scale function.

Parameters

factor factor

Returns: this function

Definition at line 267 of file JMathlib.hh.

     {
       for (const auto& i : JF1_t::parameters) {
         static_cast<JF1_t&>(*this).*i /= factor;
       }
  
       return static_cast<JF1_t&>(*this);
     }

Member Data Documentation

◆ gradient

JGauss_t JMATH::JGauss< ID_t, normalised >::gradient

mutableprivateinherited

Definition at line 289 of file JGauss.hh.

◆ ID

const int JMATH::JGauss< ID_t, normalised >::ID

staticinherited

Definition at line 1590 of file JMathlib.hh.

◆ center

double JMATH::JGauss< ID_t, normalised >::center

inherited

center

Definition at line 1664 of file JMathlib.hh.

◆ sigma

double JMATH::JGauss< ID_t, normalised >::sigma

inherited

sigma

Definition at line 1665 of file JMathlib.hh.

◆ parameters

const parameter_list< JGauss< ID_t, normalised > > JMATH::JGauss< ID_t, normalised >::parameters

staticinherited

parameters

Set parameters.

Definition at line 1666 of file JMathlib.hh.

◆ mean

double JMATH::JGauss_t::mean

inherited

Definition at line 161 of file JGauss.hh.

◆ signal

double JMATH::JGauss_t::signal

inherited

Definition at line 163 of file JGauss.hh.

◆ background

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:

JMathlib3D.hh

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

template<int ID_t, bool normalise = false> struct JMATH::JGauss3D< ID_t, normalise >

Member Typedef Documentation

◆ parameter_type

Constructor & Destructor Documentation

◆ JGauss3D() [1/2]

◆ JGauss3D() [2/2]

Member Function Documentation

◆ getValue() [1/2]

◆ getGradient() [1/2]

◆ operator()() [1/3]

◆ getValue() [2/2]

◆ getDerivative() [1/2]

◆ getDerivative() [2/2]

◆ operator()() [2/3]

◆ operator()() [3/3]

◆ getGradient() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ equals()

◆ add() [1/2]

◆ add() [2/2]

◆ sub() [1/2]

◆ sub() [2/2]

◆ mul() [1/3]

◆ mul() [2/3]

◆ mul() [3/3]

◆ negate()

◆ div()

Member Data Documentation

◆ gradient

◆ ID

◆ center

◆ sigma

◆ parameters

◆ mean

◆ signal

◆ background

template<int ID_t, bool normalise = false>
struct JMATH::JGauss3D< ID_t, normalise >