DGtal  0.9.4beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T > Struct Template Reference

#include <DGtal/geometry/surfaces/estimation/estimationFunctors/CLocalEstimatorFromSurfelFunctor.h>

Collaboration diagram for DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >:
[legend]

Public Types

typedef T::Quantity Quantity
 
typedef T::SCellEmbedder SCellEmbedder
 
typedef T::Surfel Surfel
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CQuantity< Quantity >))
 
 BOOST_CONCEPT_ASSERT ((concepts::CSCellEmbedder< SCellEmbedder >))
 
 BOOST_CONCEPT_USAGE (CLocalEstimatorFromSurfelFunctor)
 

Private Attributes

myX
 
Surfel myA
 
const Surfel myCA
 
Quantity myQ
 
SCellEmbedder myEmb
 
double myH
 
double myDist
 

Detailed Description

template<typename T>
struct DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >

Aim: this concept describes functors on digtal surface surfel which can be used to define local estimator using the adapter LocalEstimatorFromSurfelFunctorAdapter.

Description of concept 'CLocalEstimatorFromSurfelFunctor'

Refinement of

Associated types :

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Constructor from Embedder and gridstep X(anEmbedder,h) anEmbedder of type SCellEmbedder , h of type const double construct an instance from an SCell embedder
push a surfel x.pushSurfel(aSurfel, aDistance) aSurfel of type const Surfel, aDistance of type double void push a surfel to the estimator, aDistance is the distance of the surfel to the local visitor boundary (for the visitor metric)
evaluate the estimator v = x.eval() v of type Quantity evaluate to the estimator
reset x.reset() void reset the estimator

Invariants

Models

functors::DummyEstimatorFromSurfels, functors::MongeJetFittingGaussianCurvatureEstimator (if WITH_CGAL), functors::MongeJetFittingMeanCurvatureEstimator (if WITH_CGAL), functors::MongeJetFittingPrincipalCurvaturesEstimator (if WITH_CGAL), functors::MongeJetFittingNormalVectorEstimator (if WITH_CGAL), functors::LinearLeastSquareFittingNormalVectorEstimator (if WITH_CGAL), functors::ElementaryConvolutionNormalVectorEstimator, functors::TensorVotingFeatureExtraction, functors::SphereFittingEstimator (if WITH_PATATE)

Notes

Template Parameters
Tthe type that should be a model of CLocalEstimatorFromSurfelFunctor.

Definition at line 105 of file CLocalEstimatorFromSurfelFunctor.h.

Member Typedef Documentation

template<typename T >
typedef T::Quantity DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::Quantity

Definition at line 110 of file CLocalEstimatorFromSurfelFunctor.h.

template<typename T >
typedef T::SCellEmbedder DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::SCellEmbedder

Definition at line 111 of file CLocalEstimatorFromSurfelFunctor.h.

template<typename T >
typedef T::Surfel DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::Surfel

Definition at line 112 of file CLocalEstimatorFromSurfelFunctor.h.

Member Function Documentation

template<typename T >
DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::BOOST_CONCEPT_ASSERT ( (CQuantity< Quantity >)  )
template<typename T >
DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::BOOST_CONCEPT_ASSERT ( (concepts::CSCellEmbedder< SCellEmbedder >)  )
template<typename T >
DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::BOOST_CONCEPT_USAGE ( CLocalEstimatorFromSurfelFunctor< T >  )
inline

Field Documentation

template<typename T >
Surfel DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::myA
private

Definition at line 128 of file CLocalEstimatorFromSurfelFunctor.h.

template<typename T >
const Surfel DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::myCA
private
template<typename T >
double DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::myDist
private
template<typename T >
SCellEmbedder DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::myEmb
private

Definition at line 131 of file CLocalEstimatorFromSurfelFunctor.h.

template<typename T >
double DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::myH
private

Definition at line 132 of file CLocalEstimatorFromSurfelFunctor.h.

template<typename T >
Quantity DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::myQ
private
template<typename T >
T DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::myX
private

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