DGtal  0.9.3beta
Public Types | Public Member Functions | Protected Member Functions | Private Attributes
DGtal::functors::SimpleThresholdForegroundPredicate< Image > Class Template Reference

#include <DGtal/images/SimpleThresholdForegroundPredicate.h>

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

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 ImagemyImage
 
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
Imagean model of CConstImage concept.
Examples:
examples/tutorial-examples/polyhedralizer.cpp, geometry/volumes/distance/distancetransform2D.cpp, geometry/volumes/distance/distancetransform3D.cpp, geometry/volumes/distance/toricdomainvolumetric.cpp, tutorial-examples/polyhedralizer.cpp, and tutorial-examples/volDTGranulo.cpp.

Definition at line 65 of file SimpleThresholdForegroundPredicate.h.

Member Typedef Documentation

Definition at line 71 of file SimpleThresholdForegroundPredicate.h.

Definition at line 70 of file SimpleThresholdForegroundPredicate.h.

Constructor & Destructor Documentation

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
aImagethe image.
valuethe threshold value.

Definition at line 80 of file SimpleThresholdForegroundPredicate.h.

Member Function Documentation

template<typename Image >
DGtal::functors::SimpleThresholdForegroundPredicate< Image >::BOOST_CONCEPT_ASSERT ( (concepts::CConstImage< Image >)  )
template<typename Image >
bool DGtal::functors::SimpleThresholdForegroundPredicate< Image >::operator() ( const typename Image::Point aPoint) const
inline
template<typename Image >
bool DGtal::functors::SimpleThresholdForegroundPredicate< Image >::operator() ( const typename Image::Domain::ConstIterator it) const
inline
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.

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

Field Documentation

template<typename Image >
const Image* DGtal::functors::SimpleThresholdForegroundPredicate< Image >::myImage
private
template<typename Image >
Value DGtal::functors::SimpleThresholdForegroundPredicate< Image >::myVal
private

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