DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor > Class Template Reference

Aim: Computes the true quantity to each element of a range associated to a parametric shape. More...

#include <DGtal/geometry/curves/estimation/TrueLocalEstimatorOnPoints.h>

Public Types
typedef TConstIteratorOnPoints	ConstIterator
typedef TParametricShape	ParametricShape
typedef TParametricShape::RealPoint	RealPoint
typedef TParametricShapeFunctor	ParametricShapeFunctor
typedef ParametricShapeFunctor::Quantity	Quantity

Public Member Functions
	TrueLocalEstimatorOnPoints ()
	~TrueLocalEstimatorOnPoints ()
	TrueLocalEstimatorOnPoints (const TrueLocalEstimatorOnPoints &)=delete
TrueLocalEstimatorOnPoints &	operator= (const TrueLocalEstimatorOnPoints &)=delete
void	attach (const ParametricShape &aShape)
Quantity	eval (const ConstIterator &it, const double h=1.) const
template<typename OutputIterator >
OutputIterator	eval (const ConstIterator &itb, const ConstIterator &ite, OutputIterator result, const double h=1.) const
bool	isValid () const

Private Attributes
const ParametricShapeFunctor *	myFunctorPtr
	Owning pointer on a parametric shape functor. More...

Detailed Description

template<typename TConstIteratorOnPoints, typename TParametricShape, typename TParametricShapeFunctor>
class DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >

Aim: Computes the true quantity to each element of a range associated to a parametric shape.

Description of template class 'TrueLocalEstimatorOnPoints'

Template Parameters

TConstIteratorOnPoints	type of iterator on points used as query points.
TParametricShape	type of the parametric shape.
TParametricShapeFunctor	type of Functor used to evaluate the quantity.

Definition at line 68 of file TrueLocalEstimatorOnPoints.h.

Member Typedef Documentation

ConstIterator

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

typedef TConstIteratorOnPoints DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::ConstIterator

Definition at line 74 of file TrueLocalEstimatorOnPoints.h.

ParametricShape

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

typedef TParametricShape DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::ParametricShape

Definition at line 76 of file TrueLocalEstimatorOnPoints.h.

ParametricShapeFunctor

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

typedef TParametricShapeFunctor DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::ParametricShapeFunctor

Definition at line 79 of file TrueLocalEstimatorOnPoints.h.

Quantity

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

typedef ParametricShapeFunctor::Quantity DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::Quantity

Definition at line 80 of file TrueLocalEstimatorOnPoints.h.

RealPoint

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

typedef TParametricShape::RealPoint DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::RealPoint

Definition at line 77 of file TrueLocalEstimatorOnPoints.h.

Constructor & Destructor Documentation

TrueLocalEstimatorOnPoints() [1/2]

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::TrueLocalEstimatorOnPoints

(

)

Default constructor.

~TrueLocalEstimatorOnPoints()

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::~TrueLocalEstimatorOnPoints

(

)

Destructor.

TrueLocalEstimatorOnPoints() [2/2]

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::TrueLocalEstimatorOnPoints ( const TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor > &  )

delete

Copy constructor.

Member Function Documentation

attach()

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

void DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::attach

(

const ParametricShape &

aShape

)

Attach a shape

Parameters

aShape

parametric shape

Referenced by testCompareEstimator(), and testTrueLocalEstimatorOnShapeDigitization().

eval() [1/2]

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

Quantity DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::eval	(	const ConstIterator &	it,
		const double	h = 1.
	)		const

Estimation at *it

Parameters

it	iterator to the point.
h	grid size (must be > 0).

Returns

the estimated quantity at *it

Referenced by testTrueLocalEstimatorOnShapeDigitization().

eval() [2/2]

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

template<typename OutputIterator >

OutputIterator DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::eval	(	const ConstIterator &	itb,
		const ConstIterator &	ite,
		OutputIterator	result,
		const double	h = 1.
	)		const

Estimation at each element of [itb , ite )

Parameters

itb	begin iterator
ite	end iterator
h	grid size (must be > 0).
result	the output iterator to the results.

Returns

the estimated quantity from itb till ite (excluded)

isValid()

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

bool DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::isValid

(

)

const

Checks the validity/consistency of the object.

Returns

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

operator=()

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

TrueLocalEstimatorOnPoints& DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::operator= ( const TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor > &  )

delete

Assignment operator.

Field Documentation

myFunctorPtr

template<typename TConstIteratorOnPoints , typename TParametricShape , typename TParametricShapeFunctor >

const ParametricShapeFunctor* DGtal::TrueLocalEstimatorOnPoints< TConstIteratorOnPoints, TParametricShape, TParametricShapeFunctor >::myFunctorPtr

private

Owning pointer on a parametric shape functor.

Definition at line 147 of file TrueLocalEstimatorOnPoints.h.

---

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

• TrueLocalEstimatorOnPoints.h