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). More...

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

Inheritance diagram for DGtal::concepts::CCurveLocalGeometricEstimator< T >:

[legend]

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 (CCurveLocalGeometricEstimator)

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::concepts::CCurveLocalGeometricEstimator< 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 'CCurveLocalGeometricEstimator'

Refinement of

boost::DefaultConstructible

Associated types

ConstIterator
Quantity

Notation

X : A type that is a model of CCurveLocalGeometricEstimator
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, BinomialConvolverEstimator
concept refined by CSegmentComputerEstimator, LambdaMST2D, LambdaMST3D

Notes

Template Parameters

T	the type that should be a model of CCurveLocalGeometricEstimator.

Definition at line 98 of file CCurveLocalGeometricEstimator.h.

Member Typedef Documentation

◆ ConstIterator

template<typename T >

typedef T::ConstIterator DGtal::concepts::CCurveLocalGeometricEstimator< T >::ConstIterator

Definition at line 107 of file CCurveLocalGeometricEstimator.h.

◆ Quantity

template<typename T >

typedef T::Quantity DGtal::concepts::CCurveLocalGeometricEstimator< T >::Quantity

Definition at line 104 of file CCurveLocalGeometricEstimator.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/3]

template<typename T >

DGtal::concepts::CCurveLocalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT ( (boost_concepts::ForwardTraversalConcept< ConstIterator >) )

◆ BOOST_CONCEPT_ASSERT() [2/3]

template<typename T >

DGtal::concepts::CCurveLocalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT ( (boost_concepts::ReadableIteratorConcept< ConstIterator >) )

◆ BOOST_CONCEPT_ASSERT() [3/3]

template<typename T >

DGtal::concepts::CCurveLocalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT ( (concepts::CQuantity< Quantity >) )

◆ BOOST_CONCEPT_USAGE()

template<typename T >

DGtal::concepts::CCurveLocalGeometricEstimator< T >::BOOST_CONCEPT_USAGE ( CCurveLocalGeometricEstimator< T > )

inline

Definition at line 112 of file CCurveLocalGeometricEstimator.h.

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

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

Field Documentation

◆ myH

template<typename T >

double DGtal::concepts::CCurveLocalGeometricEstimator< T >::myH

private

Definition at line 122 of file CCurveLocalGeometricEstimator.h.

◆ myItb

template<typename T >

ConstIterator DGtal::concepts::CCurveLocalGeometricEstimator< T >::myItb

private

Definition at line 123 of file CCurveLocalGeometricEstimator.h.

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

◆ myIte

template<typename T >

ConstIterator DGtal::concepts::CCurveLocalGeometricEstimator< T >::myIte

private

Definition at line 123 of file CCurveLocalGeometricEstimator.h.

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

◆ myIto

template<typename T >

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

private

Definition at line 127 of file CCurveLocalGeometricEstimator.h.

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