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

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

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

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

◆ Quantity

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

Definition at line 110 of file CLocalEstimatorFromSurfelFunctor.h.

◆ SCellEmbedder

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

Definition at line 111 of file CLocalEstimatorFromSurfelFunctor.h.

◆ Surfel

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

Definition at line 112 of file CLocalEstimatorFromSurfelFunctor.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/2]

template<typename T >
DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::BOOST_CONCEPT_ASSERT ( (concepts::CSCellEmbedder< SCellEmbedder >)  )

◆ BOOST_CONCEPT_ASSERT() [2/2]

template<typename T >
DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::BOOST_CONCEPT_ASSERT ( (CQuantity< Quantity >)  )

◆ BOOST_CONCEPT_USAGE()

template<typename T >
DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::BOOST_CONCEPT_USAGE ( CLocalEstimatorFromSurfelFunctor< T >  )
inline

Field Documentation

◆ myA

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

Definition at line 128 of file CLocalEstimatorFromSurfelFunctor.h.

◆ myCA

template<typename T >
const Surfel DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::myCA
private

◆ myDist

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

◆ myEmb

template<typename T >
SCellEmbedder DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::myEmb
private

Definition at line 131 of file CLocalEstimatorFromSurfelFunctor.h.

◆ myH

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

Definition at line 132 of file CLocalEstimatorFromSurfelFunctor.h.

◆ myQ

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

◆ myX

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

The documentation for this struct was generated from the following file:
DGtal::concepts::CLocalEstimatorFromSurfelFunctor::myDist
double myDist
Definition: CLocalEstimatorFromSurfelFunctor.h:133
DGtal::concepts::CLocalEstimatorFromSurfelFunctor::myCA
const Surfel myCA
Definition: CLocalEstimatorFromSurfelFunctor.h:129
DGtal::concepts::CLocalEstimatorFromSurfelFunctor::myQ
Quantity myQ
Definition: CLocalEstimatorFromSurfelFunctor.h:130
DGtal::concepts::CLocalEstimatorFromSurfelFunctor::myX
T myX
Definition: CLocalEstimatorFromSurfelFunctor.h:127
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117