#include <DefaultImageRange.h>

Public Types
typedef TImage::Domain	Domain
typedef TImage::Point	Point
typedef TImage::Value	Value
typedef ConstIteratorAdapter < typename Domain::ConstIterator, TImage, Value >	ConstIterator
typedef std::reverse_iterator < ConstIterator >	ConstReverseIterator
typedef SetValueIterator< TImage >	OutputIterator
typedef SetValueIterator < TImage, typename Domain::ConstReverseIterator >	ReverseOutputIterator

Public Member Functions
	BOOST_CONCEPT_ASSERT ((CTrivialImage< TImage >))
	BOOST_CONCEPT_ASSERT ((CDomain< Domain >))
	DefaultImageRange (TImage &aImage)
	DefaultImageRange (const DefaultImageRange &other)
DefaultImageRange &	operator= (const DefaultImageRange &other)
	~DefaultImageRange ()
bool	isValid () const
ConstIterator	begin () const
ConstIterator	begin (const Point &aPoint) const
ConstIterator	end () const
ConstReverseIterator	rbegin () const
ConstReverseIterator	rbegin (const Point &aPoint) const
ConstReverseIterator	rend () const
OutputIterator	outputIterator () const
OutputIterator	outputIterator (const Point &aPoint) const
ReverseOutputIterator	routputIterator () const
ReverseOutputIterator	routputIterator (const Point &aPoint) const

Private Attributes
TImage *	myImagePtr

Detailed Description

template<typename TImage>
class DGtal::DefaultImageRange< TImage >

Aim: model of CConstBidirectionalRangeFromPoint and CBidirectionalOutputRangeFromPoint that adapts the domain of an image in order to iterate over the values associated to its domain points (in a read-only as well as a write-only manner).

Template Parameters:

TImage a model of CImage mapping points to values

NB: the underlying image is stored as an aliasing pointer in order to avoid copies. As a consequence the pointed object must exist and must not be deleted during the use of any instance of this class.

TODO: inherits from DefaultConstImageRange

Definition at line 76 of file DefaultImageRange.h.

Member Typedef Documentation

template<typename TImage >

typedef ConstIteratorAdapter<typename Domain::ConstIterator,TImage,Value> DGtal::DefaultImageRange< TImage >::ConstIterator

Definition at line 90 of file DefaultImageRange.h.

template<typename TImage >

typedef std::reverse_iterator<ConstIterator> DGtal::DefaultImageRange< TImage >::ConstReverseIterator

Definition at line 91 of file DefaultImageRange.h.

template<typename TImage >

typedef TImage::Domain DGtal::DefaultImageRange< TImage >::Domain

Definition at line 84 of file DefaultImageRange.h.

template<typename TImage >

typedef SetValueIterator<TImage> DGtal::DefaultImageRange< TImage >::OutputIterator

output iterator types

Definition at line 94 of file DefaultImageRange.h.

template<typename TImage >

typedef TImage::Point DGtal::DefaultImageRange< TImage >::Point

Definition at line 85 of file DefaultImageRange.h.

template<typename TImage >

typedef SetValueIterator<TImage, typename Domain::ConstReverseIterator> DGtal::DefaultImageRange< TImage >::ReverseOutputIterator

Definition at line 95 of file DefaultImageRange.h.

template<typename TImage >

typedef TImage::Value DGtal::DefaultImageRange< TImage >::Value

Definition at line 86 of file DefaultImageRange.h.

Constructor & Destructor Documentation

template<typename TImage >

DGtal::DefaultImageRange< TImage >::DefaultImageRange ( TImage & aImage )

inline

Standard constructor from an image.

Parameters:

aImage any image.

Definition at line 104 of file DefaultImageRange.h.

: myImagePtr(&aImage) {}

template<typename TImage >

DGtal::DefaultImageRange< TImage >::DefaultImageRange ( const DefaultImageRange< TImage > & other )

inline

Copy constructor.

Parameters:

other the iterator to clone.

Definition at line 111 of file DefaultImageRange.h.

: myImagePtr(other.myImagePtr) {}

template<typename TImage >

DGtal::DefaultImageRange< TImage >::~DefaultImageRange ( )

inline

Destructor. Does nothing.

Definition at line 131 of file DefaultImageRange.h.

{}

Member Function Documentation

template<typename TImage >

ConstIterator DGtal::DefaultImageRange< TImage >::begin ( ) const

inline

Iterator service.

Returns:: begin iterator

Definition at line 155 of file DefaultImageRange.h.

References DGtal::DefaultImageRange< TImage >::myImagePtr.

Referenced by DGtal::DefaultImageRange< TImage >::rend().

                                {
      Domain d = myImagePtr->domain(); 
      return ConstIterator( d.begin(), *myImagePtr );
    }

template<typename TImage >

ConstIterator DGtal::DefaultImageRange< TImage >::begin ( const Point & aPoint ) const

inline

Iterator service.

Parameters:

aPoint any point

Returns:: begin iterator

Definition at line 165 of file DefaultImageRange.h.

References DGtal::DefaultImageRange< TImage >::myImagePtr.

                                                   {
      Domain d = myImagePtr->domain(); 
      return ConstIterator( d.begin(aPoint), *myImagePtr );
    }

template<typename TImage >

DGtal::DefaultImageRange< TImage >::BOOST_CONCEPT_ASSERT ( (CTrivialImage< TImage >) )

template<typename TImage >

DGtal::DefaultImageRange< TImage >::BOOST_CONCEPT_ASSERT ( (CDomain< Domain >) )

constant iterator types

template<typename TImage >

ConstIterator DGtal::DefaultImageRange< TImage >::end ( ) const

inline

Iterator service.

Returns:: end iterator

Definition at line 174 of file DefaultImageRange.h.

References DGtal::DefaultImageRange< TImage >::myImagePtr.

Referenced by DGtal::DefaultImageRange< TImage >::rbegin().

                              {
      Domain d = myImagePtr->domain(); 
      return ConstIterator( d.end(), *myImagePtr );
    }

template<typename TImage >

bool DGtal::DefaultImageRange< TImage >::isValid ( ) const

inline

Checks the validity/consistency of the object.

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

Definition at line 137 of file DefaultImageRange.h.

{ return true; }

template<typename TImage >

DefaultImageRange& DGtal::DefaultImageRange< TImage >::operator= ( const DefaultImageRange< TImage > & other )

inline

Assignment.

Parameters:

other the iterator to copy.

Returns:: a reference on 'this'.

Definition at line 119 of file DefaultImageRange.h.

References DGtal::DefaultImageRange< TImage >::myImagePtr.

    {  
      if ( this != &other )
        {
          myImagePtr = other.myImagePtr;
        }
      return *this;
    }

template<typename TImage >

OutputIterator DGtal::DefaultImageRange< TImage >::outputIterator ( ) const

inline

Iterator service.

Returns:: output iterator

Definition at line 214 of file DefaultImageRange.h.

References DGtal::DefaultImageRange< TImage >::myImagePtr.

                                          {
      Domain d = myImagePtr->domain(); 
      return OutputIterator( d.begin(), *myImagePtr );
    }

template<typename TImage >

OutputIterator DGtal::DefaultImageRange< TImage >::outputIterator ( const Point & aPoint ) const

inline

Iterator service.

Parameters:

aPoint any point

Returns:: output iterator

Definition at line 224 of file DefaultImageRange.h.

References DGtal::DefaultImageRange< TImage >::myImagePtr.

                                                             {
      Domain d = myImagePtr->domain(); 
      return OutputIterator( d.begin(aPoint), *myImagePtr );
    }

template<typename TImage >

ConstReverseIterator DGtal::DefaultImageRange< TImage >::rbegin ( ) const

inline

Iterator service.

Returns:: rbegin iterator

Definition at line 183 of file DefaultImageRange.h.

References DGtal::DefaultImageRange< TImage >::end().

                                        {
      return ConstReverseIterator(this->end());
    }

template<typename TImage >

ConstReverseIterator DGtal::DefaultImageRange< TImage >::rbegin ( const Point & aPoint ) const

inline

Iterator service.

Parameters:

aPoint any point

Returns:: rbegin iterator

Definition at line 192 of file DefaultImageRange.h.

References DGtal::DefaultImageRange< TImage >::myImagePtr.

                                                           {
      Domain d = myImagePtr->domain(); 
      typename Domain::ConstIterator itOnPts = d.begin(aPoint); 
      if ( itOnPts != d.end() ) ++itOnPts; 
      ConstIterator itOnVals( itOnPts, *myImagePtr );
      return ConstReverseIterator( itOnVals );
    }

template<typename TImage >

ConstReverseIterator DGtal::DefaultImageRange< TImage >::rend ( ) const

inline

Iterator service.

Returns:: rend iterator

Definition at line 204 of file DefaultImageRange.h.

References DGtal::DefaultImageRange< TImage >::begin().

                                      {
      return ConstReverseIterator(this->begin());
    }

template<typename TImage >

ReverseOutputIterator DGtal::DefaultImageRange< TImage >::routputIterator ( ) const

inline

Iterator service.

Returns:: reverse output iterator

Definition at line 233 of file DefaultImageRange.h.

References DGtal::DefaultImageRange< TImage >::myImagePtr.

                                                  {
      Domain d = myImagePtr->domain();
      return ReverseOutputIterator( d.rbegin(), *myImagePtr );
    }

template<typename TImage >

ReverseOutputIterator DGtal::DefaultImageRange< TImage >::routputIterator ( const Point & aPoint ) const

inline

Iterator service.

Parameters:

aPoint any point

Returns:: reverse output iterator

Definition at line 243 of file DefaultImageRange.h.

References DGtal::DefaultImageRange< TImage >::myImagePtr.

                                                                     {
      Domain d = myImagePtr->domain();
      return ReverseOutputIterator( d.rbegin(aPoint), *myImagePtr );
    }