DGtal  0.6.devel
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Data Fields
DGtal::GaussianConvolutionWeights< TDistance > Class Template Reference

#include <BasicConvolutionWeights.h>

Public Types

typedef TDistance Distance

Public Member Functions

 GaussianConvolutionWeights (const double sigma)
double operator() (const Distance &aDisplacment) const

Data Fields

double mySigma
double myCoef
double myCoef2

Detailed Description

template<typename TDistance>
class DGtal::GaussianConvolutionWeights< TDistance >

Aim: implement a Gaussian centered convolution kernel.

Description of template class 'GaussianConvolutionWeights'

Template Parameters:
TDistancetype for topological distances.

Definition at line 89 of file BasicConvolutionWeights.h.


Member Typedef Documentation

template<typename TDistance>
typedef TDistance DGtal::GaussianConvolutionWeights< TDistance >::Distance

Inner type for the topological distance.

Definition at line 95 of file BasicConvolutionWeights.h.


Constructor & Destructor Documentation

template<typename TDistance>
DGtal::GaussianConvolutionWeights< TDistance >::GaussianConvolutionWeights ( const double  sigma)
inline

Constructor

Parameters:
sigmaGaussian sigma parameter.

Definition at line 102 of file BasicConvolutionWeights.h.

References M_PI, DGtal::GaussianConvolutionWeights< TDistance >::myCoef, DGtal::GaussianConvolutionWeights< TDistance >::myCoef2, and DGtal::GaussianConvolutionWeights< TDistance >::mySigma.

: mySigma(sigma)
{
myCoef = 1.0/(mySigma * sqrt(2.0*M_PI));
myCoef2 = 1.0/(2.0*M_PI);
}

Member Function Documentation

template<typename TDistance>
double DGtal::GaussianConvolutionWeights< TDistance >::operator() ( const Distance aDisplacment) const
inline

Return a Gaussian weight from a distance to the gaussian function center.

Parameters:
aDisplacmentdistance to the center
Returns:
the weight

Definition at line 116 of file BasicConvolutionWeights.h.

References DGtal::GaussianConvolutionWeights< TDistance >::myCoef, and DGtal::GaussianConvolutionWeights< TDistance >::myCoef2.


Field Documentation

template<typename TDistance>
double DGtal::GaussianConvolutionWeights< TDistance >::myCoef
template<typename TDistance>
double DGtal::GaussianConvolutionWeights< TDistance >::myCoef2
template<typename TDistance>
double DGtal::GaussianConvolutionWeights< TDistance >::mySigma

Internal Sigma value;.

Definition at line 123 of file BasicConvolutionWeights.h.

Referenced by DGtal::GaussianConvolutionWeights< TDistance >::GaussianConvolutionWeights().


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