#include <DigitalSurfaceEmbedderWithNormalVectorEstimator.h>

Public Types
typedef DigitalSurfaceEmbedderWithNormalVectorEstimator < TDigitalSurfaceEmbedder, TNormalVectorEstimator >	Self
typedef TDigitalSurfaceEmbedder	DigitalSurfaceEmbedder
typedef TNormalVectorEstimator	NormalVectorEstimator
typedef DigitalSurfaceEmbedder::KSpace	KSpace
typedef DigitalSurfaceEmbedder::Surface	Surface
typedef DigitalSurfaceEmbedder::SCell	SCell
typedef DigitalSurfaceEmbedder::RealPoint	RealPoint
typedef DigitalSurfaceEmbedder::Argument	Argument
typedef DigitalSurfaceEmbedder::Value	Value
typedef KSpace::Space	Space
typedef Space::RealVector	RealVector
typedef NormalVectorEstimator::Quantity	Quantity
typedef NormalVectorEstimator::DigitalSurface	NVESurface
typedef DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap < DigitalSurfaceEmbedder, NormalVectorEstimator >	GradientMap

Public Member Functions
	BOOST_CONCEPT_ASSERT ((CDigitalSurfaceEmbedder< TDigitalSurfaceEmbedder >))
	BOOST_STATIC_ASSERT ((ConceptUtils::SameType< RealVector, Quantity >::value))
	BOOST_STATIC_ASSERT ((ConceptUtils::SameType< Surface, NVESurface >::value))
	DigitalSurfaceEmbedderWithNormalVectorEstimator ()
Self &	operator= (const Self &other)
	DigitalSurfaceEmbedderWithNormalVectorEstimator (const DigitalSurfaceEmbedder &aDSEmbedder, const NormalVectorEstimator &anEstimator)
	DigitalSurfaceEmbedderWithNormalVectorEstimator (const Self &other)
	~DigitalSurfaceEmbedderWithNormalVectorEstimator ()
RealPoint	operator() (const SCell &scell) const
const Surface &	surface () const
GradientMap	gradientMap () const
RealVector	gradient (const SCell &scell) const
void	selfDisplay (std::ostream &out) const
bool	isValid () const

Private Attributes
const DigitalSurfaceEmbedder *	myDSEmbedder
const NormalVectorEstimator *	myEstimator

Detailed Description

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

Aim: Combines a digital surface embedder with a normal vector estimator to get a model of CDigitalSurfaceEmbedder and CWithGradientMap. (also default constructible, copy constructible, assignable).

Description of template class 'DigitalSurfaceEmbedderWithNormalVectorEstimator'

Template Parameters:

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

Todo:: assert dimensions of space, embedder and implicit function.

Definition at line 73 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

Member Typedef Documentation

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef DigitalSurfaceEmbedder::Argument DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::Argument

Definition at line 87 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

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

Definition at line 80 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

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

Definition at line 98 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef DigitalSurfaceEmbedder::KSpace DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::KSpace

Definition at line 83 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

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

Definition at line 81 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef NormalVectorEstimator::DigitalSurface DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::NVESurface

Definition at line 93 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef NormalVectorEstimator::Quantity DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::Quantity

Definition at line 92 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef DigitalSurfaceEmbedder::RealPoint DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::RealPoint

Definition at line 86 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef Space::RealVector DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::RealVector

Definition at line 91 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef DigitalSurfaceEmbedder::SCell DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::SCell

Definition at line 85 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

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

Definition at line 77 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef KSpace::Space DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::Space

Definition at line 90 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef DigitalSurfaceEmbedder::Surface DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::Surface

Definition at line 84 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

typedef DigitalSurfaceEmbedder::Value DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::Value

Definition at line 88 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

Constructor & Destructor Documentation

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

inline

Default constructor. The object is not valid.

Definition at line 52 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

: myDSEmbedder( 0 ), myEstimator( 0 )

{}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::DigitalSurfaceEmbedderWithNormalVectorEstimator	(	const DigitalSurfaceEmbedder &	aDSEmbedder,
		const NormalVectorEstimator &	anEstimator
	)

inline

Constructor.

Parameters:

aDSEmbedder	any digital surface embedder.
anEstimator	a normal vector estimator

Definition at line 61 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

  : myDSEmbedder( &aDSEmbedder ),
    myEstimator( &anEstimator )
{}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

inline

Copy Constructor.

Parameters:

other the object to clone.

Definition at line 72 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

  : myDSEmbedder( other.myDSEmbedder ),
    myEstimator( other.myEstimator )
{}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

inline

Destructor.

Definition at line 45 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

{}

Member Function Documentation

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::BOOST_CONCEPT_ASSERT ( (CDigitalSurfaceEmbedder< TDigitalSurfaceEmbedder >) )

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::BOOST_STATIC_ASSERT ( (ConceptUtils::SameType< RealVector, Quantity >::value) )

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::BOOST_STATIC_ASSERT ( (ConceptUtils::SameType< Surface, NVESurface >::value) )

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::RealVector DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::gradient ( const SCell & scell ) const

inline

Parameters:

scell any signed cell in the cellular grid space.

Returns:: the gradient vector at this surfel. Uses the given NormalVectorEstimator.

Definition at line 117 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

{
  ASSERT( this->isValid() );
  return myEstimator->eval( scell );
}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::GradientMap DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::gradientMap ( ) const

inline

Returns:: the gradient map associated to this embedder, i.e. a functor SCell -> RealVector. Uses the given NormalVectorEstimator.

Definition at line 128 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

{
  ASSERT( this->isValid() );
  return GradientMap( *this );
}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

bool DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::isValid ( ) const

inline

Checks the validity/consistency of the object.

Returns:: 'true' if the object is valid, 'false' otherwise.

Definition at line 158 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

{
  return ( myEstimator != 0 ) && ( myDSEmbedder != 0 )
    && ( myEstimator->isValid() ) && ( myDSEmbedder->isValid() );
}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::RealPoint DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::operator() ( const SCell & scell ) const

inline

Maps a signed cell to its corresponding point in the Euclidean space. Uses the given embedder.

Parameters:

scell any signed cell in the cellular grid space.

Returns:: its embedding in the Euclidean space.

Definition at line 106 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

{
  ASSERT( this->isValid() );
  return myDSEmbedder->operator()( scell );
}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

inline

Assignment.

Parameters:

other the object to clone.

Returns:: a reference to 'this'.

Definition at line 83 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

References DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::myDSEmbedder, and DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::myEstimator.

{
  myDSEmbedder = other.myDSEmbedder;
  myEstimator = other.myEstimator;
  return *this;
}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

void DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::selfDisplay ( std::ostream & out ) const

inline

Writes/Displays the object on an output stream.

Parameters:

out	the output stream where the object is written.

Definition at line 145 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

{
  out << "[DigitalSurfaceEmbedderWithNormalVectorEstimator]";
}

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

const DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::Surface & DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::surface ( ) const

inline

Returns:: the associated digital surface.

Definition at line 95 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.ih.

{
  ASSERT( this->isValid() );
  return myDSEmbedder->surface();
}

Field Documentation

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

const DigitalSurfaceEmbedder* DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::myDSEmbedder

private

A pointer on the digital surface.

Definition at line 186 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

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

template<typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator>

const NormalVectorEstimator* DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::myEstimator

private

A pointer on the normal vector estimator.

Definition at line 188 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

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

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

Public Types

Public Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

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