A flexible iterator for itk containers(i.e. itk::Neighborhood) that support pixel access through operator[]. More...
#include <itkSliceIterator.h>
Public Member Functions | |
SliceIterator | Begin () |
bool | operator!= (const SliceIterator &orig) |
TPixel & | operator* () |
SliceIterator | operator++ (int) |
SliceIterator | operator++ () |
bool | operator< (const SliceIterator &orig) |
bool | operator== (const SliceIterator &orig) |
TPixel & | operator[] (unsigned long n) |
SliceIterator (TContainer *n, std::slice s) | |
SliceIterator | End () |
A flexible iterator for itk containers(i.e. itk::Neighborhood) that support pixel access through operator[].
SliceIterator allows iteration along a std::slice through the container. A slice is a construct that defines a starting position, stride length (distance between adjacent elements), and a length.
Any container with operator[] is supported. Because it uses this interface the iterator is only as efficient as the implementation of a container's operator[] method.
References: Modeled after a slice iterator proposed by Bjarne Stroustrup in C++ Programming Language, Third Edition. Bjarne Stroustrup. Addison Wesley, Reading, MA. 1997.
Definition at line 45 of file itkSliceIterator.h.
itk::SliceIterator< TPixel, TContainer >::SliceIterator | ( | TContainer * | n, | |
std::slice | s | |||
) | [inline] |
Constructor.
Definition at line 49 of file itkSliceIterator.h.
SliceIterator itk::SliceIterator< TPixel, TContainer >::Begin | ( | void | ) | [inline] |
Returns a SliceIterator that points to the beginning of the slice.
Definition at line 53 of file itkSliceIterator.h.
SliceIterator itk::SliceIterator< TPixel, TContainer >::End | ( | void | ) | [inline] |
Returns a SliceIterator that points to one past the end of the slice.
Definition at line 61 of file itkSliceIterator.h.
bool itk::SliceIterator< TPixel, TContainer >::operator!= | ( | const SliceIterator< TPixel, TContainer > & | orig | ) | [inline] |
Returns the logical inverse of the boolean == of two slice iterators.
Definition at line 104 of file itkSliceIterator.h.
References itk::operator==().
TPixel& itk::SliceIterator< TPixel, TContainer >::operator* | ( | ) | [inline] |
Dereferences the iterator, returning the value that it points to.
Definition at line 91 of file itkSliceIterator.h.
SliceIterator itk::SliceIterator< TPixel, TContainer >::operator++ | ( | int | ) | [inline] |
Increments the iterator.
Definition at line 77 of file itkSliceIterator.h.
SliceIterator itk::SliceIterator< TPixel, TContainer >::operator++ | ( | ) | [inline] |
Increments the iterator.
Definition at line 70 of file itkSliceIterator.h.
bool itk::SliceIterator< TPixel, TContainer >::operator< | ( | const SliceIterator< TPixel, TContainer > & | orig | ) | [inline] |
Returns the boolean < of two slice iterator positions. Result is only true if the slice iterators have the same stride and start location.
Definition at line 112 of file itkSliceIterator.h.
bool itk::SliceIterator< TPixel, TContainer >::operator== | ( | const SliceIterator< TPixel, TContainer > & | orig | ) | [inline] |
Returns the logical && of the boolean == of two slice iterator positions, stride, and start locations.
Definition at line 96 of file itkSliceIterator.h.
TPixel& itk::SliceIterator< TPixel, TContainer >::operator[] | ( | unsigned long | n | ) | [inline] |
Returns the element at position n of the slice. Sets the iterator to point to position n.
Definition at line 86 of file itkSliceIterator.h.