ProteoWizard
Public Member Functions | Public Attributes | List of all members
ralab::base::filter::utilities::Gauss< TReal > Struct Template Reference

Gauss function. More...

#include <gauss.hpp>

Inheritance diagram for ralab::base::filter::utilities::Gauss< TReal >:

Public Member Functions

 Gauss (TReal mu, TReal sigma)
 
TReal operator() (TReal x)
 

Public Attributes

TReal mu_
 
TReal sigma_
 

Detailed Description

template<typename TReal>
struct ralab::base::filter::utilities::Gauss< TReal >

Gauss function.

  \f[
  f(x) = \frac{1}{\sigma  \sqrt{2  \pi}} \cdot e^{-0.5 \cdot \frac{x - \mu }{\sigma}^2 }
  \f]

Definition at line 42 of file gauss.hpp.

Constructor & Destructor Documentation

◆ Gauss()

template<typename TReal >
ralab::base::filter::utilities::Gauss< TReal >::Gauss ( TReal  mu,
TReal  sigma 
)
inline

Definition at line 44 of file gauss.hpp.

45  :mu_(mu),
46  sigma_(sigma)
47  {}

Member Function Documentation

◆ operator()()

template<typename TReal >
TReal ralab::base::filter::utilities::Gauss< TReal >::operator() ( TReal  x)
inline

Definition at line 49 of file gauss.hpp.

50  {
51  return( 1/(sigma_ * sqrt(2. * ralab::constants::PI) ) * exp(-0.5 * ( pow( (x - mu_ )/sigma_, TReal(2.) ) ) ));
52  }

References ralab::base::filter::utilities::Gauss< TReal >::mu_, ralab::constants::PI(), ralab::base::filter::utilities::Gauss< TReal >::sigma_, and x.

Member Data Documentation

◆ mu_

template<typename TReal >
TReal ralab::base::filter::utilities::Gauss< TReal >::mu_

◆ sigma_

template<typename TReal >
TReal ralab::base::filter::utilities::Gauss< TReal >::sigma_

The documentation for this struct was generated from the following file:
ralab::base::filter::utilities::Gauss::mu_
TReal mu_
Definition: gauss.hpp:54
x
KernelTraitsBase< Kernel >::space_type::abscissa_type x
Definition: MatchedFilter.hpp:142
ralab::constants::PI
const double PI(3.14159265358979323846264338327950288)
the ratio of the circumference of a circle to its diameter;
ralab::base::filter::utilities::Gauss::sigma_
TReal sigma_
Definition: gauss.hpp:55