DGtal::functors::SimpleThresholdForegroundPredicate< Image > Class Template Reference

Aim: Define a simple Foreground predicate thresholding image values given a single thresold. More precisely, the functor operator() returns true if the value is greater than a given threshold. More...

#include <DGtal/images/SimpleThresholdForegroundPredicate.h>

Public Types
typedef Image::Value	Value
typedef Image::Point	Point

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CConstImage< Image >))
	SimpleThresholdForegroundPredicate (ConstAlias< Image > aImage, const Value value)
bool	operator() (const typename Image::Point &aPoint) const
bool	operator() (const typename Image::Domain::ConstIterator &it) const
bool	operator() (const typename Image::ConstRange::ConstIterator &it) const

Protected Member Functions
	SimpleThresholdForegroundPredicate ()

Private Attributes
const Image *	myImage
Value	myVal

Detailed Description

template<typename Image>
class DGtal::functors::SimpleThresholdForegroundPredicate< Image >

Aim: Define a simple Foreground predicate thresholding image values given a single thresold. More precisely, the functor operator() returns true if the value is greater than a given threshold.

Description of template class 'SimpleThresholdForegroundPredicate'

This class is a model of concepts::CPointPredicate.

Template Parameters

Image

an model of CConstImage concept.

Definition at line 65 of file SimpleThresholdForegroundPredicate.h.

Member Typedef Documentation

Point

template<typename Image >

typedef Image::Point DGtal::functors::SimpleThresholdForegroundPredicate< Image >::Point

Definition at line 71 of file SimpleThresholdForegroundPredicate.h.

Value

template<typename Image >

typedef Image::Value DGtal::functors::SimpleThresholdForegroundPredicate< Image >::Value

Definition at line 70 of file SimpleThresholdForegroundPredicate.h.

Constructor & Destructor Documentation

SimpleThresholdForegroundPredicate() [1/2]

template<typename Image >

DGtal::functors::SimpleThresholdForegroundPredicate< Image >::SimpleThresholdForegroundPredicate ( ConstAlias< Image >  aImage, const Value  value  )

inline

Constructor. This functor can be used to threshold image values greater (>) than value.

Parameters

aImage	the image.
value	the threshold value.

Definition at line 80 of file SimpleThresholdForegroundPredicate.h.

                                                         :
      myImage(&aImage), myVal(value) {};

SimpleThresholdForegroundPredicate() [2/2]

template<typename Image >

DGtal::functors::SimpleThresholdForegroundPredicate< Image >::SimpleThresholdForegroundPredicate ( )

protected

Member Function Documentation

BOOST_CONCEPT_ASSERT()

template<typename Image >

DGtal::functors::SimpleThresholdForegroundPredicate< Image >::BOOST_CONCEPT_ASSERT

(

(concepts::CConstImage< Image >)

)

operator()() [1/3]

template<typename Image >

bool DGtal::functors::SimpleThresholdForegroundPredicate< Image >::operator() ( const typename Image::ConstRange::ConstIterator &  it ) const

inline

Returns

True if the point belongs to the value interval.

Definition at line 103 of file SimpleThresholdForegroundPredicate.h.

    {
      return ((*it) > myVal);
    }

References DGtal::functors::SimpleThresholdForegroundPredicate< Image >::myVal.

operator()() [2/3]

template<typename Image >

bool DGtal::functors::SimpleThresholdForegroundPredicate< Image >::operator() ( const typename Image::Domain::ConstIterator &  it ) const

inline

Returns

True if the point belongs to the value interval.

Definition at line 95 of file SimpleThresholdForegroundPredicate.h.

    {
      return ( (*myImage)(*it) > myVal);
    }

References DGtal::functors::SimpleThresholdForegroundPredicate< Image >::myImage, and DGtal::functors::SimpleThresholdForegroundPredicate< Image >::myVal.

operator()() [3/3]

template<typename Image >

bool DGtal::functors::SimpleThresholdForegroundPredicate< Image >::operator() ( const typename Image::Point &  aPoint ) const

inline

Returns

True if the point belongs to the value interval.

Definition at line 87 of file SimpleThresholdForegroundPredicate.h.

    {
      return ((*myImage)(aPoint) > myVal);
    }

References aPoint(), DGtal::functors::SimpleThresholdForegroundPredicate< Image >::myImage, and DGtal::functors::SimpleThresholdForegroundPredicate< Image >::myVal.

Field Documentation

myImage

template<typename Image >

const Image* DGtal::functors::SimpleThresholdForegroundPredicate< Image >::myImage

private

Definition at line 110 of file SimpleThresholdForegroundPredicate.h.

Referenced by DGtal::functors::SimpleThresholdForegroundPredicate< Image >::operator()().

myVal

template<typename Image >

Value DGtal::functors::SimpleThresholdForegroundPredicate< Image >::myVal

private

Definition at line 111 of file SimpleThresholdForegroundPredicate.h.

Referenced by DGtal::functors::SimpleThresholdForegroundPredicate< Image >::operator()().

---

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

• SimpleThresholdForegroundPredicate.h