DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator > Class Template Reference

#include <DigitalSurfaceEmbedderWithNormalVectorEstimator.h>

Collaboration diagram for DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >:

Public Types
typedef DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap < TDigitalSurfaceEmbedder, TNormalVectorEstimator >	Self
typedef TDigitalSurfaceEmbedder	DigitalSurfaceEmbedder
typedef TNormalVectorEstimator	NormalVectorEstimator
typedef DigitalSurfaceEmbedderWithNormalVectorEstimator < DigitalSurfaceEmbedder, NormalVectorEstimator >	Embedder
typedef Embedder::SCell	Argument
typedef Embedder::RealVector	Value

Public Member Functions
	BOOST_CONCEPT_ASSERT ((CDigitalSurfaceEmbedder< TDigitalSurfaceEmbedder >))
	~DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap ()
	DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap ()
Self &	operator= (const Self &other)
	DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap (const Self &other)
	DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap (const Embedder &embedder)
Value	operator() (const Argument &arg) const

Protected Attributes
const Embedder *	myEmbedder

---

Detailed Description

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>
class DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >

Functor object to associate a normal vector to any surfel of a digital surface. It is constructed from an object combining digital surface embedder and a normal vector estimator. Generally not instantiated directly by the user.

Template Parameters:

TDigitalSurfaceEmbedder	a model of digital surface embedder.
TNormalVectorEstimator	the type of normal vector estimator.

See also:

DigitalSurfaceEmbedderWithNormalVectorEstimator::gradientMap

Definition at line 208 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

---

Member Typedef Documentation

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef Embedder::SCell DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::Argument

Definition at line 218 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef TDigitalSurfaceEmbedder DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::DigitalSurfaceEmbedder

Definition at line 214 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef DigitalSurfaceEmbedderWithNormalVectorEstimator< DigitalSurfaceEmbedder, NormalVectorEstimator > DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::Embedder

Definition at line 217 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef TNormalVectorEstimator DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::NormalVectorEstimator

Definition at line 215 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap<TDigitalSurfaceEmbedder,TNormalVectorEstimator> DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::Self

Definition at line 211 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef Embedder::RealVector DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::Value

Definition at line 219 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

---

Constructor & Destructor Documentation

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::~DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap ( )

inline

Destructor. Does nothing.

Definition at line 171 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

{}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap ( )

inline

Default constructor. The object is not valid.

Definition at line 178 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

  : myEmbedder( 0 )
{}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap ( const Self &  other )

inline

Copy constructor.

Parameters:

other

the object to clone.

Definition at line 196 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

  : myEmbedder( other.myEmbedder )
{}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap ( const Embedder &  embedder )

inline

Constructor from embedder.

Parameters:

embedder

any instance of DigitalSurfaceEmbedderWithNormalVectorEstimator.

Definition at line 187 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

  : myEmbedder( &embedder )
{}

---

Member Function Documentation

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::BOOST_CONCEPT_ASSERT

(

(CDigitalSurfaceEmbedder< TDigitalSurfaceEmbedder >)

)

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::Value DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::operator() ( const Argument &  arg ) const

inline

Functor operator : SCell (surfel) -> RealVector (gradient vector).

Parameters:

arg	any signed cell.

Returns:

a real-value vector.

Definition at line 217 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

{
  ASSERT( myEmbedder != 0 );
  return myEmbedder->gradient( arg );
}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::Self & DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::operator= ( const Self &  other )

inline

Assignment.

Definition at line 206 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

References DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::myEmbedder.

{
  myEmbedder = other.myEmbedder;
  return *this;
}

---

Field Documentation

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

const Embedder* DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::myEmbedder

protected

The digital surface embedder with normal vector estimator.

Definition at line 253 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

Referenced by DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::operator=().

---

The documentation for this class was generated from the following files:

• DigitalSurfaceEmbedderWithNormalVectorEstimator.h
• DigitalSurfaceEmbedderWithNormalVectorEstimator.ih