DGtal::concepts::CDigitalSurfaceLocalEstimator< T > Struct Template Reference

Aim: This concept describes an object that can process a range over some generic digital surface so as to return one estimated quantity for each element of the range (or a given subrange). More...

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

Inheritance diagram for DGtal::concepts::CDigitalSurfaceLocalEstimator< T >:

Public Types
typedef T::Surface	Surface
typedef Surface::DigitalSurfaceContainer	DigitalSurfaceContainer
typedef T::Surfel	Surfel
Public Types inherited from DGtal::concepts::CSurfelLocalEstimator< T >
typedef T::Quantity	Quantity
typedef T::Surfel	Surfel

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CDigitalSurfaceContainer< DigitalSurfaceContainer >))
	BOOST_STATIC_ASSERT ((ConceptUtils::SameType< Surfel, typename Surface::Surfel >::value))
	BOOST_CONCEPT_USAGE (CDigitalSurfaceLocalEstimator)
Public Member Functions inherited from DGtal::concepts::CSurfelLocalEstimator< T >
	BOOST_CONCEPT_ASSERT ((CQuantity< Quantity >))
	BOOST_CONCEPT_USAGE (CSurfelLocalEstimator)
void	check_const_constraints () const

Private Attributes
T	myX
Surface	myS

Detailed Description

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

Aim: This concept describes an object that can process a range over some generic digital surface so as to return one estimated quantity for each element of the range (or a given subrange).

Description of concept 'CDigitalSurfaceLocalEstimator'

It refines the concept CSurfelLocalEstimator by forcing the abstract surface to be some digital surface.

Refinement of

• CSurfelLocalEstimator

Associated types

• Surface : the type of digital surface, some DigitalSurface<T> where T is a model of CDigitalSurfaceContainer.
• Surfel (from CSurfelLocalEstimator) and type Surface::Surfel must be the same

Notation

• X : A type that is a model of CDigitalSurfaceLocalEstimator
• x : object of type X
• s : an instance of Surface

Definitions

Valid expressions and semantics

Name	Expression		Return type	Precondition	Semantics		Complexity
Attach surface	x.attach( s )		void		Indicates to the estimator the surface on which estimations are done.		Model dependent

Invariants

Models

• VCMDigitalSurfaceLocalEstimator.
• LocalEstimatorFromSurfelFunctorAdapter.
• IntegralInvariantVolumeEstimator.
• IntegralInvariantCovarianceEstimator.

Notes

• A surface must be attached to x before the call to init and eval.

Template Parameters

T	the type that should be a model of CDigitalSurfaceLocalEstimator.

Definition at line 102 of file CDigitalSurfaceLocalEstimator.h.

Member Typedef Documentation

DigitalSurfaceContainer

template<typename T >

typedef Surface::DigitalSurfaceContainer DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::DigitalSurfaceContainer

Definition at line 110 of file CDigitalSurfaceLocalEstimator.h.

Surface

template<typename T >

typedef T::Surface DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::Surface

Definition at line 109 of file CDigitalSurfaceLocalEstimator.h.

Surfel

template<typename T >

typedef T::Surfel DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::Surfel

Definition at line 112 of file CDigitalSurfaceLocalEstimator.h.

Member Function Documentation

BOOST_CONCEPT_ASSERT()

template<typename T >

DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::BOOST_CONCEPT_ASSERT

(

(concepts::CDigitalSurfaceContainer< DigitalSurfaceContainer >)

)

BOOST_CONCEPT_USAGE()

template<typename T >

DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::BOOST_CONCEPT_USAGE ( CDigitalSurfaceLocalEstimator< T >  )

inline

Definition at line 114 of file CDigitalSurfaceLocalEstimator.h.

    {
      myX.attach( myS );
    }

References DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::myS, and DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::myX.

BOOST_STATIC_ASSERT()

template<typename T >

DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::BOOST_STATIC_ASSERT

(

(ConceptUtils::SameType< Surfel, typename Surface::Surfel >::value)

)

Field Documentation

myS

template<typename T >

Surface DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::myS

private

Definition at line 122 of file CDigitalSurfaceLocalEstimator.h.

Referenced by DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::BOOST_CONCEPT_USAGE().

myX

template<typename T >

T DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::myX

private

Definition at line 121 of file CDigitalSurfaceLocalEstimator.h.

Referenced by DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::BOOST_CONCEPT_USAGE().

---

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

• CDigitalSurfaceLocalEstimator.h