DGtal::DSSLengthEstimator< TConstIterator > Class Template Reference

Aim: a model of CGlobalCurveEstimator that segments the digital curve into DSS and computes the length of the resulting (not uniquely defined) polygon. More...

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

Public Types
typedef TConstIterator	ConstIterator
typedef double	Quantity
typedef ArithmeticalDSSComputer< ConstIterator, int, 4 >	DSSComputer
typedef DSSComputer::Point	Point
typedef DSSComputer::Vector	Vector

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

Private Member Functions
	BOOST_CONCEPT_ASSERT ((boost_concepts::ReadableIteratorConcept< TConstIterator >))
	BOOST_CONCEPT_ASSERT ((boost_concepts::ForwardTraversalConcept< TConstIterator >))

Detailed Description

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

Aim: a model of CGlobalCurveEstimator that segments the digital curve into DSS and computes the length of the resulting (not uniquely defined) polygon.

Description of template class 'DSSLengthEstimator'

Model of CGlobalCurveGeometricEstimator

Template Parameters

TConstIterator

a model of CConstIteratorOnPoints.

Definition at line 76 of file DSSLengthEstimator.h.

Member Typedef Documentation

ConstIterator

template<typename TConstIterator >

typedef TConstIterator DGtal::DSSLengthEstimator< TConstIterator >::ConstIterator

Todo:

CONCEPT CHECK sur ConstIterator

Definition at line 86 of file DSSLengthEstimator.h.

DSSComputer

template<typename TConstIterator >

typedef ArithmeticalDSSComputer<ConstIterator,int,4> DGtal::DSSLengthEstimator< TConstIterator >::DSSComputer

Definition at line 90 of file DSSLengthEstimator.h.

Point

template<typename TConstIterator >

typedef DSSComputer::Point DGtal::DSSLengthEstimator< TConstIterator >::Point

Definition at line 91 of file DSSLengthEstimator.h.

Quantity

template<typename TConstIterator >

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

Definition at line 88 of file DSSLengthEstimator.h.

Vector

template<typename TConstIterator >

typedef DSSComputer::Vector DGtal::DSSLengthEstimator< TConstIterator >::Vector

Definition at line 92 of file DSSLengthEstimator.h.

Constructor & Destructor Documentation

DSSLengthEstimator() [1/2]

template<typename TConstIterator >

DGtal::DSSLengthEstimator< TConstIterator >::DSSLengthEstimator ( )

default

Default Constructor.

~DSSLengthEstimator()

template<typename TConstIterator >

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

default

Destructor.

DSSLengthEstimator() [2/2]

template<typename TConstIterator >

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

delete

Copy constructor.

Parameters

other

the object to clone. Forbidden by default.

Member Function Documentation

BOOST_CONCEPT_ASSERT() [1/2]

template<typename TConstIterator >

DGtal::DSSLengthEstimator< TConstIterator >::BOOST_CONCEPT_ASSERT ( (boost_concepts::ForwardTraversalConcept< TConstIterator >)  )

private

BOOST_CONCEPT_ASSERT() [2/2]

template<typename TConstIterator >

DGtal::DSSLengthEstimator< TConstIterator >::BOOST_CONCEPT_ASSERT ( (boost_concepts::ReadableIteratorConcept< TConstIterator >)  )

private

eval()

template<typename TConstIterator >

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

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

Precondition

init() method must be called before.

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::DSSLengthEstimator< TConstIterator >::isValid

(

)

const

Checks the validity/consistency of the object.

Returns

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

operator=()

template<typename TConstIterator >

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

delete

Assignment.

Parameters

other

the object to copy.

Returns

a reference on 'this'. Forbidden by default.

selfDisplay()

template<typename TConstIterator >

void DGtal::DSSLengthEstimator< 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:

• DSSLengthEstimator.h