#include <ConstImageAdapter.h>

Public Types
typedef ConstImageAdapter < TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >	Self
typedef TNewDomain	Domain
typedef TNewDomain::Point	Point
typedef TNewValue	Value
typedef TImageContainer	ImageContainer
typedef DefaultConstImageRange < Self >	ConstRange

Public Member Functions
	BOOST_CONCEPT_ASSERT ((CImage< TImageContainer >))
	BOOST_CONCEPT_ASSERT ((CDomain< TNewDomain >))
	BOOST_CONCEPT_ASSERT ((CUnaryFunctor< TFunctorD, typename TImageContainer::Point, Point >))
	BOOST_CONCEPT_ASSERT ((CUnaryFunctor< TFunctorV, typename TImageContainer::Value, Value >))
	ConstImageAdapter (ImageContainer &anImage, const Domain &aDomain, const TFunctorD &aFD, const TFunctorV &aFV)
ConstImageAdapter &	operator= (const ConstImageAdapter &other)
	~ConstImageAdapter ()
const Domain &	domain () const
ConstRange	constRange () const
Value	operator() (const Point &aPoint) const
void	selfDisplay (std::ostream &out) const
bool	isValid () const
const ImageContainer *	getPointer () const

Protected Attributes
const ImageContainer *	myImagePtr
const Domain *	mySubDomainPtr
const TFunctorD *	myFD
const TFunctorV *	myFV

Private Member Functions
	ConstImageAdapter ()

Detailed Description

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>
class DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >

Aim: implements a const image adapter with a given domain (i.e. a subdomain) and 2 functors : g for domain, f for accessing point values.

Description of template class 'ConstImageAdapter'

This class is (like Image class) a lightweight proxy on any models of CImage. It uses a given Domain (i.e. a subdomain) but work directly (for accessing process) thanks to an alias (i.e. a pointer) on the original Image given in argument.

ConstImageAdapter class is also a model of CImage.

Caution :

the type of value of Point for the ConstImageAdapter Domain must also be the same than the type of value of Point for the original ImageContainer.

Template Parameters:

TImageContainer	an image container type (model of CImage).
TNewDomain	a domain.
TFunctorD	the functor g that transforms the domain into another one
TNewValue	the type of value return by the functor f.
TFunctorV	the functor f that transforms the value into another one during reading process

The values associated to accessing the point values are adapted with a functor g and a functor f given at construction so that operator() calls f(img(g(aPoint))), instead of calling directly operator() of the underlying image img.

Here is the construction of a simple image adapter that is a thresholded view of the initial scalar image:

  DefaultFunctor g;
  Thresholder<Image::Value> t( thresholdValue );
  ConstImageAdapter<Image, Domain, DefaultFunctor, bool, Thresholder<Image::Value> > a(img, d, g, t); 

NB: the underlying image as well as the 2 functors are stored in the adapter as aliasing pointer in order to avoid copies. The pointed objects must exist and must not be deleted during the use of the adapter

Definition at line 105 of file ConstImageAdapter.h.