DGtal  1.3.beta
Public Types | Public Member Functions
DGtal::L1LengthEstimator< TConstIterator > Class Template Reference

Aim: a simple model of CGlobalCurveEstimator that compute the length of a curve using the l_1 metric (just add 1/h for every step). More...

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

Public Types

typedef TConstIterator ConstIterator
 
typedef double Quantity
 

Public Member Functions

 L1LengthEstimator ()=default
 
 ~L1LengthEstimator ()=default
 
 L1LengthEstimator (const L1LengthEstimator &other)=delete
 
L1LengthEstimatoroperator= (const L1LengthEstimator &other)=delete
 
Quantity eval (const ConstIterator &itb, const ConstIterator &ite, const double h) const
 
void selfDisplay (std::ostream &out) const
 
bool isValid () const
 

Detailed Description

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

Aim: a simple model of CGlobalCurveEstimator that compute the length of a curve using the l_1 metric (just add 1/h for every step).

Description of template class 'L1LengthEstimator'

Model of CGlobalCurveGeometricEstimator

Template Parameters
TConstIteratora model of CConstIteratorOnArrows.

Definition at line 67 of file L1LengthEstimator.h.

Member Typedef Documentation

◆ ConstIterator

template<typename TConstIterator >
typedef TConstIterator DGtal::L1LengthEstimator< TConstIterator >::ConstIterator
Todo:
CONCEPT CHECK sur ConstIterator

Definition at line 74 of file L1LengthEstimator.h.

◆ Quantity

template<typename TConstIterator >
typedef double DGtal::L1LengthEstimator< TConstIterator >::Quantity

Definition at line 76 of file L1LengthEstimator.h.

Constructor & Destructor Documentation

◆ L1LengthEstimator() [1/2]

template<typename TConstIterator >
DGtal::L1LengthEstimator< TConstIterator >::L1LengthEstimator ( )
default

Default Constructor.

◆ ~L1LengthEstimator()

template<typename TConstIterator >
DGtal::L1LengthEstimator< TConstIterator >::~L1LengthEstimator ( )
default

Destructor.

◆ L1LengthEstimator() [2/2]

template<typename TConstIterator >
DGtal::L1LengthEstimator< TConstIterator >::L1LengthEstimator ( const L1LengthEstimator< TConstIterator > &  other)
delete

Copy constructor.

Parameters
otherthe object to clone. Forbidden by default.

Member Function Documentation

◆ eval()

template<typename TConstIterator >
Quantity DGtal::L1LengthEstimator< TConstIterator >::eval ( const ConstIterator itb,
const ConstIterator ite,
const double  h 
) const

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

Parameters
itbbegin iterator
iteend iterator
hgrid size (must be > 0).
Returns
the curve length.

Referenced by testL1LengthEstimator().

◆ isValid()

template<typename TConstIterator >
bool DGtal::L1LengthEstimator< TConstIterator >::isValid ( ) const

Checks the validity/consistency of the object.

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

◆ operator=()

template<typename TConstIterator >
L1LengthEstimator& DGtal::L1LengthEstimator< TConstIterator >::operator= ( const L1LengthEstimator< TConstIterator > &  other)
delete

Assignment.

Parameters
otherthe object to copy.
Returns
a reference on 'this'. Forbidden by default.

◆ selfDisplay()

template<typename TConstIterator >
void DGtal::L1LengthEstimator< TConstIterator >::selfDisplay ( std::ostream &  out) const

Writes/Displays the object on an output stream.

Parameters
outthe output stream where the object is written.

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