DGtal::CLocalGeometricEstimator< T > Struct Template Reference

#include <CLocalCurveGeometricEstimator.h>

Inheritance diagram for DGtal::CLocalGeometricEstimator< T >:

Collaboration diagram for DGtal::CLocalGeometricEstimator< T >:

Public Types
typedef T::Quantity	Quantity
typedef T::ConstIterator	ConstIterator

Public Member Functions
	BOOST_CONCEPT_ASSERT ((CQuantity< Quantity >))
	BOOST_CONCEPT_ASSERT ((boost_concepts::ReadableIteratorConcept< ConstIterator >))
	BOOST_CONCEPT_ASSERT ((boost_concepts::ForwardTraversalConcept< ConstIterator >))
	BOOST_CONCEPT_USAGE (CLocalGeometricEstimator)

Private Attributes
T	myX
double	myH
ConstIterator	myItb
ConstIterator	myIte
Quantity	myQ
boost::iterator_archetype < Quantity, boost::iterator_archetypes::writable_iterator_t, boost::incrementable_traversal_tag >	myIto

---

Detailed Description

template<typename T>
struct DGtal::CLocalGeometricEstimator< T >

Aim: This concept describes an object that can process a range so as to return one estimated quantity for each element of the range (or a given subrange).

Description of concept 'CLocalGeometricEstimator'

Refinement of

• boost::DefaultConstructible

Associated types :

• ConstIterator
• Quantity

Notation

• X : A type that is a model of CLocalGeometricEstimator
• x : object of type X
• h : double
• itb, ite, it : objects of type ConstIterator
• ito : an instance of a model of output iterator having Quantity as value type

Definitions

Valid expressions and semantics

| Name | Expression | | Return type | Precondition | Semantics | | Complexity | |—————-+——————————-+—+——————————+————–+——————————————-+—+—————–| | Initialization | x.init( h, itb, ite ) | | void | h > 0 | Grid step and range initialization | | constant | | Evaluation | x.eval( it ) | | Quantity | | Estimation of the quantity at it | | model dependant | | Evaluation | ito = x.eval( itb, ite, ito ) | | a model of output iterator | | Estimation for each element of [itb, ite) | | model dependant |

Invariants

Models

MostCenteredMaximalSegmentEstimator TrueLocalEstimatorOnPoints

Notes

Template Parameters:

T	the type that should be a model of CLocalGeometricEstimator.

Definition at line 96 of file CLocalCurveGeometricEstimator.h.

---

Member Typedef Documentation

template<typename T >

typedef T::ConstIterator DGtal::CLocalGeometricEstimator< T >::ConstIterator

Definition at line 106 of file CLocalCurveGeometricEstimator.h.

template<typename T >

typedef T::Quantity DGtal::CLocalGeometricEstimator< T >::Quantity

Definition at line 103 of file CLocalCurveGeometricEstimator.h.

---

Member Function Documentation

template<typename T >

DGtal::CLocalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT

(

(CQuantity< Quantity >)

)

template<typename T >

DGtal::CLocalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT

(

(boost_concepts::ReadableIteratorConcept< ConstIterator >)

)

template<typename T >

DGtal::CLocalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT

(

(boost_concepts::ForwardTraversalConcept< ConstIterator >)

)

template<typename T >

DGtal::CLocalGeometricEstimator< T >::BOOST_CONCEPT_USAGE ( CLocalGeometricEstimator< T >  )

inline

Definition at line 111 of file CLocalCurveGeometricEstimator.h.

References DGtal::CLocalGeometricEstimator< T >::myH, DGtal::CLocalGeometricEstimator< T >::myItb, DGtal::CLocalGeometricEstimator< T >::myIte, DGtal::CLocalGeometricEstimator< T >::myIto, DGtal::CLocalGeometricEstimator< T >::myQ, DGtal::CLocalGeometricEstimator< T >::myX, and DGtal::ConceptUtils::sameType().

    {
      //init method
      myX.init( myH, myItb, myIte ); 

      ConceptUtils::sameType( myQ, myX.eval( myItb ) );
      ConceptUtils::sameType( myIto, myX.eval( myItb, myIte, myIto ) );
    }

---

Field Documentation

template<typename T >

double DGtal::CLocalGeometricEstimator< T >::myH

private

Definition at line 124 of file CLocalCurveGeometricEstimator.h.

Referenced by DGtal::CLocalGeometricEstimator< T >::BOOST_CONCEPT_USAGE().

template<typename T >

ConstIterator DGtal::CLocalGeometricEstimator< T >::myItb

private

Definition at line 125 of file CLocalCurveGeometricEstimator.h.

Referenced by DGtal::CLocalGeometricEstimator< T >::BOOST_CONCEPT_USAGE().

template<typename T >

ConstIterator DGtal::CLocalGeometricEstimator< T >::myIte

private

Definition at line 125 of file CLocalCurveGeometricEstimator.h.

Referenced by DGtal::CLocalGeometricEstimator< T >::BOOST_CONCEPT_USAGE().

template<typename T >

boost::iterator_archetype<Quantity, boost::iterator_archetypes::writable_iterator_t, boost::incrementable_traversal_tag > DGtal::CLocalGeometricEstimator< T >::myIto

private

Definition at line 129 of file CLocalCurveGeometricEstimator.h.

Referenced by DGtal::CLocalGeometricEstimator< T >::BOOST_CONCEPT_USAGE().

template<typename T >

Quantity DGtal::CLocalGeometricEstimator< T >::myQ

private

Definition at line 126 of file CLocalCurveGeometricEstimator.h.

Referenced by DGtal::CLocalGeometricEstimator< T >::BOOST_CONCEPT_USAGE().

template<typename T >

T DGtal::CLocalGeometricEstimator< T >::myX

private

Reimplemented in DGtal::CSegmentComputerEstimator< T >.

Definition at line 122 of file CLocalCurveGeometricEstimator.h.

Referenced by DGtal::CLocalGeometricEstimator< T >::BOOST_CONCEPT_USAGE().

---

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

• CLocalCurveGeometricEstimator.h