aimstil  5.0.5
til::math::Gaussian< TPrec > Class Template Reference

Unnormalized Gaussian. More...

#include <cathier/math_functions.h>

Inheritance diagram for til::math::Gaussian< TPrec >:
Collaboration diagram for til::math::Gaussian< TPrec >:

Classes

class  StandardDeviationTooSmall
 

Public Types

typedef TPrec prec_type
 

Public Member Functions

 Gaussian (prec_type sigma)
 Constructor with Gaussian standard deviation. More...
 
prec_type getSigma () const
 
void setSigma (prec_type sigma)
 
prec_type operator() (prec_type x) const
 Return the value of the Gaussian kernel at x. More...
 
prec_type squared_input (prec_type x2) const
 Return the value of the Gaussian kernel at x, the input being x^2. More...
 

Detailed Description

template<typename TPrec>
class til::math::Gaussian< TPrec >

Unnormalized Gaussian.

The equation of this function is exp(-x^2 / ( 2 * sigma^2 ) ), where sigma is the standard deviation. It is unnormalized: there is no multiplicative coefficient and the value at 0 is always 1.

Definition at line 60 of file math_functions.h.

Member Typedef Documentation

◆ prec_type

template<typename TPrec>
typedef TPrec til::math::Gaussian< TPrec >::prec_type

Definition at line 65 of file math_functions.h.

Constructor & Destructor Documentation

◆ Gaussian()

template<typename TPrec>
til::math::Gaussian< TPrec >::Gaussian ( prec_type  sigma)
explicit

Constructor with Gaussian standard deviation.

Member Function Documentation

◆ getSigma()

template<typename TPrec>
prec_type til::math::Gaussian< TPrec >::getSigma ( ) const
inline

Definition at line 78 of file math_functions.h.

◆ operator()()

template<typename TPrec>
prec_type til::math::Gaussian< TPrec >::operator() ( prec_type  x) const

Return the value of the Gaussian kernel at x.

Referenced by til::math::Gaussian< prec_type >::getSigma().

◆ setSigma()

template<typename TPrec>
void til::math::Gaussian< TPrec >::setSigma ( prec_type  sigma)
inline

◆ squared_input()

template<typename TPrec>
prec_type til::math::Gaussian< TPrec >::squared_input ( prec_type  x2) const

Return the value of the Gaussian kernel at x, the input being x^2.

Referenced by til::math::Gaussian< prec_type >::getSigma().


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