DGtal  1.2.beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CDigitalSurfaceLocalEstimator< T > Struct Template Reference

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

#include <DGtal/geometry/surfaces/estimation/CDigitalSurfaceLocalEstimator.h>

Inheritance diagram for DGtal::concepts::CDigitalSurfaceLocalEstimator< T >:
[legend]

Public Types

typedef T::Surface Surface
 
typedef Surface::DigitalSurfaceContainer DigitalSurfaceContainer
 
typedef T::Surfel Surfel
 
- Public Types inherited from DGtal::concepts::CSurfelLocalEstimator< T >
typedef T::Quantity Quantity
 
typedef T::Surfel Surfel
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CDigitalSurfaceContainer< DigitalSurfaceContainer >))
 
 BOOST_STATIC_ASSERT ((ConceptUtils::SameType< Surfel, typename Surface::Surfel >::value))
 
 BOOST_CONCEPT_USAGE (CDigitalSurfaceLocalEstimator)
 
- Public Member Functions inherited from DGtal::concepts::CSurfelLocalEstimator< T >
 BOOST_CONCEPT_ASSERT ((CQuantity< Quantity >))
 
 BOOST_CONCEPT_USAGE (CSurfelLocalEstimator)
 
void check_const_constraints () const
 

Private Attributes

myX
 
Surface myS
 

Detailed Description

template<typename T>
struct DGtal::concepts::CDigitalSurfaceLocalEstimator< T >

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

Description of concept 'CDigitalSurfaceLocalEstimator'

It refines the concept CSurfelLocalEstimator by forcing the abstract surface to be some digital surface.

Refinement of

Associated types

Notation

Definitions

Valid expressions and semantics

Name Expression Return type Precondition Semantics Complexity
Attach surface x.attach( s ) void Indicates to the estimator the surface on which estimations are done. Model dependent

Invariants

Models

Notes

Template Parameters
Tthe type that should be a model of CDigitalSurfaceLocalEstimator.

Definition at line 102 of file CDigitalSurfaceLocalEstimator.h.

Member Typedef Documentation

◆ DigitalSurfaceContainer

Definition at line 110 of file CDigitalSurfaceLocalEstimator.h.

◆ Surface

template<typename T >
typedef T::Surface DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::Surface

Definition at line 109 of file CDigitalSurfaceLocalEstimator.h.

◆ Surfel

template<typename T >
typedef T::Surfel DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::Surfel

Definition at line 112 of file CDigitalSurfaceLocalEstimator.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

◆ BOOST_CONCEPT_USAGE()

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

◆ BOOST_STATIC_ASSERT()

template<typename T >
DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::BOOST_STATIC_ASSERT ( (ConceptUtils::SameType< Surfel, typename Surface::Surfel >::value)  )

Field Documentation

◆ myS

template<typename T >
Surface DGtal::concepts::CDigitalSurfaceLocalEstimator< T >::myS
private

◆ myX

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

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