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

Inheritance diagram for DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >:

Public Types
typedef TSegmentComputer	SegmentComputer

typedef SegmentComputer::ConstIterator	ConstIterator

typedef ReturnType	Quantity

Public Member Functions
bool	isValid () const

	PosIndepScaleIndepSCEstimator ()

void	init (const double, const ConstIterator &itb, const ConstIterator &ite)

void	attach (const SegmentComputer &aSC)

Quantity	eval (const ConstIterator &) const

template<typename OutputIterator >
OutputIterator	eval (const ConstIterator &itb, const ConstIterator &ite, OutputIterator result) const

Data Fields
ConstIterator	myBegin

ConstIterator	myEnd

const SegmentComputer *	mySCPtr

Functor	myFunctor

Detailed Description

template<typename TSegmentComputer, typename Functor, typename ReturnType = typename Functor::Value>
class DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >

Description of class 'PosIndepScaleIndepSCEstimator'

Aim: estimates a geometric quantity from a segment computer. The estimation is neither position-dependent nor scale-dependent (e.g. tangent or normal estimation from 'straight' primitives).

Template Parameters

TSegmentComputer a model of segment computer.

The computation is delegated to a functor.

Template Parameters

Functor a unary functor

This class is a model of CSegmentComputerEstimator

Definition at line 85 of file SegmentComputerEstimators.h.

Member Typedef Documentation

◆ ConstIterator

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

typedef SegmentComputer::ConstIterator DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::ConstIterator

Definition at line 92 of file SegmentComputerEstimators.h.

◆ Quantity

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

typedef ReturnType DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::Quantity

Definition at line 93 of file SegmentComputerEstimators.h.

◆ SegmentComputer

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

typedef TSegmentComputer DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::SegmentComputer

Definition at line 91 of file SegmentComputerEstimators.h.

Constructor & Destructor Documentation

◆ PosIndepScaleIndepSCEstimator()

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::PosIndepScaleIndepSCEstimator ( )

inline

Default constructor

Definition at line 132 of file SegmentComputerEstimators.h.

132: myBegin(), myEnd(), mySCPtr(0), myFunctor() {}

DGtal::detail::PosIndepScaleIndepSCEstimator::myFunctor

Functor myFunctor

Definition SegmentComputerEstimators.h:112

DGtal::detail::PosIndepScaleIndepSCEstimator::myBegin

ConstIterator myBegin

Definition SegmentComputerEstimators.h:100

DGtal::detail::PosIndepScaleIndepSCEstimator::mySCPtr

const SegmentComputer * mySCPtr

Definition SegmentComputerEstimators.h:108

DGtal::detail::PosIndepScaleIndepSCEstimator::myEnd

ConstIterator myEnd

Definition SegmentComputerEstimators.h:104

Member Function Documentation

◆ attach()

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

void DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::attach ( const SegmentComputer & aSC )

inline

Attach the estimator to aSC

Parameters

aSC	an instance of segment computer.

Definition at line 150 of file SegmentComputerEstimators.h.

      {
              mySCPtr = &aSC; 
      };

References DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::mySCPtr.

◆ eval() [1/2]

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

Quantity DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::eval ( const ConstIterator & ) const

inline

Unique estimation

Returns: the estimated quantity

Definition at line 159 of file SegmentComputerEstimators.h.

      {
              ASSERT( mySCPtr ); 
        return myFunctor( *mySCPtr ); 
      }

References DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::myFunctor, and DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::mySCPtr.

◆ eval() [2/2]

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

template<typename OutputIterator >

OutputIterator DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::eval	(	const ConstIterator &	itb,
		const ConstIterator &	ite,
		OutputIterator	result ) const

inline

Estimation for a subrange [itb , ite )

Parameters

itb	subrange begin iterator (unused)
ite	subrange end iterator (unused)
result	output iterator on the estimated quantity

Returns: the estimated quantity from itb till ite (excluded)

Definition at line 175 of file SegmentComputerEstimators.h.

      {
        ASSERT( mySCPtr ); 
 
        // do-while loop to deal with the case of a whole circular range
        if (isNotEmpty(itb, ite))
        {
          ConstIterator it = itb; 
          do
          {
            *result++ = myFunctor( *mySCPtr ); 
            ++it; 
          } while (it != ite);
              }
 
        return result; 
      }

References DGtal::detail::isNotEmpty(), DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::myFunctor, and DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::mySCPtr.

◆ init()

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

void DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::init	(	const double	,
		const ConstIterator &	itb,
		const ConstIterator &	ite )

inline

Initialisation. (h grid size unused)

Parameters

itb	begin iterator
ite	end iterator

Definition at line 140 of file SegmentComputerEstimators.h.

      {
        myBegin = itb;
        myEnd = ite; 
      }

References DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::myBegin, and DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::myEnd.

◆ isValid()

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

bool DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::isValid ( ) const

inline

Checks the validity/consistency of the object.

Returns: 'true' if the object is valid, 'false' otherwise.

Definition at line 121 of file SegmentComputerEstimators.h.

      {
              return (mySCPtr != 0); 
      };

References DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::mySCPtr.

Field Documentation

◆ myBegin

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

ConstIterator DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::myBegin

Begin iterator

Definition at line 100 of file SegmentComputerEstimators.h.

Referenced by DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::init().

◆ myEnd

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

ConstIterator DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::myEnd

End iterator

Definition at line 104 of file SegmentComputerEstimators.h.

Referenced by DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::init().

◆ myFunctor

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

Functor DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::myFunctor

Functor used for the estimation

Definition at line 112 of file SegmentComputerEstimators.h.

Referenced by DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::eval(), and DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::eval().

◆ mySCPtr

template<typename TSegmentComputer , typename Functor , typename ReturnType = typename Functor::Value>

const SegmentComputer* DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::mySCPtr

Aliasing pointer on a constant segment computer

Definition at line 108 of file SegmentComputerEstimators.h.

Referenced by DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::attach(), DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::eval(), DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::eval(), and DGtal::detail::PosIndepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::isValid().

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

SegmentComputerEstimators.h

Public Types

Public Member Functions

Data Fields

Detailed Description

Member Typedef Documentation

◆ ConstIterator

◆ Quantity

◆ SegmentComputer

Constructor & Destructor Documentation

◆ PosIndepScaleIndepSCEstimator()

Member Function Documentation

◆ attach()

◆ eval() [1/2]

◆ eval() [2/2]

◆ init()

◆ isValid()

Field Documentation

◆ myBegin

◆ myEnd

◆ myFunctor

◆ mySCPtr