Iterators module
#include "diplib/generic_iterators.h"

dip::ImageSliceIterator class

An iterator for slice-by-slice processing of an image. Use it to process a multi-dimensional image as a series of lower-dimensional images.

Dereferencing the iterator yields a reference to an image that encapsulates a plane in the original image. This image has the protected flag set so that it cannot be stripped or reforged.

The iterator can be moved to any arbitrary slice with a non-negative index (so you cannot decrement it below 0, the first slice; if you try nothing will happen), even slices past the last one. If the iterator points at a slice that does not exist, the iterator will test false, but it will still be a valid iterator that can be manipulated. Do not dereference such an iterator!

dip::ImageSliceIterator it( img, 2 );
do {
   // do something with the image *it here.
} while( ++it );

The function dip::ImageSliceEndIterator creates an iterator that points at a slice one past the last, and so is a end iterator. Because it is not possible to decrement below 0, a loop that iterates in reverse order must test the dip::ImageSliceIterator::Coordinate for equality to zero:

dip::ImageSliceEndIterator it( img, 2 );
do {
   --it;
   // do something with the image *it here.
} while( it.Coordinate() != 0 );

Note that when the original image is stripped or reforged, the iterator is still valid and holds on to the original data segment.

Satisfies all the requirements for a mutable ForwardIterator. Additionally, it behaves like a RandomAccessIterator except for the indexing operator [], which would be less efficient in use and therefore it’s better to not offer it.