DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor > Class Template Reference

#include <BinomialConvolver.h>

Collaboration diagram for DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >:

Public Types
typedef TBinomialConvolver	BinomialConvolver
typedef TBinomialConvolverFunctor	BinomialConvolverFunctor
typedef BinomialConvolver::ConstIteratorOnPoints	ConstIteratorOnPoints
typedef ConstIteratorOnPoints	ConstIterator
typedef BinomialConvolverFunctor::Value	Value
typedef Value	Quantity

Public Member Functions
	BinomialConvolverEstimator (unsigned int n=0, const BinomialConvolverFunctor &f=BinomialConvolverFunctor())
void	init (const double h, const ConstIterator &itb, const ConstIterator &ite, const bool isClosed)
Quantity	eval (const ConstIterator &it)
template<typename OutputIterator >
OutputIterator	eval (const ConstIterator &itb, const ConstIterator &ite, OutputIterator result)

Private Attributes
BinomialConvolver	myBC
BinomialConvolverFunctor	myFunctor

---

Detailed Description

template<typename TBinomialConvolver, typename TBinomialConvolverFunctor>
class DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >

Aim: This class encapsulates a BinomialConvolver and a functor on BinomialConvolver so as to be a model of CLocalGeometricEstimator.

Description of template class 'BinomialConvolverEstimator'

Template Parameters:

TBinomialConvolver	any BinomialConvolver.
TRealPoint	the type for representing the tangent vector.

Definition at line 322 of file BinomialConvolver.h.

---

Member Typedef Documentation

template<typename TBinomialConvolver, typename TBinomialConvolverFunctor>

typedef TBinomialConvolver DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::BinomialConvolver

Definition at line 325 of file BinomialConvolver.h.

template<typename TBinomialConvolver, typename TBinomialConvolverFunctor>

typedef TBinomialConvolverFunctor DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::BinomialConvolverFunctor

Definition at line 326 of file BinomialConvolver.h.

template<typename TBinomialConvolver, typename TBinomialConvolverFunctor>

typedef ConstIteratorOnPoints DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::ConstIterator

Definition at line 328 of file BinomialConvolver.h.

template<typename TBinomialConvolver, typename TBinomialConvolverFunctor>

typedef BinomialConvolver::ConstIteratorOnPoints DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::ConstIteratorOnPoints

Definition at line 327 of file BinomialConvolver.h.

template<typename TBinomialConvolver, typename TBinomialConvolverFunctor>

typedef Value DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::Quantity

Definition at line 330 of file BinomialConvolver.h.

template<typename TBinomialConvolver, typename TBinomialConvolverFunctor>

typedef BinomialConvolverFunctor::Value DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::Value

Definition at line 329 of file BinomialConvolver.h.

---

Constructor & Destructor Documentation

template<typename TBinomialConvolver , typename TBinomialConvolverFunctor >

DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::BinomialConvolverEstimator ( unsigned int  n = 0, const BinomialConvolverFunctor &  f = BinomialConvolverFunctor()  )

inline

Definition at line 283 of file BinomialConvolver.ih.

  : myBC( n ), myFunctor( f )
{
}

---

Member Function Documentation

template<typename TBinomialConvolver , typename TBinomialConvolverFunctor >

DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::Quantity DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::eval ( const ConstIterator &  it )

inline

Returns:

the estimated quantity at *it

Definition at line 308 of file BinomialConvolver.ih.

{
  return myFunctor( myBC, it );
}    

template<typename TBinomialConvolver , typename TBinomialConvolverFunctor >

template<typename OutputIterator >

OutputIterator DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::eval ( const ConstIterator &  itb, const ConstIterator &  ite, OutputIterator  result  )

inline

Returns:

the estimated quantity from itb till ite (exculded)

Definition at line 318 of file BinomialConvolver.ih.

{
  for ( ConstIterator it = itb; it != ite; ++it )
    *result++ = eval( it );
  return result;
}

template<typename TBinomialConvolver , typename TBinomialConvolverFunctor >

void DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::init ( const double  h, const ConstIterator &  itb, const ConstIterator &  ite, const bool  isClosed  )

inline

Initialisation.

Parameters:

h	grid size (must be >0).
itb,begin	iterator
ite,end	iterator
isClosed	true if the input range is viewed as closed.

Definition at line 293 of file BinomialConvolver.ih.

References DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::init().

Referenced by DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::init().

{
  if ( myBC.size() == 0 )
    myBC.setSize( myBC.suggestedSize( h, itb, ite ) );
  myBC.init( h, itb, ite, isClosed );
}

---

Field Documentation

template<typename TBinomialConvolver, typename TBinomialConvolverFunctor>

BinomialConvolver DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::myBC

private

Definition at line 365 of file BinomialConvolver.h.

template<typename TBinomialConvolver, typename TBinomialConvolverFunctor>

BinomialConvolverFunctor DGtal::BinomialConvolverEstimator< TBinomialConvolver, TBinomialConvolverFunctor >::myFunctor

private

Definition at line 366 of file BinomialConvolver.h.

---

The documentation for this class was generated from the following files:

• BinomialConvolver.h
• BinomialConvolver.ih