Helios++
Helios software for LiDAR simulations
SurfaceInspector::maths::functions::GaussianFunction< T > Class Template Reference

Implementation of a gaussian function. More...

#include <GaussianFunction.hpp>

Inheritance diagram for SurfaceInspector::maths::functions::GaussianFunction< T >:
Collaboration diagram for SurfaceInspector::maths::functions::GaussianFunction< T >:

Public Member Functions

 GaussianFunction (T mu, T sigma, T sigmaSquare)
 Build a gaussian function.
 
 GaussianFunction (T mu, T sigma)
 Build a gaussian function.
 
operator() (T const &x) override
 
- Public Member Functions inherited from SurfaceInspector::maths::functions::IMathFunction< T, T >
virtual T operator() (T const &&x)
 RValue reference callable. More...
 
virtual vector< T > operator() (vector< T > const &u)
 Base implementation for math function computation over a vector. It can be overridden for the sake of convenience by any subclass. More...
 

Public Attributes

mu
 \(\mu\)
 
sigma
 \(\sigma\)
 
sigmaSquare
 \(\sigma^{2}\)
 
twiceSigmaSquare
 \(2\sigma^{2}\)
 
sqrt2PiSigma
 \(\sqrt{2\pi} \sigma\)
 

Static Public Attributes

static T const SQRT2PI = (T) 2.5066282746310002
 

Detailed Description

template<typename T>
class SurfaceInspector::maths::functions::GaussianFunction< T >

Implementation of a gaussian function.

Author
Alberto M. Esmoris Pena
Version
1.0
Template Parameters
TInput/Output type

\[ f : \mathbb{R^{1}} \rightarrow \mathbb{R^{1}} \\ f(x) = \frac{e^{-\frac{x^2}{2\sigma^{2}}}}{\sqrt{2\pi}\sigma} \]

Member Function Documentation

◆ operator()()

template<typename T >
T SurfaceInspector::maths::functions::GaussianFunction< T >::operator() ( T const &  x)
inlineoverridevirtual
See also
Implementation of the gaussian function

\[ f : \mathbb{R^{1}} \rightarrow \mathbb{R^{1}} \\ f(x) = \frac{e^{-\frac{x^2}{2\sigma^{2}}}}{\sqrt{2\pi}\sigma} \]

Reimplemented from SurfaceInspector::maths::functions::IMathFunction< T, T >.


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