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

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

Public Types
typedef TSegmentComputer	SegmentComputer

typedef SegmentComputer::ConstIterator	ConstIterator

typedef ReturnType	Quantity

Public Member Functions
bool	isValid () const

	PosDepScaleIndepSCEstimator ()

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

void	attach (const SegmentComputer &aSC)

Quantity	eval (const ConstIterator &it) 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::PosDepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >

Description of class 'PosDepScaleIndepSCEstimator'

Aim: estimates a geometric quantity from a segment computer. The estimation is not scale dependent but position dependent (e.g. tangent or normal estimation from high-order primitives).

Template Parameters

TSegmentComputer a model of segment computer.

The computation is delegated to a functor.

Template Parameters

Functor a binary functor

This class is a model of CSegmentComputerEstimator

Definition at line 389 of file SegmentComputerEstimators.h.

Member Typedef Documentation

◆ ConstIterator

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

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

Definition at line 396 of file SegmentComputerEstimators.h.

◆ Quantity

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

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

Definition at line 397 of file SegmentComputerEstimators.h.

◆ SegmentComputer

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

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

Definition at line 395 of file SegmentComputerEstimators.h.

Constructor & Destructor Documentation

◆ PosDepScaleIndepSCEstimator()

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

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

inline

Default constructor

Definition at line 436 of file SegmentComputerEstimators.h.

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

DGtal::detail::PosDepScaleIndepSCEstimator::myBegin

ConstIterator myBegin

Definition SegmentComputerEstimators.h:404

DGtal::detail::PosDepScaleIndepSCEstimator::myEnd

ConstIterator myEnd

Definition SegmentComputerEstimators.h:408

DGtal::detail::PosDepScaleIndepSCEstimator::mySCPtr

const SegmentComputer * mySCPtr

Definition SegmentComputerEstimators.h:412

DGtal::detail::PosDepScaleIndepSCEstimator::myFunctor

Functor myFunctor

Definition SegmentComputerEstimators.h:416

Member Function Documentation

◆ attach()

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

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

inline

Attach the estimator to aSC

Parameters

aSC	an instance of segment computer.

Definition at line 453 of file SegmentComputerEstimators.h.

      {
              mySCPtr = &aSC; 
      };

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

◆ eval() [1/2]

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

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

inline

Unique estimation

Parameters

it	any iterator

Returns: the estimated quantity

Definition at line 463 of file SegmentComputerEstimators.h.

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

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

◆ eval() [2/2]

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

template<typename OutputIterator >

OutputIterator DGtal::detail::PosDepScaleIndepSCEstimator< 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
ite	subrange end iterator
result	output iterator on the estimated quantity

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

Definition at line 479 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( it, *mySCPtr ); 
            ++it; 
          } while (it != ite);
        }
 
        return result; 
      }

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

◆ init()

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

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

inline

Initialisation.

Parameters

itb	begin iterator
ite	end iterator

Definition at line 443 of file SegmentComputerEstimators.h.

      {
        myBegin = itb;
        myEnd = ite; 
      }

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

◆ isValid()

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

bool DGtal::detail::PosDepScaleIndepSCEstimator< 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 425 of file SegmentComputerEstimators.h.

      {
              return (mySCPtr != 0); 
      };

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

Field Documentation

◆ myBegin

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

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

Begin iterator

Definition at line 404 of file SegmentComputerEstimators.h.

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

◆ myEnd

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

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

End iterator

Definition at line 408 of file SegmentComputerEstimators.h.

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

◆ myFunctor

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

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

Functor used for the estimation

Definition at line 416 of file SegmentComputerEstimators.h.

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

◆ mySCPtr

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

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

Aliasing pointer on a constant segment computer

Definition at line 412 of file SegmentComputerEstimators.h.

Referenced by DGtal::detail::PosDepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::attach(), DGtal::detail::PosDepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::eval(), DGtal::detail::PosDepScaleIndepSCEstimator< TSegmentComputer, Functor, ReturnType >::eval(), and DGtal::detail::PosDepScaleIndepSCEstimator< 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

◆ PosDepScaleIndepSCEstimator()

Member Function Documentation

◆ attach()

◆ eval() [1/2]

◆ eval() [2/2]

◆ init()

◆ isValid()

Field Documentation

◆ myBegin

◆ myEnd

◆ myFunctor

◆ mySCPtr