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. More...

#include <DGtal/images/ConstImageAdapter.h>

Inheritance diagram for DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >:

[legend]

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

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CConstImage< TImageContainer >))
	Checking concepts.
	BOOST_CONCEPT_ASSERT ((concepts::CDomain< TNewDomain >))
	BOOST_CONCEPT_ASSERT ((concepts::CUnaryFunctor< TFunctorD, Point, typename TImageContainer::Point >))
	BOOST_CONCEPT_ASSERT ((concepts::CUnaryFunctor< TFunctorV, typename TImageContainer::Value, Value >))
	ConstImageAdapter (ConstAlias< ImageContainer > anImage, ConstAlias< Domain > aDomain, ConstAlias< TFunctorD > aFD, ConstAlias< TFunctorV > aFV)
	ConstImageAdapter (const ConstImageAdapter &other)=default
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
std::string	className () const
const ImageContainer *	getPointer () const
void	setDefaultValue (Value aValue)
Value	getDefaultValue () const

Protected Attributes
const ImageContainer *	myImagePtr
	Alias on the image container.
const Domain *	mySubDomainPtr
const TFunctorD *	myFD
const TFunctorV *	myFV
Value	defaultValue

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 CConstImage. 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 CConstImage.

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 CConstImage).
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 ConstImageAdapter that is a thresholded view of the initial scalar image:

typedef ConstImageAdapter<Image, Domain, functors::Identity, bool, DGtal::functors::Thresholder<Image::Value> > ConstImageAdapterForThresholderImage;

DGtal::functors::Thresholder<Image::Value> t(127);

ConstImageAdapterForThresholderImage thresholderImage(image, domain, df, 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

Examples: geometry/volumes/distance/exampleFMM3D.cpp, images/exampleConstImageAdapter.cpp, images/exampleRigidtransformation2d.cpp, images/exampleRigidtransformation3d.cpp, images/extract2DImagesFrom3D.cpp, images/extract2DSlicesImagesFrom3D.cpp, images/imageBasicSubsampling.cpp, io/viewers/viewer3D-8-2DSliceImages.cpp, and tutorial-examples/2DSliceImageFromVol.cpp.

Definition at line 105 of file ConstImageAdapter.h.

Member Typedef Documentation

◆ ConstRange

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

typedef DefaultConstImageRange<Self> DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::ConstRange

Definition at line 128 of file ConstImageAdapter.h.

◆ Domain

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

typedef TNewDomain DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::Domain

Definition at line 117 of file ConstImageAdapter.h.

◆ ImageContainer

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

typedef TImageContainer DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::ImageContainer

Types copied from the container.

Definition at line 126 of file ConstImageAdapter.h.

◆ Point

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

typedef TNewDomain::Point DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::Point

Definition at line 118 of file ConstImageAdapter.h.

◆ Self

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

typedef ConstImageAdapter<TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV> DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::Self

Definition at line 111 of file ConstImageAdapter.h.

◆ Value

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

typedef TNewValue DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::Value

Definition at line 119 of file ConstImageAdapter.h.

Constructor & Destructor Documentation

◆ ConstImageAdapter() [1/3]

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::ConstImageAdapter	(	ConstAlias< ImageContainer >	anImage,
		ConstAlias< Domain >	aDomain,
		ConstAlias< TFunctorD >	aFD,
		ConstAlias< TFunctorV >	aFV )

inline

Definition at line 134 of file ConstImageAdapter.h.

        :
            myImagePtr(&anImage), mySubDomainPtr(&aDomain), myFD(&aFD), myFV(&aFV)
    {
      defaultValue = 0;
#ifdef DEBUG_VERBOSE
        trace.warning() << "ConstImageAdapter Ctor fromRef " << std::endl;
#endif
    }

◆ ConstImageAdapter() [2/3]

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::ConstImageAdapter ( const ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV > & other )

default

Default copy constructor.

Parameters

other the object to copy.

◆ ~ConstImageAdapter()

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::~ConstImageAdapter ( )

inline

Destructor. Does nothing

Definition at line 180 of file ConstImageAdapter.h.

180{}

◆ ConstImageAdapter() [3/3]

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::ConstImageAdapter ( )

inlineprivate

Default constructor.

Definition at line 285 of file ConstImageAdapter.h.

                        {
#ifdef DEBUG_VERBOSE
        trace.warning() << "ConstImageAdapter Ctor default " << std::endl;
#endif
    }

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/4]

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::BOOST_CONCEPT_ASSERT ( (concepts::CConstImage< TImageContainer >) )

Checking concepts.

◆ BOOST_CONCEPT_ASSERT() [2/4]

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::BOOST_CONCEPT_ASSERT ( (concepts::CDomain< TNewDomain >) )

◆ BOOST_CONCEPT_ASSERT() [3/4]

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::BOOST_CONCEPT_ASSERT ( (concepts::CUnaryFunctor< TFunctorD, Point, typename TImageContainer::Point >) )

◆ BOOST_CONCEPT_ASSERT() [4/4]

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::BOOST_CONCEPT_ASSERT ( (concepts::CUnaryFunctor< TFunctorV, typename TImageContainer::Value, Value >) )

◆ className()

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

std::string DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::className ( ) const

Returns: the style name used for drawing this object.

◆ constRange()

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

ConstRange DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::constRange ( ) const

inline

Returns the range of the underlying image to iterate over its values

Returns: a range.

Definition at line 203 of file ConstImageAdapter.h.

204 {

205 return ConstRange( *this );

206 }

DGtal::ConstImageAdapter::ConstRange

DefaultConstImageRange< Self > ConstRange

Definition ConstImageAdapter.h:128

◆ domain()

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

const Domain & DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::domain ( ) const

inline

Returns a reference to the underlying image domain.

Returns: a reference to the domain.

Definition at line 192 of file ConstImageAdapter.h.

193 {

194 return (*mySubDomainPtr);

195 }

Referenced by DGtal::ConstImageAdapter< Image, Domain, BackwardTrans, Image::Value, Identity >::operator()().

◆ getDefaultValue()

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

Value DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::getDefaultValue ( ) const

inline

Definition at line 275 of file ConstImageAdapter.h.

276 {

277 return defaultValue;

278 }

◆ getPointer()

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

const ImageContainer * DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::getPointer ( ) const

inline

Returns the pointer on the Image container data.

Returns: a const ImagePtr.

Definition at line 260 of file ConstImageAdapter.h.

261 {

262 return myImagePtr;

263 }

◆ isValid()

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

bool DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::isValid ( ) const

inline

Checks the validity/consistency of the object.

Returns: 'true' if the object is valid, 'false' otherwise.

Definition at line 244 of file ConstImageAdapter.h.

245 {

246 return (myImagePtr->isValid() );

247 }

◆ operator()()

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

Value DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::operator() ( const Point & aPoint ) const

inline

Get the value of an image at a given position given by a Point.

Precondition: the point must be in the domain

Parameters

aPoint the point.

Returns: the value at aPoint.

Definition at line 220 of file ConstImageAdapter.h.

    {
        ASSERT(this->domain().isInside(aPoint));
        
        typename TImageContainer::Point point = myFD->operator()(aPoint);
        if (myImagePtr->domain().isInside(point))
          return myFV->operator()(myImagePtr->operator()(point));
        else
          return defaultValue;
    }

◆ operator=()

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

ConstImageAdapter & DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::operator= ( const ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV > & other )

inline

Assignment.

Parameters

other the object to copy.

Returns: a reference on 'this'.

Definition at line 159 of file ConstImageAdapter.h.

    {
#ifdef DEBUG_VERBOSE
        trace.warning() << "ConstImageAdapter assignment " << std::endl;
#endif
        if (&other != this)
        {
            myImagePtr = other.myImagePtr;
            mySubDomainPtr = other.mySubDomainPtr;
            myFD = other.myFD;
            myFV = other.myFV;
            defaultValue = other.defaultValue;
        }
        return *this;
    }

◆ selfDisplay()

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

void DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::selfDisplay ( std::ostream & out ) const

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

◆ setDefaultValue()

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

void DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::setDefaultValue ( Value aValue )

inline

Allows to define a default value returned when point transformed by domain functor does not belongs to image domain.

Definition at line 270 of file ConstImageAdapter.h.

271 {

272 defaultValue = aValue;

273 }

Field Documentation

◆ defaultValue

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

Value DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::defaultValue

protected

Default value returned when point transformed by image functor does not belongs to image. Initial value is 0.

Definition at line 316 of file ConstImageAdapter.h.

Referenced by DGtal::ConstImageAdapter< Image, Domain, BackwardTrans, Image::Value, Identity >::operator=().

◆ myFD

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

const TFunctorD* DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::myFD

protected

Aliasing pointer on the underlying Domain functor

Definition at line 305 of file ConstImageAdapter.h.

Referenced by DGtal::ConstImageAdapter< Image, Domain, BackwardTrans, Image::Value, Identity >::operator=().

◆ myFV

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

const TFunctorV* DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::myFV

protected

Aliasing pointer on the underlying Value functor

Definition at line 310 of file ConstImageAdapter.h.

Referenced by DGtal::ConstImageAdapter< Image, Domain, BackwardTrans, Image::Value, Identity >::operator=().

◆ myImagePtr

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

const ImageContainer* DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::myImagePtr

protected

Alias on the image container.

Definition at line 295 of file ConstImageAdapter.h.

Referenced by DGtal::ConstImageAdapter< Image, Domain, BackwardTrans, Image::Value, Identity >::operator=().

◆ mySubDomainPtr

template<typename TImageContainer, typename TNewDomain, typename TFunctorD, typename TNewValue, typename TFunctorV>

const Domain* DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::mySubDomainPtr

protected

The image SubDomain

Definition at line 300 of file ConstImageAdapter.h.

Referenced by DGtal::ConstImageAdapter< Image, Domain, BackwardTrans, Image::Value, Identity >::operator=().

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

ConstImageAdapter.h

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstRange

◆ Domain

◆ ImageContainer

◆ Point

◆ Self

◆ Value

Constructor & Destructor Documentation

◆ ConstImageAdapter() [1/3]

◆ ConstImageAdapter() [2/3]

◆ ~ConstImageAdapter()

◆ ConstImageAdapter() [3/3]

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/4]

◆ BOOST_CONCEPT_ASSERT() [2/4]

◆ BOOST_CONCEPT_ASSERT() [3/4]

◆ BOOST_CONCEPT_ASSERT() [4/4]

◆ className()

◆ constRange()

◆ domain()

◆ getDefaultValue()

◆ getPointer()

◆ isValid()

◆ operator()()

◆ operator=()

◆ selfDisplay()

◆ setDefaultValue()

Field Documentation

◆ defaultValue

◆ myFD

◆ myFV

◆ myImagePtr

◆ mySubDomainPtr