Aim: implements a tiled image from a "bigger/original" one from an ImageFactory. More...

#include <DGtal/images/TiledImage.h>

Data Structures
class	TiledIterator

Public Types
typedef TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >	Self
typedef TImageContainer	ImageContainer
	Types copied from the container.
typedef ImageContainer::Domain	Domain
typedef ImageContainer::Point	Point
typedef ImageContainer::Value	Value
typedef ImageContainer::Difference	Difference
typedef TImageFactory	ImageFactory
	Types.
typedef ImageFactory::OutputImage	OutputImage
typedef TImageCacheReadPolicy	ImageCacheReadPolicy
typedef TImageCacheWritePolicy	ImageCacheWritePolicy
typedef ImageCache< OutputImage, ImageFactory, ImageCacheReadPolicy, ImageCacheWritePolicy >	MyImageCache
typedef TiledIterator	ConstIterator
typedef TiledIterator	OutputIterator
typedef boost::reverse_iterator< TiledIterator >	ReverseTiledIterator
typedef ReverseTiledIterator	ConstReverseIterator
typedef ReverseTiledIterator	ReverseOutputIterator
typedef TiledImageBidirectionalConstRangeFromPoint< TiledImage >	ConstRange
typedef TiledImageBidirectionalRangeFromPoint< TiledImage >	Range

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CImage< TImageContainer >))
	Checking concepts.
	BOOST_CONCEPT_ASSERT ((concepts::CImageFactory< TImageFactory >))
	BOOST_CONCEPT_ASSERT ((concepts::CImageCacheReadPolicy< TImageCacheReadPolicy >))
	BOOST_CONCEPT_ASSERT ((concepts::CImageCacheWritePolicy< TImageCacheWritePolicy >))
	TiledImage (Alias< ImageFactory > anImageFactory, Alias< ImageCacheReadPolicy > aReadPolicy, Alias< ImageCacheWritePolicy > aWritePolicy, typename Domain::Integer N)
	~TiledImage ()
	TiledImage (const TiledImage &other)
TiledImage &	operator= (const TiledImage &other)
const Domain &	domain () const
const Domain	domainBlockCoords () const
ConstIterator	begin () const
OutputIterator	begin ()
ConstIterator	begin (const Point &aPoint) const
OutputIterator	begin (const Point &aPoint)
ConstIterator	end () const
OutputIterator	end ()
ConstReverseIterator	rbegin () const
ReverseOutputIterator	rbegin ()
ConstReverseIterator	rbegin (const Point &aPoint) const
ReverseOutputIterator	rbegin (const Point &aPoint)
ConstReverseIterator	rend () const
ConstReverseIterator	rend ()
OutputIterator	outputIterator ()
OutputIterator	outputIterator (const Point &aPoint)
ReverseOutputIterator	routputIterator ()
ReverseOutputIterator	routputIterator (const Point &aPoint)
ConstRange	constRange () const
Range	range ()
void	selfDisplay (std::ostream &out) const
bool	isValid () const
const Domain	findSubDomain (const Point &aPoint) const
const Point	findBlockCoordsFromPoint (const Point &aPoint) const
const Domain	findSubDomainFromBlockCoords (const Point &aCoord) const
ImageContainer *	findTileFromBlockCoords (const Point &aCoord) const
Value	operator() (const Point &aPoint) const
void	setValue (const Point &aPoint, const Value &aValue)
unsigned int	getCacheMissRead ()
unsigned int	getCacheMissWrite ()
void	clearCacheAndResetCacheMisses ()

Protected Attributes
Domain::Integer	myN
	Number of tiles per dimension.
Point	mySize
	Width of a tile (for each dimension)
ImageFactory *	myImageFactory
	ImageFactory pointer.
MyImageCache *	myImageCache
	ImageCache pointer.
Point	m_lowerBound
	domain lower and upper bound
Point	m_upperBound
TImageCacheReadPolicy *	myReadPolicy
	TImageCacheReadPolicy pointer.
TImageCacheWritePolicy *	myWritePolicy
	TImageCacheWritePolicy pointer.

Detailed Description

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>
class DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >

Aim: implements a tiled image from a "bigger/original" one from an ImageFactory.

Description of template class 'TiledImage'

Template Parameters

TImageContainer	an image container type (model of ).
TImageFactory	an image factory type (model of CImageFactory).
TImageCacheReadPolicy	an image cache read policy class (model of CImageCacheReadPolicy).
TImageCacheWritePolicy	an image cache write policy class (model of CImageCacheWritePolicy).

Note: It is important to take into account that read and write policies are passed as aliases in the TiledImage constructor, so for example, if two TiledImage instances are successively created with the same read policy instance, the state of the cache for a given time is therefore the same for the two TiledImage instances !

Examples: images/exampleImageFactoryFromHDF5.cpp, and images/exampleTiledImage.cpp.

Definition at line 78 of file TiledImage.h.

Member Typedef Documentation

◆ ConstIterator

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef TiledIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::ConstIterator

Definition at line 451 of file TiledImage.h.

◆ ConstRange

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef TiledImageBidirectionalConstRangeFromPoint<TiledImage > DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::ConstRange

Definition at line 559 of file TiledImage.h.

◆ ConstReverseIterator

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef ReverseTiledIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::ConstReverseIterator

Definition at line 455 of file TiledImage.h.

◆ Difference

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef ImageContainer::Difference DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::Difference

Definition at line 98 of file TiledImage.h.

◆ Domain

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef ImageContainer::Domain DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::Domain

Definition at line 94 of file TiledImage.h.

◆ ImageCacheReadPolicy

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef TImageCacheReadPolicy DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::ImageCacheReadPolicy

Definition at line 104 of file TiledImage.h.

◆ ImageCacheWritePolicy

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef TImageCacheWritePolicy DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::ImageCacheWritePolicy

Definition at line 105 of file TiledImage.h.

◆ ImageContainer

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef TImageContainer DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::ImageContainer

Types copied from the container.

Definition at line 93 of file TiledImage.h.

◆ ImageFactory

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef TImageFactory DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::ImageFactory

Types.

Definition at line 101 of file TiledImage.h.

◆ MyImageCache

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef ImageCache<OutputImage, ImageFactory, ImageCacheReadPolicy, ImageCacheWritePolicy > DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::MyImageCache

Definition at line 106 of file TiledImage.h.

◆ OutputImage

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef ImageFactory::OutputImage DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::OutputImage

Definition at line 102 of file TiledImage.h.

◆ OutputIterator

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef TiledIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::OutputIterator

Definition at line 452 of file TiledImage.h.

◆ Point

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef ImageContainer::Point DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::Point

Definition at line 95 of file TiledImage.h.

◆ Range

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef TiledImageBidirectionalRangeFromPoint<TiledImage > DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::Range

Definition at line 560 of file TiledImage.h.

◆ ReverseOutputIterator

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef ReverseTiledIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::ReverseOutputIterator

Definition at line 456 of file TiledImage.h.

◆ ReverseTiledIterator

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef boost::reverse_iterator<TiledIterator> DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::ReverseTiledIterator

Definition at line 454 of file TiledImage.h.

◆ Self

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef TiledImage<TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy> DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::Self

Definition at line 84 of file TiledImage.h.

◆ Value

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

typedef ImageContainer::Value DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::Value

Definition at line 96 of file TiledImage.h.

Constructor & Destructor Documentation

◆ TiledImage() [1/2]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::TiledImage	(	Alias< ImageFactory >	anImageFactory,
		Alias< ImageCacheReadPolicy >	aReadPolicy,
		Alias< ImageCacheWritePolicy >	aWritePolicy,
		typename Domain::Integer	N )

inline

Constructor.

Parameters

anImageFactory	alias on the image factory (see ImageFactoryFromImage or ImageFactoryFromHDF5).
aReadPolicy	alias on a read policy.
aWritePolicy	alias on a write policy.
N	how many tiles we want for each dimension.

Definition at line 119 of file TiledImage.h.

                                        :
      myN(N), myImageFactory(&anImageFactory), myReadPolicy(&aReadPolicy), myWritePolicy(&aWritePolicy)
    {
      myImageCache = new MyImageCache(myImageFactory, myReadPolicy, myWritePolicy);
 
      m_lowerBound = myImageFactory->domain().lowerBound();
      m_upperBound = myImageFactory->domain().upperBound();
 
      for(typename DGtal::Dimension i=0; i<Domain::dimension; i++)
        mySize[i] = (m_upperBound[i]-m_lowerBound[i]+1)/myN;
    }

References m_lowerBound, m_upperBound, myImageCache, myImageFactory, myN, myReadPolicy, mySize, and myWritePolicy.

Referenced by operator=(), TiledImage(), DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::TiledIterator::TiledIterator(), and DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::TiledIterator::TiledIterator().

◆ ~TiledImage()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::~TiledImage ( )

inline

Destructor.

Definition at line 137 of file TiledImage.h.

    {
      delete myImageCache;
    }

References myImageCache.

◆ TiledImage() [2/2]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::TiledImage ( const TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy > & other )

inline

Copy constructor.

Parameters

other the TiledImage to clone.

Definition at line 150 of file TiledImage.h.

    {
      myN =  other.myN;
      myImageFactory = other.myImageFactory;
      myReadPolicy = other.myReadPolicy;
      myWritePolicy = other.myWritePolicy;
 
      myImageCache = new MyImageCache(myImageFactory, myReadPolicy, myWritePolicy);
 
      m_lowerBound = myImageFactory->domain().lowerBound();
      m_upperBound = myImageFactory->domain().upperBound();
 
      for(typename DGtal::Dimension i=0; i<Domain::dimension; i++)
        mySize[i] = (m_upperBound[i]-m_lowerBound[i]+1)/myN;
    }

References m_lowerBound, m_upperBound, myImageCache, myImageFactory, myN, myReadPolicy, mySize, myWritePolicy, and TiledImage().

Member Function Documentation

◆ begin() [1/4]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

OutputIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::begin ( )

inline

Definition at line 464 of file TiledImage.h.

    {
      return TiledIterator( this->domainBlockCoords().begin(), this );
    }

References begin(), and domainBlockCoords().

◆ begin() [2/4]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ConstIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::begin ( ) const

inline

Definition at line 459 of file TiledImage.h.

    {
      return TiledIterator( this->domainBlockCoords().begin(), this );
    }

References begin(), and domainBlockCoords().

Referenced by begin(), begin(), begin(), begin(), outputIterator(), outputIterator(), rbegin(), rbegin(), rend(), and rend().

◆ begin() [3/4]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

OutputIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::begin ( const Point & aPoint )

inline

Definition at line 475 of file TiledImage.h.

    {
      Point coords = this->findBlockCoordsFromPoint(aPoint);
      return TiledIterator(  this->domainBlockCoords().begin(coords), aPoint, this );
    }

References aPoint, begin(), domainBlockCoords(), and findBlockCoordsFromPoint().

◆ begin() [4/4]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ConstIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::begin ( const Point & aPoint ) const

inline

Definition at line 469 of file TiledImage.h.

    {
      Point coords = this->findBlockCoordsFromPoint(aPoint);
      return TiledIterator(  this->domainBlockCoords().begin(coords), aPoint, this );
    }

References aPoint, begin(), domainBlockCoords(), and findBlockCoordsFromPoint().

◆ BOOST_CONCEPT_ASSERT() [1/4]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::BOOST_CONCEPT_ASSERT ( (concepts::CImage< TImageContainer >) )

Checking concepts.

◆ BOOST_CONCEPT_ASSERT() [2/4]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::BOOST_CONCEPT_ASSERT ( (concepts::CImageCacheReadPolicy< TImageCacheReadPolicy >) )

◆ BOOST_CONCEPT_ASSERT() [3/4]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::BOOST_CONCEPT_ASSERT ( (concepts::CImageCacheWritePolicy< TImageCacheWritePolicy >) )

◆ BOOST_CONCEPT_ASSERT() [4/4]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::BOOST_CONCEPT_ASSERT ( (concepts::CImageFactory< TImageFactory >) )

◆ clearCacheAndResetCacheMisses()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

void DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::clearCacheAndResetCacheMisses ( )

inline

Clear the cache and reset the cache misses

Definition at line 777 of file TiledImage.h.

    {
      myImageCache->clearCacheAndResetCacheMisses();
    }

References myImageCache.

◆ constRange()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ConstRange DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::constRange ( ) const

inline

Returns: the range providing begin and end iterators (with this) to scan the values of image.

Definition at line 566 of file TiledImage.h.

    {
      return ConstRange( this );
    }

◆ domain()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

const Domain & DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::domain ( ) const

inline

Returns a reference to the underlying image domain.

Returns: a reference to the domain.

Definition at line 202 of file TiledImage.h.

    {
      return myImageFactory->domain();
    }

References myImageFactory.

◆ domainBlockCoords()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

const Domain DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::domainBlockCoords ( ) const

inline

Returns the block coords domain.

Returns: the block coords domain.

Definition at line 212 of file TiledImage.h.

    {
      Point lowerBoundCords, upperBoundCoords;
 
      for(typename DGtal::Dimension i=0; i<Domain::dimension; i++)
        {
          lowerBoundCords[i] = 0;
          upperBoundCoords[i] = myN;
 
          if (((m_upperBound[i]-m_lowerBound[i]+1) % myN) == 0)
            upperBoundCoords[i]--;
        }
 
      return Domain(lowerBoundCords, upperBoundCoords);
    }

References m_lowerBound, m_upperBound, and myN.

Referenced by begin(), begin(), begin(), begin(), end(), end(), findSubDomainFromBlockCoords(), and findTileFromBlockCoords().

◆ end() [1/2]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

OutputIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::end ( )

inline

Definition at line 486 of file TiledImage.h.

    {
      return TiledIterator( this->domainBlockCoords().end(), this );
    }

References domainBlockCoords(), and end().

◆ end() [2/2]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ConstIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::end ( ) const

inline

Definition at line 481 of file TiledImage.h.

    {
      return TiledIterator( this->domainBlockCoords().end(), this );
    }

References domainBlockCoords(), and end().

Referenced by end(), end(), rbegin(), rbegin(), and routputIterator().

◆ findBlockCoordsFromPoint()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

const Point DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::findBlockCoordsFromPoint ( const Point & aPoint ) const

inline

Get the block coords containing aPoint.

Parameters

aPoint the point.

Returns: the block coords containing aPoint.

Definition at line 635 of file TiledImage.h.

    {
      ASSERT(myImageFactory->domain().isInside(aPoint));
 
      typename DGtal::Dimension i;
 
      Point low;
      for(i=0; i<Domain::dimension; i++)
        {
          /*if ( (aPoint[i]-m_lowerBound[i]) < mySize[i] )
            low[i] = 0;
            else*/
          low[i] = (aPoint[i]-m_lowerBound[i])/mySize[i];
        }
 
      return low;
    }

References aPoint, m_lowerBound, myImageFactory, and mySize.

Referenced by begin(), and begin().

◆ findSubDomain()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

const Domain DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::findSubDomain ( const Point & aPoint ) const

inline

Get the domain containing aPoint.

Parameters

aPoint the point.

Returns: the domain containing aPoint.

Definition at line 603 of file TiledImage.h.

    {
      ASSERT(myImageFactory->domain().isInside(aPoint));
 
      typename DGtal::Dimension i;
 
      Point low;
      for(i=0; i<Domain::dimension; i++)
        {
          low[i] = (aPoint[i]-m_lowerBound[i])/mySize[i];
        }
 
      Point dMin, dMax;
      for(i=0; i<Domain::dimension; i++)
        {
          dMin[i] = (low[i]*mySize[i])+m_lowerBound[i];
          dMax[i] = dMin[i] + (mySize[i]-1);
 
          if (dMax[i] > m_upperBound[i]) // last tile
            dMax[i] = m_upperBound[i];
        }
 
      Domain di(dMin, dMax);
      return di;
    }

References aPoint, m_lowerBound, m_upperBound, myImageFactory, and mySize.

Referenced by operator()(), and setValue().

◆ findSubDomainFromBlockCoords()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

const Domain DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::findSubDomainFromBlockCoords ( const Point & aCoord ) const

inline

Get the domain with his block coords.

Parameters

aCoord the block coords.

Returns: the domain.

Definition at line 659 of file TiledImage.h.

    {
      ASSERT(domainBlockCoords().isInside(aCoord));
 
      typename DGtal::Dimension i;
 
      Point dMin, dMax;
      for(i=0; i<Domain::dimension; i++)
        {
          dMin[i] = (aCoord[i]*mySize[i])+m_lowerBound[i];
          dMax[i] = dMin[i] + (mySize[i]-1);
 
          if (dMax[i] > m_upperBound[i]) // last tile
            dMax[i] = m_upperBound[i];
        }
 
      Domain di(dMin, dMax);
      return di;
    }

References domainBlockCoords(), m_lowerBound, m_upperBound, and mySize.

Referenced by findTileFromBlockCoords().

◆ findTileFromBlockCoords()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ImageContainer * DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::findTileFromBlockCoords ( const Point & aCoord ) const

inline

Returns an ImageContainer pointer for the block coords aCoord.

Parameters

aCoord the block coords.

Returns: an ImageContainer pointer.

Definition at line 685 of file TiledImage.h.

    {
      ASSERT(domainBlockCoords().isInside(aCoord));
 
      Domain d = findSubDomainFromBlockCoords( aCoord );
      ImageContainer *tile = myImageCache->getPage(d);
      if (!tile)
        {
          myImageCache->incCacheMissRead();
          myImageCache->update(d);
          tile = myImageCache->getPage(d);
        }
 
      return tile;
    }

References domainBlockCoords(), findSubDomainFromBlockCoords(), and myImageCache.

◆ getCacheMissRead()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

unsigned int DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::getCacheMissRead ( )

inline

Get the cacheMissRead value.

Definition at line 761 of file TiledImage.h.

    {
      return myImageCache->getCacheMissRead();
    }

References myImageCache.

◆ getCacheMissWrite()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

unsigned int DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::getCacheMissWrite ( )

inline

Get the cacheMissWrite value.

Definition at line 769 of file TiledImage.h.

    {
      return myImageCache->getCacheMissWrite();
    }

References myImageCache.

◆ isValid()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

bool DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::isValid ( ) const

inline

Checks the validity/consistency of the object.

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

Definition at line 592 of file TiledImage.h.

    {
      return (myImageFactory->isValid() && myImageCache->isValid());
    }

References myImageCache, and myImageFactory.

◆ operator()()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

Value DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::operator() ( const Point & aPoint ) const

inline

Get the value of an image (from cache) at a given position given by aPoint.

Parameters

aPoint the point.

Returns: the value at aPoint.

Definition at line 707 of file TiledImage.h.

    {
      ASSERT(myImageFactory->domain().isInside(aPoint));
 
      typename OutputImage::Value aValue;
      bool res;
 
      res = myImageCache->read(aPoint, aValue);
 
      if (res)
        return aValue;
      else
        {
          myImageCache->incCacheMissRead();
          Domain d;
#ifdef DEBUG_VERBOSE
          trace.info()<<"+";
#endif 
          d = findSubDomain(aPoint);
 
          myImageCache->update(d);
 
          myImageCache->read(aPoint, aValue);
 
          return aValue;
        }
 
      // Unspecified behavior, returning the default constructed value.
      return aValue;
    }

References aPoint, findSubDomain(), myImageCache, myImageFactory, and DGtal::trace.

◆ operator=()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

TiledImage & DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::operator= ( const TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy > & other )

inline

Assignment.

Parameters

other the TiledImage to copy.

Returns: a reference on 'this'.

Definition at line 171 of file TiledImage.h.

    {
        if ( this != &other )
        {
          myN =  other.myN;
          myImageFactory = other.myImageFactory;
          myReadPolicy = other.myReadPolicy;
          myWritePolicy = other.myWritePolicy;
 
          myImageCache = new MyImageCache(myImageFactory, myReadPolicy, myWritePolicy);
 
          m_lowerBound = myImageFactory->domain().lowerBound();
          m_upperBound = myImageFactory->domain().upperBound();
 
          for(typename DGtal::Dimension i=0; i<Domain::dimension; i++)
            mySize[i] = (m_upperBound[i]-m_lowerBound[i]+1)/myN;
        }
 
        return *this;
    }

References m_lowerBound, m_upperBound, myImageCache, myImageFactory, myN, myReadPolicy, mySize, myWritePolicy, and TiledImage().

◆ outputIterator() [1/2]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

OutputIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::outputIterator ( )

inline

Definition at line 537 of file TiledImage.h.

    {
      return OutputIterator( begin() );
    }

References begin().

◆ outputIterator() [2/2]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

OutputIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::outputIterator ( const Point & aPoint )

inline

Definition at line 542 of file TiledImage.h.

    {
      return OutputIterator( begin(aPoint) );
    }

References aPoint, and begin().

◆ range()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

Range DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::range ( )

inline

Returns: the range providing begin and end iterators (with this) to scan the values of image.

Definition at line 575 of file TiledImage.h.

    {
      return Range( this );
    }

◆ rbegin() [1/4]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ReverseOutputIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::rbegin ( )

inline

Definition at line 496 of file TiledImage.h.

    {
      return ReverseTiledIterator( end() );
    }

References end().

◆ rbegin() [2/4]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ConstReverseIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::rbegin ( ) const

inline

Definition at line 491 of file TiledImage.h.

    {
      return ReverseTiledIterator( end() );
    }

References end().

Referenced by routputIterator().

◆ rbegin() [3/4]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ReverseOutputIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::rbegin ( const Point & aPoint )

inline

Definition at line 513 of file TiledImage.h.

    {
      typename DGtal::Dimension i;
 
      Point point2;
      for(i=0; i<Domain::dimension; i++)
        point2[i]=(m_upperBound[i]-aPoint[i])+m_lowerBound[i];
 
      TiledIterator it( begin(point2) ); it++;
      return ReverseTiledIterator(it);
    }

References aPoint, begin(), m_lowerBound, and m_upperBound.

◆ rbegin() [4/4]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ConstReverseIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::rbegin ( const Point & aPoint ) const

inline

Definition at line 501 of file TiledImage.h.

    {
      typename DGtal::Dimension i;
 
      Point point2;
      for(i=0; i<Domain::dimension; i++)
        point2[i]=(m_upperBound[i]-aPoint[i])+m_lowerBound[i];
 
      TiledIterator it( begin(point2) ); it++;
      return ReverseTiledIterator(it);
    }

References aPoint, begin(), m_lowerBound, and m_upperBound.

◆ rend() [1/2]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ConstReverseIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::rend ( )

inline

Definition at line 530 of file TiledImage.h.

    {
      return ReverseTiledIterator( begin() );
    }

References begin().

◆ rend() [2/2]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ConstReverseIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::rend ( ) const

inline

Definition at line 525 of file TiledImage.h.

    {
      return ReverseTiledIterator( begin() );
    }

References begin().

◆ routputIterator() [1/2]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ReverseOutputIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::routputIterator ( )

inline

Definition at line 547 of file TiledImage.h.

    {
      return ReverseOutputIterator( end() );
    }

References end().

◆ routputIterator() [2/2]

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ReverseOutputIterator DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::routputIterator ( const Point & aPoint )

inline

Definition at line 552 of file TiledImage.h.

    {
      return ReverseOutputIterator( rbegin(aPoint) );
    }

References aPoint, and rbegin().

◆ selfDisplay()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

void DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::selfDisplay ( std::ostream & out ) const

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

◆ setValue()

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

void DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::setValue	(	const Point &	aPoint,
		const Value &	aValue )

inline

Set a value on an image (in cache) at a position specified by a aPoint.

Parameters

aPoint	the point.
aValue	the value.

Definition at line 744 of file TiledImage.h.

    {
      ASSERT(myImageFactory->domain().isInside(aPoint));
 
      if (myImageCache->write(aPoint, aValue))
        return;
      else
        {
          myImageCache->incCacheMissWrite();
          myImageCache->update(findSubDomain(aPoint));
          myImageCache->write(aPoint, aValue);
        }
    }

References aPoint, findSubDomain(), myImageCache, and myImageFactory.

Field Documentation

◆ m_lowerBound

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

Point DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::m_lowerBound

protected

domain lower and upper bound

Definition at line 798 of file TiledImage.h.

Referenced by domainBlockCoords(), findBlockCoordsFromPoint(), findSubDomain(), findSubDomainFromBlockCoords(), operator=(), rbegin(), rbegin(), TiledImage(), and TiledImage().

◆ m_upperBound

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

Point DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::m_upperBound

protected

Definition at line 798 of file TiledImage.h.

Referenced by domainBlockCoords(), findSubDomain(), findSubDomainFromBlockCoords(), operator=(), rbegin(), rbegin(), TiledImage(), and TiledImage().

◆ myImageCache

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

MyImageCache* DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::myImageCache

protected

ImageCache pointer.

Definition at line 795 of file TiledImage.h.

Referenced by clearCacheAndResetCacheMisses(), findTileFromBlockCoords(), getCacheMissRead(), getCacheMissWrite(), isValid(), operator()(), operator=(), setValue(), TiledImage(), TiledImage(), and ~TiledImage().

◆ myImageFactory

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

ImageFactory* DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::myImageFactory

protected

ImageFactory pointer.

Definition at line 792 of file TiledImage.h.

Referenced by domain(), findBlockCoordsFromPoint(), findSubDomain(), isValid(), operator()(), operator=(), setValue(), TiledImage(), and TiledImage().

◆ myN

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

Domain::Integer DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::myN

protected

Number of tiles per dimension.

Definition at line 786 of file TiledImage.h.

Referenced by domainBlockCoords(), operator=(), TiledImage(), and TiledImage().

◆ myReadPolicy

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

TImageCacheReadPolicy* DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::myReadPolicy

protected

TImageCacheReadPolicy pointer.

Definition at line 801 of file TiledImage.h.

Referenced by operator=(), TiledImage(), and TiledImage().

◆ mySize

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

Point DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::mySize

protected

Width of a tile (for each dimension)

Definition at line 789 of file TiledImage.h.

Referenced by findBlockCoordsFromPoint(), findSubDomain(), findSubDomainFromBlockCoords(), operator=(), TiledImage(), and TiledImage().

◆ myWritePolicy

template<typename TImageContainer, typename TImageFactory, typename TImageCacheReadPolicy, typename TImageCacheWritePolicy>

TImageCacheWritePolicy* DGtal::TiledImage< TImageContainer, TImageFactory, TImageCacheReadPolicy, TImageCacheWritePolicy >::myWritePolicy

protected

TImageCacheWritePolicy pointer.

Definition at line 804 of file TiledImage.h.

Referenced by operator=(), TiledImage(), and TiledImage().

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

TiledImage.h

Data Structures

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ConstIterator

◆ ConstRange

◆ ConstReverseIterator

◆ Difference

◆ Domain

◆ ImageCacheReadPolicy

◆ ImageCacheWritePolicy

◆ ImageContainer

◆ ImageFactory

◆ MyImageCache

◆ OutputImage

◆ OutputIterator

◆ Point

◆ Range

◆ ReverseOutputIterator

◆ ReverseTiledIterator

◆ Self

◆ Value

Constructor & Destructor Documentation

◆ TiledImage() [1/2]

◆ ~TiledImage()

◆ TiledImage() [2/2]

Member Function Documentation

◆ begin() [1/4]

◆ begin() [2/4]

◆ begin() [3/4]

◆ begin() [4/4]

◆ BOOST_CONCEPT_ASSERT() [1/4]

◆ BOOST_CONCEPT_ASSERT() [2/4]

◆ BOOST_CONCEPT_ASSERT() [3/4]

◆ BOOST_CONCEPT_ASSERT() [4/4]

◆ clearCacheAndResetCacheMisses()

◆ constRange()

◆ domain()

◆ domainBlockCoords()

◆ end() [1/2]

◆ end() [2/2]

◆ findBlockCoordsFromPoint()

◆ findSubDomain()

◆ findSubDomainFromBlockCoords()

◆ findTileFromBlockCoords()

◆ getCacheMissRead()

◆ getCacheMissWrite()

◆ isValid()

◆ operator()()

◆ operator=()

◆ outputIterator() [1/2]

◆ outputIterator() [2/2]

◆ range()

◆ rbegin() [1/4]

◆ rbegin() [2/4]

◆ rbegin() [3/4]

◆ rbegin() [4/4]

◆ rend() [1/2]

◆ rend() [2/2]

◆ routputIterator() [1/2]

◆ routputIterator() [2/2]

◆ selfDisplay()

◆ setValue()

Field Documentation

◆ m_lowerBound

◆ m_upperBound

◆ myImageCache

◆ myImageFactory

◆ myN

◆ myReadPolicy

◆ mySize

◆ myWritePolicy