DGtal: 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). More...

#include <DGtal/geometry/surfaces/estimation/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 ((concepts::CDigitalSurfaceEmbedder< TDigitalSurfaceEmbedder >))

	BOOST_STATIC_ASSERT ((concepts::ConceptUtils::SameType< RealVector, Quantity >::value))

	BOOST_STATIC_ASSERT ((concepts::ConceptUtils::SameType< Surface, NVESurface >::value))

	DigitalSurfaceEmbedderWithNormalVectorEstimator ()

Self &	operator= (const Self &other)

	DigitalSurfaceEmbedderWithNormalVectorEstimator (ConstAlias< DigitalSurfaceEmbedder > aDSEmbedder, ConstAlias< NormalVectorEstimator > anEstimator)

	DigitalSurfaceEmbedderWithNormalVectorEstimator (const Self &other)

	~DigitalSurfaceEmbedderWithNormalVectorEstimator ()

RealPoint	operator() (const SCell &scell) const

const Surface &	surface () const

const KSpace &	space () const

GradientMap	gradientMap () const

RealVector	gradient (const SCell &scell) const

void	selfDisplay (std::ostream &out) const

bool	isValid () const

Private Attributes
const DigitalSurfaceEmbedder *	myDSEmbedder
	A pointer on the digital surface. More...

const NormalVectorEstimator *	myEstimator
	A pointer on the normal vector estimator. More...

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 74 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

Member Typedef Documentation

◆ Argument

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 88 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ DigitalSurfaceEmbedder

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 81 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ GradientMap

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 99 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ KSpace

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 84 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ NormalVectorEstimator

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 82 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ NVESurface

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 94 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ Quantity

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 93 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ RealPoint

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 87 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ RealVector

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 92 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ SCell

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 86 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ Self

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 78 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ Space

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 91 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ Surface

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 85 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

◆ Value

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Definition at line 89 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

Constructor & Destructor Documentation

◆ DigitalSurfaceEmbedderWithNormalVectorEstimator() [1/3]

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Default constructor. The object is not valid.

◆ DigitalSurfaceEmbedderWithNormalVectorEstimator() [2/3]

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Constructor.

Parameters

aDSEmbedder	any digital surface embedder.
anEstimator	a normal vector estimator

◆ DigitalSurfaceEmbedderWithNormalVectorEstimator() [3/3]

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Copy Constructor.

Parameters

other the object to clone.

◆ ~DigitalSurfaceEmbedderWithNormalVectorEstimator()

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Destructor.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

◆ BOOST_STATIC_ASSERT() [1/2]

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

◆ BOOST_STATIC_ASSERT() [2/2]

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

◆ gradient()

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Parameters

scell any signed cell in the cellular grid space.

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

◆ gradientMap()

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

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

◆ isValid()

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Checks the validity/consistency of the object.

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

◆ operator()()

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

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.

◆ operator=()

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Assignment.

Parameters

other the object to clone.

Returns: a reference to 'this'.

◆ selfDisplay()

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

◆ space()

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

const KSpace& DGtal::DigitalSurfaceEmbedderWithNormalVectorEstimator< TDigitalSurfaceEmbedder, TNormalVectorEstimator >::space ( ) const

inline

Returns: the associated khalimsky space.

Definition at line 155 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

     {
       return myDSEmbedder->space();
     }

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

◆ surface()

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

Returns: the associated digital surface.

Field Documentation

◆ myDSEmbedder

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

private

A pointer on the digital surface.

Definition at line 195 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

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

◆ myEstimator

template<typename TDigitalSurfaceEmbedder , typename TNormalVectorEstimator >

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

private

A pointer on the normal vector estimator.

Definition at line 197 of file DigitalSurfaceEmbedderWithNormalVectorEstimator.h.

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

DigitalSurfaceEmbedderWithNormalVectorEstimator.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ Argument

◆ DigitalSurfaceEmbedder

◆ GradientMap

◆ KSpace

◆ NormalVectorEstimator

◆ NVESurface

◆ Quantity

◆ RealPoint

◆ RealVector

◆ SCell

◆ Self

◆ Space

◆ Surface

◆ Value

Constructor & Destructor Documentation

◆ DigitalSurfaceEmbedderWithNormalVectorEstimator() [1/3]

◆ DigitalSurfaceEmbedderWithNormalVectorEstimator() [2/3]

◆ DigitalSurfaceEmbedderWithNormalVectorEstimator() [3/3]

◆ ~DigitalSurfaceEmbedderWithNormalVectorEstimator()

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

◆ BOOST_STATIC_ASSERT() [1/2]

◆ BOOST_STATIC_ASSERT() [2/2]

◆ gradient()

◆ gradientMap()

◆ isValid()

◆ operator()()

◆ operator=()

◆ selfDisplay()

◆ space()

◆ surface()

Field Documentation

◆ myDSEmbedder

◆ myEstimator

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