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

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

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

Public Types

typedef T::Surface Surface
 
typedef T::SCell SCell
 
typedef T::ConstIterator ConstIterator
 
typedef T::Quantity Quantity
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CCellularGridSpaceND< typename Surface::KSpace >))
 
 BOOST_STATIC_ASSERT ((ConceptUtils::SameType< SCell, typename Surface::SCell >::value))
 
 BOOST_CONCEPT_ASSERT ((boost::InputIterator< ConstIterator >))
 
 BOOST_CONCEPT_USAGE (CNormalVectorEstimator)
 
void checkConstConstraints () const
 

Private Attributes

myX
 
Surface mySurface
 
SCell mySCell
 
Quantity myQuantity
 
boost::output_iterator_archetype< QuantitymyOutIt
 

Detailed Description

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

Aim: Represents the concept of estimator of normal vector along digital surfaces.

Description of concept 'CNormalVectorEstimator'

Refinement of

Associated types :

Notation

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Accessor to surface x.surface() const Surface &returns a reference to the digital surface
Local normal vector estimation x.eval(sc)Quantity returns the estimation of the normal vector at the signed cell sc
Global normal vector estimation template <OutputIterator>x.evalAll(out_it)OutputIterator outputs the estimation of the normal vector field of the whole surface

Invariants

Models

Notes

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

Definition at line 94 of file CNormalVectorEstimator.h.

Member Typedef Documentation

template<typename T >
typedef T::ConstIterator DGtal::concepts::CNormalVectorEstimator< T >::ConstIterator

Definition at line 100 of file CNormalVectorEstimator.h.

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

Definition at line 101 of file CNormalVectorEstimator.h.

template<typename T >
typedef T::SCell DGtal::concepts::CNormalVectorEstimator< T >::SCell

Definition at line 99 of file CNormalVectorEstimator.h.

template<typename T >
typedef T::Surface DGtal::concepts::CNormalVectorEstimator< T >::Surface

Definition at line 98 of file CNormalVectorEstimator.h.

Member Function Documentation

template<typename T >
DGtal::concepts::CNormalVectorEstimator< T >::BOOST_CONCEPT_ASSERT ( (concepts::CCellularGridSpaceND< typename Surface::KSpace >)  )
template<typename T >
DGtal::concepts::CNormalVectorEstimator< T >::BOOST_CONCEPT_ASSERT ( (boost::InputIterator< ConstIterator >)  )
template<typename T >
DGtal::concepts::CNormalVectorEstimator< T >::BOOST_CONCEPT_USAGE ( CNormalVectorEstimator< T >  )
inline
template<typename T >
DGtal::concepts::CNormalVectorEstimator< T >::BOOST_STATIC_ASSERT ( (ConceptUtils::SameType< SCell, typename Surface::SCell >::value)  )
template<typename T >
void DGtal::concepts::CNormalVectorEstimator< T >::checkConstConstraints ( ) const
inline

Definition at line 114 of file CNormalVectorEstimator.h.

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

115  {
116  }

Field Documentation

template<typename T >
boost::output_iterator_archetype<Quantity> DGtal::concepts::CNormalVectorEstimator< T >::myOutIt
private
template<typename T >
Quantity DGtal::concepts::CNormalVectorEstimator< T >::myQuantity
private
template<typename T >
SCell DGtal::concepts::CNormalVectorEstimator< T >::mySCell
private
template<typename T >
Surface DGtal::concepts::CNormalVectorEstimator< T >::mySurface
private
template<typename T >
T DGtal::concepts::CNormalVectorEstimator< T >::myX
private

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