DGtal: DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType

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

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

Public Types
typedef TSegmentComputer	SegmentComputer

typedef SegmentComputer::ConstIterator	ConstIterator

typedef ReturnType	Quantity

Public Member Functions
	PosIndepScaleDepSCEstimator ()

	PosIndepScaleDepSCEstimator (const PosIndepScaleDepSCEstimator &other)

PosIndepScaleDepSCEstimator &	operator= (const PosIndepScaleDepSCEstimator &other)

	~PosIndepScaleDepSCEstimator ()

bool	isValid () const

void	init (const double h, 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
double	myH

ConstIterator	myBegin

ConstIterator	myEnd

const SegmentComputer *	mySCPtr

Functor	myFunctor

Detailed Description

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

Description of class 'PosIndepScaleDepSCEstimator'

Aim: estimates a geometric quantity from a segment computer. The estimation is not position-dependent, but is scale-dependent (e.g. curvature or radius estimation from 'circular' 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 217 of file SegmentComputerEstimators.h.

Member Typedef Documentation

◆ ConstIterator

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

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

Definition at line 224 of file SegmentComputerEstimators.h.

◆ Quantity

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

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

Definition at line 225 of file SegmentComputerEstimators.h.

◆ SegmentComputer

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

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

Definition at line 223 of file SegmentComputerEstimators.h.

Constructor & Destructor Documentation

◆ PosIndepScaleDepSCEstimator() [1/2]

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

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

inline

Default constructor. NB: not valid.

Definition at line 257 of file SegmentComputerEstimators.h.

       : myH( 0.0 ), myBegin(), myEnd(), mySCPtr(0), myFunctor()
       {
       }

◆ PosIndepScaleDepSCEstimator() [2/2]

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

DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::PosIndepScaleDepSCEstimator ( const PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType > & other )

inline

Copy constructor.

Parameters

other the object to copy.

Definition at line 265 of file SegmentComputerEstimators.h.

       : myH( other.myH ), myBegin( other.myBegin ), myEnd( other.myEnd ), 
         mySCPtr( other.mySCPtr ), myFunctor( other.myFunctor )
       {
       }

◆ ~PosIndepScaleDepSCEstimator()

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

DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::~PosIndepScaleDepSCEstimator ( )

inline

Destructor

Definition at line 289 of file SegmentComputerEstimators.h.

289 {}

Member Function Documentation

◆ attach()

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

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

inline

Attach the estimator to aSC

Parameters

aSC	an instance of segment computer.

Definition at line 323 of file SegmentComputerEstimators.h.

       {
         mySCPtr = &aSC; 
         ASSERT( mySCPtr ); 
       };

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

◆ eval() [1/2]

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

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

inline

Estimation depending on myH

Returns: the estimated quantity

Definition at line 333 of file SegmentComputerEstimators.h.

       {
               ASSERT( isValid() ); 
         return myFunctor( *mySCPtr, myH ); 
       }

References DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::isValid(), DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::myFunctor, DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::myH, and DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::mySCPtr.

◆ eval() [2/2]

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

template<typename OutputIterator >

OutputIterator DGtal::detail::PosIndepScaleDepSCEstimator< 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 349 of file SegmentComputerEstimators.h.

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

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

◆ init()

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

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

inline

Initialisation.

Parameters

h	grid size
itb	begin iterator
ite	end iterator

Definition at line 311 of file SegmentComputerEstimators.h.

       {
         myH = h; 
         myBegin = itb;
         myEnd = ite;
               ASSERT( myH > 0 );  
       }

◆ isValid()

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

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

       {
         return (myH > 0)&&(mySCPtr != 0); 
       };

References DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::myH, and DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::mySCPtr.

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

◆ operator=()

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

PosIndepScaleDepSCEstimator& DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::operator= ( const PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType > & other )

inline

Assignement.

Parameters

other the object to copy.

Definition at line 274 of file SegmentComputerEstimators.h.

       {
         if (this != &other)
         {
           myH = other.myH; 
           myBegin = other.myBegin; 
           myEnd = other.myEnd; 
           mySCPtr = other.mySCPtr; 
           myFunctor = other.myFunctor; 
         }
         return *this; 
       }

References DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::myBegin, DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::myEnd, DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::myFunctor, DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::myH, and DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::mySCPtr.

Field Documentation

◆ myBegin

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

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

Begin iterator

Definition at line 236 of file SegmentComputerEstimators.h.

Referenced by DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::init(), and DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::operator=().

◆ myEnd

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

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

End iterator

Definition at line 240 of file SegmentComputerEstimators.h.

◆ myFunctor

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

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

Functor used for the estimation

Definition at line 248 of file SegmentComputerEstimators.h.

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

◆ myH

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

double DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::myH

Grid step

Definition at line 232 of file SegmentComputerEstimators.h.

Referenced by DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::eval(), DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::init(), DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::isValid(), and DGtal::detail::PosIndepScaleDepSCEstimator< TSegmentComputer, Functor, ReturnType >::operator=().

◆ mySCPtr

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

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

Aliasing pointer on a constant segment computer

Definition at line 244 of file SegmentComputerEstimators.h.

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

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

SegmentComputerEstimators.h

Public Types

Public Member Functions

Data Fields

Detailed Description

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

Member Typedef Documentation

◆ ConstIterator

◆ Quantity

◆ SegmentComputer

Constructor & Destructor Documentation

◆ PosIndepScaleDepSCEstimator() [1/2]

◆ PosIndepScaleDepSCEstimator() [2/2]

◆ ~PosIndepScaleDepSCEstimator()

Member Function Documentation

◆ attach()

◆ eval() [1/2]

◆ eval() [2/2]

◆ init()

◆ isValid()

◆ operator=()

Field Documentation

◆ myBegin

◆ myEnd

◆ myFunctor

◆ myH

◆ mySCPtr

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