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 SCellEmbedder *	myEmbedder
	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]	anEmbedder	any model of CSCellEmbedder.
[in]	h	a grid step

Definition at line 75 of file BasicEstimatorFromSurfelsFunctors.h.

                                             :
      myEmbedder(&anEmbedder), myH(h)
    {
      myCpt=0;
    }

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.

{}

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.

{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.

    {
      BOOST_VERIFY(aDistance == aDistance);
      BOOST_VERIFY(aSurfel == aSurfel);
 
      myCpt++;
    }

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

reset()

template<typename TSurfel , typename TSCellEmbedder >

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

inline

Reset the estimator.

Definition at line 108 of file BasicEstimatorFromSurfelsFunctors.h.

    {
      myCpt = NumberTraits<Quantity>::ZERO;
    }

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

Field Documentation

myCpt

template<typename TSurfel , typename TSCellEmbedder >

Quantity DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::myCpt

private

Surfel counter.

Definition at line 124 of file BasicEstimatorFromSurfelsFunctors.h.

Referenced by DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::DummyEstimatorFromSurfels(), DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::eval(), DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::pushSurfel(), and DGtal::functors::DummyEstimatorFromSurfels< TSurfel, TSCellEmbedder >::reset().

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:

• BasicEstimatorFromSurfelsFunctors.h