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

Aim: Define a simple Foreground predicate thresholding image values between two constant values (the first one being excluded). More...

#include <DGtal/images/IntervalForegroundPredicate.h>

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

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

Protected Member Functions
	IntervalForegroundPredicate ()

Private Attributes
const Image *	myImage
Value	myMaxVal
Value	myMinVal

Detailed Description

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

Aim: Define a simple Foreground predicate thresholding image values between two constant values (the first one being excluded).

Description of template class 'IntervalForegroundPredicate'

This class is a model of concepts::CPointPredicate.

Template Parameters

Image

an model of CImageContainer concept.

Definition at line 64 of file IntervalForegroundPredicate.h.

Member Typedef Documentation

Point

template<typename Image >

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

Definition at line 70 of file IntervalForegroundPredicate.h.

Value

template<typename Image >

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

Definition at line 69 of file IntervalForegroundPredicate.h.

Constructor & Destructor Documentation

IntervalForegroundPredicate() [1/2]

template<typename Image >

DGtal::functors::IntervalForegroundPredicate< Image >::IntervalForegroundPredicate ( ConstAlias< Image >  aImage, const Value  minVal, const Value  maxVal  )

inline

Constructor. This functor can be used to threshold image values in the interval ]minVal,maxVal].

Parameters

aImage	the image.
minVal	the minimum value (first value excluded).
maxVal	the maximum value (last value considered).

Definition at line 80 of file IntervalForegroundPredicate.h.

                                                   : 
      myImage(&aImage), myMaxVal(maxVal), myMinVal(minVal) {};

IntervalForegroundPredicate() [2/2]

template<typename Image >

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

protected

Member Function Documentation

BOOST_CONCEPT_ASSERT()

template<typename Image >

DGtal::functors::IntervalForegroundPredicate< Image >::BOOST_CONCEPT_ASSERT

(

(concepts::CConstImage< Image >)

)

operator()() [1/2]

template<typename Image >

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

inline

Returns

True if the point belongs to the value interval.

Definition at line 96 of file IntervalForegroundPredicate.h.

    {
      return ((*it) > myMinVal) && ((*it) <= myMaxVal);
    }

References DGtal::functors::IntervalForegroundPredicate< Image >::myMaxVal, and DGtal::functors::IntervalForegroundPredicate< Image >::myMinVal.

operator()() [2/2]

template<typename Image >

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

inline

Returns

True if the point belongs to the value interval.

Definition at line 88 of file IntervalForegroundPredicate.h.

    {
      return ((*myImage)(aPoint) > myMinVal) && ((*myImage)(aPoint) <= myMaxVal);
    }

References aPoint(), DGtal::functors::IntervalForegroundPredicate< Image >::myImage, DGtal::functors::IntervalForegroundPredicate< Image >::myMaxVal, and DGtal::functors::IntervalForegroundPredicate< Image >::myMinVal.

Field Documentation

myImage

template<typename Image >

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

private

Definition at line 103 of file IntervalForegroundPredicate.h.

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

myMaxVal

template<typename Image >

Value DGtal::functors::IntervalForegroundPredicate< Image >::myMaxVal

private

Definition at line 104 of file IntervalForegroundPredicate.h.

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

myMinVal

template<typename Image >

Value DGtal::functors::IntervalForegroundPredicate< Image >::myMinVal

private

Definition at line 105 of file IntervalForegroundPredicate.h.

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

---

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

• IntervalForegroundPredicate.h