DGtal::FPLengthEstimator< TConstIterator > Class Template Reference

Aim: a model of CGlobalCurveEstimator that computes the length of a digital curve using its FP (faithful polygon) More...

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

Public Types
typedef TConstIterator	ConstIterator
typedef double	Quantity
typedef FP< ConstIterator, int, 4 >	FaithfulPolygon
typedef FaithfulPolygon::Point	Point
typedef FaithfulPolygon::Vector	Vector

Public Member Functions
	FPLengthEstimator ()=default
	~FPLengthEstimator ()=default
	FPLengthEstimator (const FPLengthEstimator &other)=delete
FPLengthEstimator &	operator= (const FPLengthEstimator &other)=delete
Quantity	eval (const ConstIterator &itb, const ConstIterator &ite, const double h=1.) const
void	selfDisplay (std::ostream &out) const
bool	isValid () const

Detailed Description

template<typename TConstIterator>
class DGtal::FPLengthEstimator< TConstIterator >

Aim: a model of CGlobalCurveEstimator that computes the length of a digital curve using its FP (faithful polygon)

Description of template class 'FPLengthEstimator'

Model of CGlobalCurveGeometricEstimator

Template Parameters

TConstIterator

a model of CConstIteratorOnPoints.

Definition at line 69 of file FPLengthEstimator.h.

Member Typedef Documentation

ConstIterator

template<typename TConstIterator >

typedef TConstIterator DGtal::FPLengthEstimator< TConstIterator >::ConstIterator

Todo:

CONCEPT CHECK sur ConstIterator

Definition at line 76 of file FPLengthEstimator.h.

FaithfulPolygon

template<typename TConstIterator >

typedef FP<ConstIterator,int,4> DGtal::FPLengthEstimator< TConstIterator >::FaithfulPolygon

Definition at line 80 of file FPLengthEstimator.h.

Point

template<typename TConstIterator >

typedef FaithfulPolygon::Point DGtal::FPLengthEstimator< TConstIterator >::Point

Definition at line 81 of file FPLengthEstimator.h.

Quantity

template<typename TConstIterator >

typedef double DGtal::FPLengthEstimator< TConstIterator >::Quantity

Definition at line 78 of file FPLengthEstimator.h.

Vector

template<typename TConstIterator >

typedef FaithfulPolygon::Vector DGtal::FPLengthEstimator< TConstIterator >::Vector

Definition at line 82 of file FPLengthEstimator.h.

Constructor & Destructor Documentation

FPLengthEstimator() [1/2]

template<typename TConstIterator >

DGtal::FPLengthEstimator< TConstIterator >::FPLengthEstimator ( )

default

Default Constructor.

~FPLengthEstimator()

template<typename TConstIterator >

DGtal::FPLengthEstimator< TConstIterator >::~FPLengthEstimator ( )

default

Destructor.

FPLengthEstimator() [2/2]

template<typename TConstIterator >

DGtal::FPLengthEstimator< TConstIterator >::FPLengthEstimator ( const FPLengthEstimator< TConstIterator > &  other )

delete

Copy constructor.

Parameters

other

the object to clone. Forbidden by default.

Member Function Documentation

eval()

template<typename TConstIterator >

Quantity DGtal::FPLengthEstimator< TConstIterator >::eval	(	const ConstIterator &	itb,
		const ConstIterator &	ite,
		const double	h = 1.
	)		const

Computation of the l1 length of the curve. Complexity: O(|Range|)

Parameters

itb	begin iterator
ite	end iterator
h	grid size (must be > 0).

Returns

the curve length.

Referenced by testL1LengthEstimator().

isValid()

template<typename TConstIterator >

bool DGtal::FPLengthEstimator< TConstIterator >::isValid

(

)

const

Checks the validity/consistency of the object.

Returns

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

operator=()

template<typename TConstIterator >

FPLengthEstimator& DGtal::FPLengthEstimator< TConstIterator >::operator= ( const FPLengthEstimator< TConstIterator > &  other )

delete

Assignment.

Parameters

other

the object to copy.

Returns

a reference on 'this'. Forbidden by default.

selfDisplay()

template<typename TConstIterator >

void DGtal::FPLengthEstimator< TConstIterator >::selfDisplay

(

std::ostream &

out

)

const

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

---

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

• FPLengthEstimator.h