DGtal: DGtal::EstimatorCache< TEstimator, TContainer

Aim: this class adapts any local surface estimator to cache the estimated values in a associative container (Surfel <-> estimated value). More...

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

Public Types
typedef TEstimator	Estimator
	Estimator type. More...

typedef TContainer	Container
	Container type. More...

typedef Estimator::Surfel	Surfel
	Surfel type. More...

typedef Estimator::Quantity	Quantity
	Quantity type. More...

typedef EstimatorCache< Estimator, Container >	Self
	Self. More...

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CSurfelLocalEstimator< TEstimator >))

	BOOST_CONCEPT_ASSERT ((boost::PairAssociativeContainer< TContainer >))

	EstimatorCache ()

	EstimatorCache (Alias< Estimator > anEstimator)

	~EstimatorCache ()

	EstimatorCache (const Self &other)

Self &	operator= (const Self &other)

template<typename SurfelConstIterator >
void	init (const double aH, SurfelConstIterator itb, SurfelConstIterator ite)

template<typename SurfelConstIterator >
Quantity	eval (const SurfelConstIterator it) const

Quantity	eval (const Surfel s) const

template<typename SurfelConstIterator , typename OutputIterator >
OutputIterator	eval (SurfelConstIterator itb, SurfelConstIterator ite, OutputIterator result) const

double	h () const

Container::size_type	size () const

void	selfDisplay (std::ostream &out) const

bool	isValid () const

Private Attributes
Container	myContainer
	Instance of estimator. More...

Estimator *	myEstimator
	Alias of the estimator. More...

bool	myInit
	Init flag. More...

Detailed Description

template<typename TEstimator, typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>
class DGtal::EstimatorCache< TEstimator, TContainer >

Aim: this class adapts any local surface estimator to cache the estimated values in a associative container (Surfel <-> estimated value).

Description of template class 'EstimatorCache'

The use-case of this class is when you want to estimate the same quantity several times.

This class implements eval() methods for surfel iterators as in concepts::CSurfelLocalEstimator concept. Addtitionnaly, we also have an eval method from a surfel.

This class is also a model of concepts::CSurfelLocalEstimator

See also: testEstimatorCache.cpp

Template Parameters

TEstimator	any model of CSurfelLocalEstimator
TContainer	the associative container to use (default type: std::map<Surfel,Quantity>)

Definition at line 77 of file EstimatorCache.h.

Member Typedef Documentation

◆ Container

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

typedef TContainer DGtal::EstimatorCache< TEstimator, TContainer >::Container

Container type.

Definition at line 88 of file EstimatorCache.h.

◆ Estimator

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

typedef TEstimator DGtal::EstimatorCache< TEstimator, TContainer >::Estimator

Estimator type.

Definition at line 84 of file EstimatorCache.h.

◆ Quantity

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

typedef Estimator::Quantity DGtal::EstimatorCache< TEstimator, TContainer >::Quantity

Quantity type.

Definition at line 97 of file EstimatorCache.h.

◆ Self

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

typedef EstimatorCache<Estimator,Container> DGtal::EstimatorCache< TEstimator, TContainer >::Self

Self.

Definition at line 100 of file EstimatorCache.h.

◆ Surfel

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

typedef Estimator::Surfel DGtal::EstimatorCache< TEstimator, TContainer >::Surfel

Surfel type.

Definition at line 94 of file EstimatorCache.h.

Constructor & Destructor Documentation

◆ EstimatorCache() [1/3]

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

DGtal::EstimatorCache< TEstimator, TContainer >::EstimatorCache ( )

inline

Default constructor.

Definition at line 105 of file EstimatorCache.h.

105 : myInit(false)

106 {}

DGtal::EstimatorCache::myInit

bool myInit

Init flag.

Definition: EstimatorCache.h:285

◆ EstimatorCache() [2/3]

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

DGtal::EstimatorCache< TEstimator, TContainer >::EstimatorCache ( Alias< Estimator > anEstimator )

inline

Constructor from estimator instance.

Definition at line 112 of file EstimatorCache.h.

                                                  : myEstimator(&anEstimator),
                                                    myInit(false)
     {}

◆ ~EstimatorCache()

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

DGtal::EstimatorCache< TEstimator, TContainer >::~EstimatorCache ( )

inline

Destructor.

Definition at line 119 of file EstimatorCache.h.

120 {}

◆ EstimatorCache() [3/3]

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

DGtal::EstimatorCache< TEstimator, TContainer >::EstimatorCache ( const Self & other )

inline

Copy constructor.

Definition at line 125 of file EstimatorCache.h.

                                      : myContainer(other.myContainer),
                                        myEstimator(other.myEstimator),
                                        myInit(other.myInit)
     {}

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/2]

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

DGtal::EstimatorCache< TEstimator, TContainer >::BOOST_CONCEPT_ASSERT ( (boost::PairAssociativeContainer< TContainer >) )

◆ BOOST_CONCEPT_ASSERT() [2/2]

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

DGtal::EstimatorCache< TEstimator, TContainer >::BOOST_CONCEPT_ASSERT ( (concepts::CSurfelLocalEstimator< TEstimator >) )

◆ eval() [1/3]

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

Quantity DGtal::EstimatorCache< TEstimator, TContainer >::eval ( const Surfel s ) const

inline

Cached evaluation of the estimator at a surfel s

Precondition: init() method must have been called first.

Parameters

[in] s the iterator to the surfel to estimate.

Returns: the estimated quantity.

Definition at line 197 of file EstimatorCache.h.

     {
       ASSERT_MSG(myInit, " init() method must have been called first.");
       return myContainer.find( s )->second;
     }

References DGtal::EstimatorCache< TEstimator, TContainer >::myContainer, and DGtal::EstimatorCache< TEstimator, TContainer >::myInit.

◆ eval() [2/3]

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

template<typename SurfelConstIterator >

Quantity DGtal::EstimatorCache< TEstimator, TContainer >::eval ( const SurfelConstIterator it ) const

inline

Cached evaluation of the estimator at iterator it

Precondition: init() method must have been called first.

Template Parameters

SurfelConstIterator a const iterator on surfels.

Parameters

[in] it the iterator to the surfel to estimate.

Returns: the estimated quantity.

Definition at line 183 of file EstimatorCache.h.

     {
       ASSERT_MSG(myInit, " init() method must have been called first.");
       return myContainer.find( *it )->second;
     }

References DGtal::EstimatorCache< TEstimator, TContainer >::myContainer, and DGtal::EstimatorCache< TEstimator, TContainer >::myInit.

Referenced by DGtal::EstimatorCache< TEstimator, TContainer >::eval().

◆ eval() [3/3]

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

template<typename SurfelConstIterator , typename OutputIterator >

OutputIterator DGtal::EstimatorCache< TEstimator, TContainer >::eval	(	SurfelConstIterator	itb,
		SurfelConstIterator	ite,
		OutputIterator	result
	)		const

inline

Cached range evaluation of the estimator between itb and ite.

Precondition: init() method must have been called first.

Template Parameters

SurfelConstIterator a const iterator on surfels.

Parameters

[in]	itb	the begin iterator to the surfel to estimate.
[in]	ite	the end iterator to the surfel to estimate.
[in]	result	an output iterator on the result.

Returns: the estimated quantity.

Definition at line 218 of file EstimatorCache.h.

     {
       ASSERT_MSG(myInit, " init() method must have been called first.");
       for(SurfelConstIterator it = itb; it != ite; ++it)
         *result++ = this->eval(it);
       
       return result;
     }

References DGtal::EstimatorCache< TEstimator, TContainer >::eval(), and DGtal::EstimatorCache< TEstimator, TContainer >::myInit.

◆ h()

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

double DGtal::EstimatorCache< TEstimator, TContainer >::h ( ) const

inline

Returns: the gridstep.

Precondition: init() method must have been called first.

Definition at line 236 of file EstimatorCache.h.

     {
       return myEstimator->h();
     }

References DGtal::EstimatorCache< TEstimator, TContainer >::myEstimator.

◆ init()

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

template<typename SurfelConstIterator >

void DGtal::EstimatorCache< TEstimator, TContainer >::init	(	const double	aH,
		SurfelConstIterator	itb,
		SurfelConstIterator	ite
	)

inline

Estimator initialization. This method initializes the underlying estimator and caches all estimated quantity between itb and ite.

Template Parameters

SurfelConstIterator a const iterator on surfels.

Parameters

[in]	aH	the gridstep
[in]	ite	iterator on the first surfel of the surface.
[in]	itb	iterator after the last surfel of the surface.

Definition at line 158 of file EstimatorCache.h.

     {
       ASSERT(myEstimator);
       myEstimator->init(aH,itb,ite);
       myContainer.clear();
  
       //We estimate and store the quantities
       //(since SurfelConstIterator models are usually SinglePass, we
       //cannot use the optimized "range" eval on the estimator)
       for(SurfelConstIterator it = itb; it != ite; ++it)
         myContainer.insert( std::pair<Surfel, Quantity>(*it, myEstimator->eval(it) ) );
       
       myInit = true;
     }

References DGtal::EstimatorCache< TEstimator, TContainer >::myContainer, DGtal::EstimatorCache< TEstimator, TContainer >::myEstimator, and DGtal::EstimatorCache< TEstimator, TContainer >::myInit.

◆ isValid()

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

bool DGtal::EstimatorCache< TEstimator, TContainer >::isValid ( ) const

inline

Checks the validity/consistency of the object.

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

Definition at line 267 of file EstimatorCache.h.

     {
       return myEstimator && myEstimator->isValid();
     }

References DGtal::EstimatorCache< TEstimator, TContainer >::myEstimator.

◆ operator=()

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

Self& DGtal::EstimatorCache< TEstimator, TContainer >::operator= ( const Self & other )

inline

Assignment.

Parameters

other the object to copy.

Returns: a reference on 'this'. Forbidden by default.

Definition at line 136 of file EstimatorCache.h.

     {
       myContainer = other.myContainer;
       myEstimator = other.myEstimator;
       myInit = other.myInit;
       
       return *this;
     }

References DGtal::EstimatorCache< TEstimator, TContainer >::myContainer, DGtal::EstimatorCache< TEstimator, TContainer >::myEstimator, and DGtal::EstimatorCache< TEstimator, TContainer >::myInit.

◆ selfDisplay()

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

void DGtal::EstimatorCache< TEstimator, TContainer >::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 258 of file EstimatorCache.h.

     {
       out<< "[EstimatorCache] number of surfels="<<myContainer.size();
     }

References DGtal::EstimatorCache< TEstimator, TContainer >::myContainer.

◆ size()

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

Container::size_type DGtal::EstimatorCache< TEstimator, TContainer >::size ( ) const

inline

Precondition: init() method must have been called first.

Returns: the number of cached elements.

Definition at line 248 of file EstimatorCache.h.

     {
       ASSERT_MSG(myInit, " init() method must have been called first.");
       return myContainer.size();
     }

References DGtal::EstimatorCache< TEstimator, TContainer >::myContainer, and DGtal::EstimatorCache< TEstimator, TContainer >::myInit.

Field Documentation

◆ myContainer

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

Container DGtal::EstimatorCache< TEstimator, TContainer >::myContainer

private

Instance of estimator.

Definition at line 279 of file EstimatorCache.h.

Referenced by DGtal::EstimatorCache< TEstimator, TContainer >::eval(), DGtal::EstimatorCache< TEstimator, TContainer >::init(), DGtal::EstimatorCache< TEstimator, TContainer >::operator=(), DGtal::EstimatorCache< TEstimator, TContainer >::selfDisplay(), and DGtal::EstimatorCache< TEstimator, TContainer >::size().

◆ myEstimator

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

Estimator* DGtal::EstimatorCache< TEstimator, TContainer >::myEstimator

private

Alias of the estimator.

Definition at line 282 of file EstimatorCache.h.

Referenced by DGtal::EstimatorCache< TEstimator, TContainer >::h(), DGtal::EstimatorCache< TEstimator, TContainer >::init(), DGtal::EstimatorCache< TEstimator, TContainer >::isValid(), and DGtal::EstimatorCache< TEstimator, TContainer >::operator=().

◆ myInit

template<typename TEstimator , typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>

bool DGtal::EstimatorCache< TEstimator, TContainer >::myInit

private

Init flag.

Definition at line 285 of file EstimatorCache.h.

Referenced by DGtal::EstimatorCache< TEstimator, TContainer >::eval(), DGtal::EstimatorCache< TEstimator, TContainer >::init(), DGtal::EstimatorCache< TEstimator, TContainer >::operator=(), and DGtal::EstimatorCache< TEstimator, TContainer >::size().

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

EstimatorCache.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

template<typename TEstimator, typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>> class DGtal::EstimatorCache< TEstimator, TContainer >

Member Typedef Documentation

◆ Container

◆ Estimator

◆ Quantity

◆ Self

◆ Surfel

Constructor & Destructor Documentation

◆ EstimatorCache() [1/3]

◆ EstimatorCache() [2/3]

◆ ~EstimatorCache()

◆ EstimatorCache() [3/3]

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/2]

◆ BOOST_CONCEPT_ASSERT() [2/2]

◆ eval() [1/3]

◆ eval() [2/3]

◆ eval() [3/3]

◆ h()

◆ init()

◆ isValid()

◆ operator=()

◆ selfDisplay()

◆ size()

Field Documentation

◆ myContainer

◆ myEstimator

◆ myInit

template<typename TEstimator, typename TContainer = std::map<typename TEstimator::Surfel, typename TEstimator::Quantity>>
class DGtal::EstimatorCache< TEstimator, TContainer >