[ VIGRA Homepage | Function Index | Class Index | Namespaces | File List | Main Page ]

Public Types | Public Member Functions
ImageIterator< PIXELTYPE > Class Template Reference

Standard 2D random access iterator for images that store the data in a linear array. More...

#include <vigra/imageiterator.hxx>

Inheritance diagram for ImageIterator< PIXELTYPE >:
ImageIteratorBase< ImageIterator< PIXELTYPE >, PIXELTYPE, PIXELTYPE &, PIXELTYPE * >

List of all members.

Public Types

typedef Base::difference_type difference_type
typedef Base::pointer pointer
- Public Types inherited from ImageIteratorBase< ImageIterator< PIXELTYPE >, PIXELTYPE, PIXELTYPE &, PIXELTYPE * >
typedef ColumnIteratorSelector::res column_iterator
typedef PIXELTYPE & index_reference
typedef image_traverser_tag iterator_category
typedef
detail::DirectionSelector
< UnstridedArrayTag >
::template type< pointer
MoveX
typedef
detail::DirectionSelector
< StridedArrayTag >::template
type< int > 
MoveY
typedef PIXELTYPE PixelType
typedef PIXELTYPE & reference
typedef RowIteratorSelector::res row_iterator
typedef PIXELTYPE value_type

Public Member Functions

 ImageIterator (pointer base, int ystride)
 ImageIterator ()
- Public Member Functions inherited from ImageIteratorBase< ImageIterator< PIXELTYPE >, PIXELTYPE, PIXELTYPE &, PIXELTYPE * >
bool operator== (ImageIteratorBase const &rhs) const
bool operator!= (ImageIteratorBase const &rhs) const
difference_type operator- (ImageIteratorBase const &rhs) const
ImageIterator< PIXELTYPE > operator- (difference_type const &s) const
ImageIterator< PIXELTYPE > & operator+= (difference_type const &s)
ImageIterator< PIXELTYPE > & operator-= (difference_type const &s)
ImageIterator< PIXELTYPE > operator+ (difference_type const &s) const
reference operator* () const
pointer operator-> () const
index_reference operator[] (Diff2D const &d) const
pointer operator[] (int dy) const
index_reference operator() (int dx, int dy) const

Additional Inherited Members

- Public Attributes inherited from ImageIteratorBase< ImageIterator< PIXELTYPE >, PIXELTYPE, PIXELTYPE &, PIXELTYPE * >
MoveX x
MoveY y
- Protected Member Functions inherited from ImageIteratorBase< ImageIterator< PIXELTYPE >, PIXELTYPE, PIXELTYPE &, PIXELTYPE * >
 ImageIteratorBase (pointer base, int ystride)
 ImageIteratorBase (pointer base, int xstride, int ystride)
 ImageIteratorBase (ImageIteratorBase const &rhs)
 ImageIteratorBase ()
ImageIteratorBaseoperator= (ImageIteratorBase const &rhs)

Detailed Description

template<class PIXELTYPE>
class vigra::ImageIterator< PIXELTYPE >

Standard 2D random access iterator for images that store the data in a linear array.

Most functions and local types are inherited from ImageIteratorBase.

See the paper: U. Koethe: Reusable Algorithms in Image Processing for a discussion of the concepts behind ImageIterators.

#include <vigra/imageiterator.hxx>

Namespace: vigra


Member Typedef Documentation

the iterator's pointer type (return type of iter.operator->())

Reimplemented from ImageIteratorBase< ImageIterator< PIXELTYPE >, PIXELTYPE, PIXELTYPE &, PIXELTYPE * >.

the iterator's difference type (argument type of iter[diff])

Reimplemented from ImageIteratorBase< ImageIterator< PIXELTYPE >, PIXELTYPE, PIXELTYPE &, PIXELTYPE * >.


Constructor & Destructor Documentation

ImageIterator ( pointer  base,
int  ystride 
)
Construct from raw memory with a vertical stride of <TT>ystride</TT>.

ystride must equal the physical image width (row length), even if the iterator will only be used for a sub image. If the raw memory is encapsulated in an image object this object should have a factory function that constructs the iterator.

Default constructor


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

© Ullrich Köthe (ullrich.koethe@iwr.uni-heidelberg.de)
Heidelberg Collaboratory for Image Processing, University of Heidelberg, Germany

html generated using doxygen and Python
vigra 1.7.1 (Tue Jul 10 2012)