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

#include <BasicFunctors.h>

Collaboration diagram for DGtal::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::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

Definition at line 283 of file BasicFunctors.h.

---

Member Typedef Documentation

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

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

Definition at line 288 of file BasicFunctors.h.

---

Constructor & Destructor Documentation

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

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

inline

Constructor.

Parameters:

value

the threshold value (default 0).

Definition at line 294 of file BasicFunctors.h.

:myT(aT) {};

---

Member Function Documentation

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

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

(

(boost::EqualityComparable< T >)

)

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

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

(

(boost::LessThanComparable< T >)

)

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

bool DGtal::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 300 of file BasicFunctors.h.

References DGtal::Thresholder< T, isLower, isEqual >::myT.

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

---

Field Documentation

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

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

private

Threshold value

Definition at line 308 of file BasicFunctors.h.

Referenced by DGtal::Thresholder< T, isLower, isEqual >::operator()(), DGtal::Thresholder< T, false, false >::operator()(), DGtal::Thresholder< T, false, true >::operator()(), DGtal::Thresholder< T, true, false >::operator()(), and DGtal::Thresholder< T, true, true >::operator()().

---

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

• BasicFunctors.h