DGtal::CGlobalGeometricEstimator< T > Struct Template Reference

#include <CGlobalCurveGeometricEstimator.h>

Collaboration diagram for DGtal::CGlobalGeometricEstimator< 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 (CGlobalGeometricEstimator)

Private Attributes
T	myX
double	myH
ConstIterator	myItb
ConstIterator	myIte
Quantity	myQ

---

Detailed Description

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

Aim: This concept describes an object that can process a range so as to return one estimated quantity for the whole range.

Description of concept 'CGlobalGeometricEstimator'

Refinement of

• boost::DefaultConstructible

Associated types :

• ConstIterator
• Quantity

Notation

• X : A type that is a model of CGlobalGeometricEstimator
• 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( ) | | Quantity | | Estimation of the quantity | | model dependant |

Invariants

Models

TrueGlobalEstimatorOnPoints L1LengthEstimator TwoStepLocalLengthEstimator DSSLengthEstimator FPLengthEstimator MLPLengthEstimator

Notes

Template Parameters:

T	the type that should be a model of CGlobalGeometricEstimator.

Definition at line 95 of file CGlobalCurveGeometricEstimator.h.

---

Member Typedef Documentation

template<typename T >

typedef T::ConstIterator DGtal::CGlobalGeometricEstimator< T >::ConstIterator

Definition at line 105 of file CGlobalCurveGeometricEstimator.h.

template<typename T >

typedef T::Quantity DGtal::CGlobalGeometricEstimator< T >::Quantity

Definition at line 102 of file CGlobalCurveGeometricEstimator.h.

---

Member Function Documentation

template<typename T >

DGtal::CGlobalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT

(

(CQuantity< Quantity >)

)

template<typename T >

DGtal::CGlobalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT

(

(boost_concepts::ReadableIteratorConcept< ConstIterator >)

)

template<typename T >

DGtal::CGlobalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT

(

(boost_concepts::ForwardTraversalConcept< ConstIterator >)

)

template<typename T >

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

inline

Definition at line 110 of file CGlobalCurveGeometricEstimator.h.

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

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

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

---

Field Documentation

template<typename T >

double DGtal::CGlobalGeometricEstimator< T >::myH

private

Definition at line 122 of file CGlobalCurveGeometricEstimator.h.

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

template<typename T >

ConstIterator DGtal::CGlobalGeometricEstimator< T >::myItb

private

Definition at line 123 of file CGlobalCurveGeometricEstimator.h.

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

template<typename T >

ConstIterator DGtal::CGlobalGeometricEstimator< T >::myIte

private

Definition at line 123 of file CGlobalCurveGeometricEstimator.h.

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

template<typename T >

Quantity DGtal::CGlobalGeometricEstimator< T >::myQ

private

Definition at line 124 of file CGlobalCurveGeometricEstimator.h.

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

template<typename T >

T DGtal::CGlobalGeometricEstimator< T >::myX

private

Definition at line 120 of file CGlobalCurveGeometricEstimator.h.

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

---

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

• CGlobalCurveGeometricEstimator.h