DGtal::functors::Thresholder< T, isLower, isEqual > Class Template Reference

#include <DGtal/base/BasicFunctors.h>

Inheritance diagram for DGtal::functors::Thresholder< T, isLower, isEqual >:

Collaboration diagram for DGtal::functors::Thresholder< T, isLower, isEqual >:

Public Types
typedef T	Input

Public Member Functions
	BOOST_CONCEPT_ASSERT ((boost::EqualityComparable< T >))
	BOOST_CONCEPT_ASSERT ((boost::LessThanComparable< T >))
	Thresholder (const Input &aT=0)
bool	operator() (const Input &aI) const

Private Attributes
Input	myT

Detailed Description

template<typename T, bool isLower = true, bool isEqual = true>
class DGtal::functors::Thresholder< T, isLower, isEqual >

Aim: A small functor with an operator () that compares one value to a threshold value according to two bool template parameters.

// template class Thresholder

Template Parameters

T	type for a value that must be equally and less-than comparable
isLower	a bool for the comparison sign : 'true' for < (default), 'false' for <
isEqual	a bool for the equality : 'true' for a large inequality (default), 'false' for a strict one

Examples:

geometry/volumes/distance/exampleFMM3D.cpp, and images/exampleConstImageAdapter.cpp.

Definition at line 368 of file BasicFunctors.h.

Member Typedef Documentation

Input

template<typename T, bool isLower = true, bool isEqual = true>

typedef T DGtal::functors::Thresholder< T, isLower, isEqual >::Input

Definition at line 375 of file BasicFunctors.h.

Constructor & Destructor Documentation

Thresholder()

template<typename T, bool isLower = true, bool isEqual = true>

DGtal::functors::Thresholder< T, isLower, isEqual >::Thresholder ( const Input &  aT = 0 )

inline

Constructor.

Parameters

aT	the threshold value (default 0).

Definition at line 381 of file BasicFunctors.h.

:myT(aT) {}

Member Function Documentation

BOOST_CONCEPT_ASSERT() [1/2]

template<typename T, bool isLower = true, bool isEqual = true>

DGtal::functors::Thresholder< T, isLower, isEqual >::BOOST_CONCEPT_ASSERT

(

(boost::EqualityComparable< T >)

)

BOOST_CONCEPT_ASSERT() [2/2]

template<typename T, bool isLower = true, bool isEqual = true>

DGtal::functors::Thresholder< T, isLower, isEqual >::BOOST_CONCEPT_ASSERT

(

(boost::LessThanComparable< T >)

)

operator()()

template<typename T, bool isLower = true, bool isEqual = true>

bool DGtal::functors::Thresholder< T, isLower, isEqual >::operator() ( const Input &  aI ) const

inline

Compares aI to @ myT.

Parameters

aI	any input value

Returns

'true' or 'false' according to isLower and isEqual

Definition at line 387 of file BasicFunctors.h.

                                           {
      std::less_equal<Input> c;
      return c(aI,myT);
    }

Field Documentation

myT

template<typename T, bool isLower = true, bool isEqual = true>

Input DGtal::functors::Thresholder< T, isLower, isEqual >::myT

private

Threshold value

Definition at line 395 of file BasicFunctors.h.

---

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

• BasicFunctors.h