DGtal  1.5.beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CGlobalGeometricEstimator< T > Struct Template Reference
DGtal Concepts

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

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

Public Types

typedef T::Quantity Quantity
 
typedef T::ConstIterator ConstIterator
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::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::concepts::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

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
Tthe type that should be a model of CGlobalGeometricEstimator.

Definition at line 96 of file CGlobalCurveGeometricEstimator.h.

Member Typedef Documentation

◆ ConstIterator

template<typename T >
typedef T::ConstIterator DGtal::concepts::CGlobalGeometricEstimator< T >::ConstIterator

Definition at line 105 of file CGlobalCurveGeometricEstimator.h.

◆ Quantity

template<typename T >
typedef T::Quantity DGtal::concepts::CGlobalGeometricEstimator< T >::Quantity

Definition at line 102 of file CGlobalCurveGeometricEstimator.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/3]

template<typename T >
DGtal::concepts::CGlobalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT ( (boost_concepts::ForwardTraversalConcept< ConstIterator >)  )

◆ BOOST_CONCEPT_ASSERT() [2/3]

template<typename T >
DGtal::concepts::CGlobalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT ( (boost_concepts::ReadableIteratorConcept< ConstIterator >)  )

◆ BOOST_CONCEPT_ASSERT() [3/3]

template<typename T >
DGtal::concepts::CGlobalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT ( (concepts::CQuantity< Quantity >)  )

◆ BOOST_CONCEPT_USAGE()

template<typename T >
DGtal::concepts::CGlobalGeometricEstimator< T >::BOOST_CONCEPT_USAGE ( CGlobalGeometricEstimator< T >  )
inline

Definition at line 110 of file CGlobalCurveGeometricEstimator.h.

111  {
112  ConceptUtils::sameType( myQ, myX.eval( ) );
113  }
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117

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

Field Documentation

◆ myH

template<typename T >
double DGtal::concepts::CGlobalGeometricEstimator< T >::myH
private

Definition at line 119 of file CGlobalCurveGeometricEstimator.h.

◆ myItb

template<typename T >
ConstIterator DGtal::concepts::CGlobalGeometricEstimator< T >::myItb
private

Definition at line 120 of file CGlobalCurveGeometricEstimator.h.

◆ myIte

template<typename T >
ConstIterator DGtal::concepts::CGlobalGeometricEstimator< T >::myIte
private

Definition at line 120 of file CGlobalCurveGeometricEstimator.h.

◆ myQ

template<typename T >
Quantity DGtal::concepts::CGlobalGeometricEstimator< T >::myQ
private

Definition at line 121 of file CGlobalCurveGeometricEstimator.h.

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

◆ myX

template<typename T >
T DGtal::concepts::CGlobalGeometricEstimator< T >::myX
private

Definition at line 117 of file CGlobalCurveGeometricEstimator.h.

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

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