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
T	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

• Surfel: a type of Surfel
• Embedder: a model of CSCellEmbedder
• Quantity: a return type for the estimator (model of CQuantity)

Notation

• X : A type that is a model of CLocalEstimatorFromSurfelFunctor
• x, y : object of type X
• aSurfel : object of type Surfel

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 DGTAL_WITH_CGAL), functors::MongeJetFittingMeanCurvatureEstimator (if DGTAL_WITH_CGALTH_CGALTH_CGALTH_CGALTH_CGAL), functors::MongeJetFittingPrincipalCurvaturesEstimator (if DGTAL_WITH_CGAL), functors::MongeJetFittingNormalVectorEstimator (if DGTAL_WITH_CGAL), functors::LinearLeastSquareFittingNormalVectorEstimator (if DGTAL_WITH_CGAL), functors::ElementaryConvolutionNormalVectorEstimator, functors::TensorVotingFeatureExtraction, functors::SphereFittingEstimator (if WITH_PATATE)

Notes

Template Parameters

T	the 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

Definition at line 118 of file CLocalEstimatorFromSurfelFunctor.h.

  {
    ConceptUtils::sameType( myQ, myX.eval( ) );
    myX.reset( );
    myX.pushSurfel( myCA, myDist );
  }

References myCA, myDist, myQ, myX, and DGtal::concepts::ConceptUtils::sameType().

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

Definition at line 129 of file CLocalEstimatorFromSurfelFunctor.h.

Referenced by BOOST_CONCEPT_USAGE().

myDist

template<typename T>

double DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::myDist

private

Definition at line 133 of file CLocalEstimatorFromSurfelFunctor.h.

Referenced by BOOST_CONCEPT_USAGE().

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

Definition at line 130 of file CLocalEstimatorFromSurfelFunctor.h.

Referenced by BOOST_CONCEPT_USAGE().

myX

template<typename T>

T DGtal::concepts::CLocalEstimatorFromSurfelFunctor< T >::myX

private

Definition at line 127 of file CLocalEstimatorFromSurfelFunctor.h.

Referenced by BOOST_CONCEPT_USAGE().

---

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

• CLocalEstimatorFromSurfelFunctor.h