[ VIGRA Homepage | Function Index | Class Index | Namespaces | File List | Main Page ]
General image iterator definition and implementations.
General image iterator definition and implementations.
The following tables describe the general requirements for image iterators and their iterator traits. The iterator implementations provided here may be used for any image data type that stores its data as a linear array of pixels. The array will be interpreted as a row-major matrix with a particular width.
Local Types | Meaning | |
---|---|---|
ImageIterator::value_type | the underlying image's pixel type | |
ImageIterator::PixelType | the underlying image's pixel type | |
ImageIterator::reference | the iterator's reference type (return type of *iter ). Will be value_type & for a mutable iterator, and convertible to value_type const & for a const iterator. | |
ImageIterator::index_reference | the iterator's index reference type (return type of iter[diff] ). Will be value_type & for a mutable iterator, and convertible to value_type const & for a const iterator. | |
ImageIterator::pointer | the iterator's pointer type (return type of iter.operator->() ). Will be value_type * for a mutable iterator, and convertible to value_type const * for a const iterator. | |
ImageIterator::difference_type | the iterator's difference type (vigra::Diff2D ) | |
ImageIterator::iterator_category | the iterator tag (vigra::image_traverser_tag ) | |
ImageIterator::row_iterator | the associated row iterator | |
ImageIterator::column_iterator | the associated column iterator | |
ImageIterator::MoveX | type of the horizontal navigator | |
ImageIterator::MoveY | type of the vertical navigator | |
Operation | Result | Semantics |
++i.x | void | increment x-coordinate |
–i.x | void | decrement x-coordinate |
i.x += dx | ImageIterator::MoveX & | add dx to x-coordinate |
i.x -= dx | ImageIterator::MoveX & | subtract dx from x-coordinate |
i.x - j.x | int | difference of the x-coordinates of i and j |
i.x = j.x | ImageIterator::MoveX & | i.x += j.x - i.x |
i.x == i.y | bool |
|
i.x < j.x | bool |
|
++i.y | void | increment y-coordinate |
–i.y | void | decrement y-coordinate |
i.y += dy | ImageIterator::MoveY & | add dy to y-coordinate |
i.y -= dy | ImageIterator::MoveY & | subtract dy from y-coordinate |
i.y - j.y | int | difference of the y-coordinates of i and j |
i.y = j.y | ImageIterator::MoveY & | i.y += j.y - i.y |
i.y == j.y | bool |
|
i.y < j.y | bool | j.y - i.y > 0 |
ImageIterator k(i) | copy constructor | |
k = i | ImageIterator & | assignment |
ImageIterator k | default constructor | |
ImageIterator::row_iterator r(i) | construction of row iterator | |
ImageIterator::column_iterator c(i) | construction of column iterator | |
i += diff | ImageIterator & | { i.x += diff.x |
i -= diff | ImageIterator & | { i.x -= diff.x |
i + diff | ImageIterator | { ImageIterator tmp(i); |
i - diff | ImageIterator | { ImageIterator tmp(i); |
i - j | ImageIterator::difference_type | { ImageIterator::difference_type tmp(i.x - j.x, i.y - j.y); |
i == j | bool | i.x == j.x && i.y == j.y |
*i | ImageIterator::reference | access the current pixel |
i[diff] | ImageIterator::index_reference | access pixel at offset diff |
i(dx, dy) | ImageIterator::index_reference | access pixel at offset (dx, dy) |
i->member() | depends on operation | call member function of underlying pixel type via operator-> of iterator |
i, j, k are of type ImageIterator diff is of type ImageIterator::difference_type dx, dy are of type int |
The following iterator traits must be defined for an image iterator:
Types | Meaning |
---|---|
IteratorTraits<ImageIterator>::Iterator | the iterator type the traits are referring to |
IteratorTraits<ImageIterator>::iterator | the iterator type the traits are referring to |
IteratorTraits<ImageIterator>::value_type | the underlying image's pixel type |
IteratorTraits<ImageIterator>::reference | the iterator's reference type (return type of *iter ) |
IteratorTraits<ImageIterator>::index_reference | the iterator's index reference type (return type of iter[diff] ) |
IteratorTraits<ImageIterator>::pointer | the iterator's pointer type (return type of iter.operator->() ) |
IteratorTraits<ImageIterator>::difference_type | the iterator's difference type |
IteratorTraits<ImageIterator>::iterator_category | the iterator tag (vigra::image_traverser_tag ) |
IteratorTraits<ImageIterator>::row_iterator | the associated row iterator |
IteratorTraits<ImageIterator>::column_iterator | the associated column iterator |
IteratorTraits<ImageIterator>::DefaultAccessor | the default accessor to be used with the iterator |
IteratorTraits<ImageIterator>::default_accessor | the default accessor to be used with the iterator |
IteratorTraits<ImageIterator>::hasConstantStrides | whether the iterator uses constant strides on the underlying memory (always VigraTrueType for ImageIterator s). |
© Ullrich Köthe (ullrich.koethe@iwr.uni-heidelberg.de) |