DGtal  1.3.beta
Public Types | Public Member Functions | Data Fields
DGtal::deprecated::GaussianConvolutionWeights< TDistance > Class Template Reference

Aim: implement a Gaussian centered convolution kernel. More...

#include <DGtal/geometry/surfaces/estimation/BasicConvolutionWeights.h>

Public Types

typedef TDistance Distance
 Inner type for the topological distance. More...
 

Public Member Functions

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

Data Fields

double mySigma
 Internal Sigma value;. More...
 
double myCoef
 Precomputed constant coefs. More...
 
double myCoef2
 

Detailed Description

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

Aim: implement a Gaussian centered convolution kernel.

Description of template class 'GaussianConvolutionWeights'

Warning
moved to deprecated since 0.7. Please consider using LocalEstimatorFromFunctorAdapter.
Template Parameters
TDistancetype for topological distances.

Definition at line 99 of file BasicConvolutionWeights.h.

Member Typedef Documentation

◆ Distance

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

Inner type for the topological distance.

Definition at line 105 of file BasicConvolutionWeights.h.

Constructor & Destructor Documentation

◆ GaussianConvolutionWeights()

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

Constructor

Parameters
sigmaGaussian sigma parameter.

Definition at line 112 of file BasicConvolutionWeights.h.

112  : mySigma(sigma)
113  {
114  myCoef = 1.0/(mySigma * sqrt(2.0*M_PI));
115  myCoef2 = 1.0/(2.0*M_PI);
116  }

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

Member Function Documentation

◆ operator()()

template<typename TDistance >
double DGtal::deprecated::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 126 of file BasicConvolutionWeights.h.

127  {
128  return myCoef*exp(-NumberTraits<Distance>::castToDouble(aDisplacment)*
130  }

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

Field Documentation

◆ myCoef

template<typename TDistance >
double DGtal::deprecated::GaussianConvolutionWeights< TDistance >::myCoef

◆ myCoef2

template<typename TDistance >
double DGtal::deprecated::GaussianConvolutionWeights< TDistance >::myCoef2

◆ mySigma

template<typename TDistance >
double DGtal::deprecated::GaussianConvolutionWeights< TDistance >::mySigma

The documentation for this class was generated from the following file:
DGtal::deprecated::GaussianConvolutionWeights::mySigma
double mySigma
Internal Sigma value;.
Definition: BasicConvolutionWeights.h:133
DGtal::deprecated::GaussianConvolutionWeights::myCoef2
double myCoef2
Definition: BasicConvolutionWeights.h:137
DGtal::NumberTraitsImpl< std::decay< T >::type >::castToDouble
static double castToDouble(const std::decay< T >::type &aT)
Cast method to double (for I/O or board export uses only).
Definition: NumberTraits.h:164
DGtal::deprecated::GaussianConvolutionWeights::myCoef
double myCoef
Precomputed constant coefs.
Definition: BasicConvolutionWeights.h:136