DGtal  0.6.devel
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Private Attributes
DGtal::SimpleThresholdForegroundPredicate< Image > Class Template Reference

#include <SimpleThresholdForegroundPredicate.h>

Collaboration diagram for DGtal::SimpleThresholdForegroundPredicate< Image >:
Collaboration graph
[legend]

Public Types

typedef Image::Value Value
typedef Image::Point Point

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CImage< Image >))
 SimpleThresholdForegroundPredicate (const Image &aImage, const Value value)
bool operator() (const typename Image::Point &aPoint) const
bool operator() (const typename Image::Iterator &it) const
bool operator() (const typename Image::ConstIterator &it) const
bool operator() (const typename Image::SpanIterator &it) const

Protected Member Functions

 SimpleThresholdForegroundPredicate ()

Private Attributes

CountedPtr< ImagemyImage
Value myVal

Detailed Description

template<typename Image>
class DGtal::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'

Template Parameters:
TImagean model of CImageContainer concept.

Definition at line 62 of file SimpleThresholdForegroundPredicate.h.


Member Typedef Documentation

template<typename Image >
typedef Image::Point DGtal::SimpleThresholdForegroundPredicate< Image >::Point

Definition at line 68 of file SimpleThresholdForegroundPredicate.h.

template<typename Image >
typedef Image::Value DGtal::SimpleThresholdForegroundPredicate< Image >::Value

Definition at line 67 of file SimpleThresholdForegroundPredicate.h.


Constructor & Destructor Documentation

template<typename Image >
DGtal::SimpleThresholdForegroundPredicate< Image >::SimpleThresholdForegroundPredicate ( const Image aImage,
const Value  value 
)
inline

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

Parameters:
valuethe threshold value.

Definition at line 76 of file SimpleThresholdForegroundPredicate.h.

:
myImage(new Image(aImage)), myVal(value) {};
template<typename Image >
DGtal::SimpleThresholdForegroundPredicate< Image >::SimpleThresholdForegroundPredicate ( )
protected

Member Function Documentation

template<typename Image >
DGtal::SimpleThresholdForegroundPredicate< Image >::BOOST_CONCEPT_ASSERT ( (CImage< Image >)  )
template<typename Image >
bool DGtal::SimpleThresholdForegroundPredicate< Image >::operator() ( const typename Image::Point aPoint) const
inline
Returns:
True if the point belongs to the value interval.

Definition at line 83 of file SimpleThresholdForegroundPredicate.h.

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

{
return ((*myImage)(aPoint) > myVal);
}
template<typename Image >
bool DGtal::SimpleThresholdForegroundPredicate< Image >::operator() ( const typename Image::Iterator it) const
inline
Returns:
True if the point belongs to the value interval.

Definition at line 91 of file SimpleThresholdForegroundPredicate.h.

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

{
return ((*myImage)(it) > myVal);
}
template<typename Image >
bool DGtal::SimpleThresholdForegroundPredicate< Image >::operator() ( const typename Image::ConstIterator it) const
inline
Returns:
True if the point belongs to the value interval.

Definition at line 99 of file SimpleThresholdForegroundPredicate.h.

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

{
return ((*myImage)(it) > myVal);
}
template<typename Image >
bool DGtal::SimpleThresholdForegroundPredicate< Image >::operator() ( const typename Image::SpanIterator it) const
inline
Returns:
True if the point belongs to the value interval.

Definition at line 107 of file SimpleThresholdForegroundPredicate.h.

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

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

Field Documentation

template<typename Image >
CountedPtr<Image> DGtal::SimpleThresholdForegroundPredicate< Image >::myImage
private

Definition at line 113 of file SimpleThresholdForegroundPredicate.h.

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

template<typename Image >
Value DGtal::SimpleThresholdForegroundPredicate< Image >::myVal
private

Definition at line 114 of file SimpleThresholdForegroundPredicate.h.

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


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