DGtal  1.3.beta
Public Types | Public Member Functions | Private Member Functions | Private Attributes
DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder > Struct Template Reference

#include <DGtal/geometry/surfaces/estimation/estimationFunctors/BasicEstimatorFromSurfelsFunctors.h>

Public Types

typedef TSurfel Surfel
 Surfel type. More...
 
typedef TSCellEmbedder SCellEmbedder
 Embedder type. More...
 
typedef int Quantity
 Type of output values. More...
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CSCellEmbedder< SCellEmbedder >))
 
 DummyEstimatorFromSurfels (ConstAlias< SCellEmbedder > anEmbedder, const double h)
 
 ~DummyEstimatorFromSurfels ()
 
void pushSurfel (const Surfel &aSurfel, const double aDistance)
 
Quantity eval () const
 
void reset ()
 

Private Member Functions

 DummyEstimatorFromSurfels ()
 

Private Attributes

const SCellEmbeddermyEmbedder
 ConstAlias of the Embedder. More...
 
Quantity myCpt
 Surfel counter. More...
 
double myH
 Grid step. More...
 

Detailed Description

template<typename TSurfel, typename TSCellEmbedder>
struct DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >

Definition at line 54 of file BasicEstimatorFromSurfelsFunctors.h.

Member Typedef Documentation

◆ Quantity

template<typename TSurfel , typename TSCellEmbedder >
typedef int DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::Quantity

Type of output values.

Definition at line 67 of file BasicEstimatorFromSurfelsFunctors.h.

◆ SCellEmbedder

template<typename TSurfel , typename TSCellEmbedder >
typedef TSCellEmbedder DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::SCellEmbedder

Embedder type.

Definition at line 62 of file BasicEstimatorFromSurfelsFunctors.h.

◆ Surfel

template<typename TSurfel , typename TSCellEmbedder >
typedef TSurfel DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::Surfel

Surfel type.

Definition at line 59 of file BasicEstimatorFromSurfelsFunctors.h.

Constructor & Destructor Documentation

◆ DummyEstimatorFromSurfels() [1/2]

template<typename TSurfel , typename TSCellEmbedder >
DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::DummyEstimatorFromSurfels ( ConstAlias< SCellEmbedder anEmbedder,
const double  h 
)
inline

Constructor.

Parameters
[in]anEmbedderany model of CSCellEmbedder.
[in]ha grid step

Definition at line 75 of file BasicEstimatorFromSurfelsFunctors.h.

76  :
77  myEmbedder(&anEmbedder), myH(h)
78  {
79  myCpt=0;
80  }

References DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::myCpt.

◆ ~DummyEstimatorFromSurfels()

template<typename TSurfel , typename TSCellEmbedder >
DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::~DummyEstimatorFromSurfels ( )
inline

Destructor

Definition at line 85 of file BasicEstimatorFromSurfelsFunctors.h.

85 {}

◆ DummyEstimatorFromSurfels() [2/2]

template<typename TSurfel , typename TSCellEmbedder >
DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::DummyEstimatorFromSurfels ( )
private

Private default constructor.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

template<typename TSurfel , typename TSCellEmbedder >
DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::BOOST_CONCEPT_ASSERT ( (concepts::CSCellEmbedder< SCellEmbedder >)  )

◆ eval()

template<typename TSurfel , typename TSCellEmbedder >
Quantity DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::eval ( ) const
inline
Returns
the estimated quantity.

Definition at line 103 of file BasicEstimatorFromSurfelsFunctors.h.

103 {return myCpt; }

References DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::myCpt.

◆ pushSurfel()

template<typename TSurfel , typename TSCellEmbedder >
void DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::pushSurfel ( const Surfel aSurfel,
const double  aDistance 
)
inline

Push a surfel to the estimator. For this dummy estimator, we just count the number of surfels.

Definition at line 91 of file BasicEstimatorFromSurfelsFunctors.h.

93  {
94  BOOST_VERIFY(aDistance == aDistance);
95  BOOST_VERIFY(aSurfel == aSurfel);
96 
97  myCpt++;
98  }

References DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::myCpt.

◆ reset()

template<typename TSurfel , typename TSCellEmbedder >
void DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::reset ( )
inline

Field Documentation

◆ myCpt

template<typename TSurfel , typename TSCellEmbedder >
Quantity DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::myCpt
private

◆ myEmbedder

template<typename TSurfel , typename TSCellEmbedder >
const SCellEmbedder* DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::myEmbedder
private

ConstAlias of the Embedder.

Definition at line 121 of file BasicEstimatorFromSurfelsFunctors.h.

◆ myH

template<typename TSurfel , typename TSCellEmbedder >
double DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::myH
private

Grid step.

Definition at line 127 of file BasicEstimatorFromSurfelsFunctors.h.


The documentation for this struct was generated from the following file:
DGtal::functors::DummyEstimatorFromSurfels::myH
double myH
Grid step.
Definition: BasicEstimatorFromSurfelsFunctors.h:127
DGtal::NumberTraitsImpl< std::decay< T >::type >::ZERO
static const std::decay< T >::type ZERO
Constant Zero.
Definition: NumberTraits.h:100
DGtal::functors::DummyEstimatorFromSurfels::myEmbedder
const SCellEmbedder * myEmbedder
ConstAlias of the Embedder.
Definition: BasicEstimatorFromSurfelsFunctors.h:121
DGtal::functors::DummyEstimatorFromSurfels::myCpt
Quantity myCpt
Surfel counter.
Definition: BasicEstimatorFromSurfelsFunctors.h:124