DGtal::FPLengthEstimator< TConstIterator > Class Template Reference

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

Collaboration diagram for DGtal::FPLengthEstimator< TConstIterator >:

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 ()
	~FPLengthEstimator ()
void	init (const double h, const ConstIterator &itb, const ConstIterator &ite, const bool &isClosed)
Quantity	eval () const
void	selfDisplay (std::ostream &out) const
bool	isValid () const

Private Member Functions
	FPLengthEstimator (const FPLengthEstimator &other)
FPLengthEstimator &	operator= (const FPLengthEstimator &other)

Private Attributes
double	myH
std::vector< Point >	myRep
bool	myIsInitBefore

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

template<typename TConstIterator>

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

Todo:

CONCEPT CHECK sur ConstIterator

Definition at line 76 of file FPLengthEstimator.h.

template<typename TConstIterator>

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

Definition at line 80 of file FPLengthEstimator.h.

template<typename TConstIterator>

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

Definition at line 81 of file FPLengthEstimator.h.

template<typename TConstIterator>

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

Definition at line 78 of file FPLengthEstimator.h.

template<typename TConstIterator>

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

Definition at line 82 of file FPLengthEstimator.h.

Constructor & Destructor Documentation

template<typename TConstIterator>

DGtal::FPLengthEstimator< TConstIterator >::FPLengthEstimator

(

)

Default Constructor.

template<typename TConstIterator>

DGtal::FPLengthEstimator< TConstIterator >::~FPLengthEstimator

(

)

Destructor.

template<typename TConstIterator>

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

private

Copy constructor.

Parameters

other

the object to clone. Forbidden by default.

Member Function Documentation

template<typename TConstIterator>

Quantity DGtal::FPLengthEstimator< TConstIterator >::eval

(

)

const

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

Precondition

init() method must be called before.

Returns

the curve length.

template<typename TConstIterator>

void DGtal::FPLengthEstimator< TConstIterator >::init	(	const double	h,
		const ConstIterator &	itb,
		const ConstIterator &	ite,
		const bool &	isClosed
	)

Initialize the measure computation.

Parameters

h	grid size (must be >0).
itb	begin iterator
ite	end iterator
isClosed	true if the input range is closed.

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.

template<typename TConstIterator>

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

private

Assignment.

Parameters

other

the object to copy.

Returns

a reference on 'this'. Forbidden by default.

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.

Field Documentation

template<typename TConstIterator>

double DGtal::FPLengthEstimator< TConstIterator >::myH

private

Grid size.

Definition at line 136 of file FPLengthEstimator.h.

template<typename TConstIterator>

bool DGtal::FPLengthEstimator< TConstIterator >::myIsInitBefore

private

Boolean to make sure that init() has been called before eval().

Definition at line 142 of file FPLengthEstimator.h.

template<typename TConstIterator>

std::vector<Point> DGtal::FPLengthEstimator< TConstIterator >::myRep

private

polygonal representation of the input

Definition at line 139 of file FPLengthEstimator.h.

---

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

• FPLengthEstimator.h