#include <itkImageRegionConstIteratorWithIndex.h>
Inheritance diagram for itk::ImageRegionConstIteratorWithIndex:
Public Types | |
| typedef ImageRegionConstIteratorWithIndex | Self |
| typedef ImageConstIteratorWithIndex< TImage > | Superclass |
| typedef TImage::IndexType | IndexType |
| typedef TImage | ImageType |
| typedef TImage::PixelContainer | PixelContainer |
| typedef PixelContainer::Pointer | PixelContainerPointer |
| typedef TImage::RegionType | RegionType |
Public Methods | |
| ImageRegionConstIteratorWithIndex () | |
| ImageRegionConstIteratorWithIndex (const TImage *ptr, const RegionType ®ion) | |
| ImageRegionConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it) | |
| Self & | operator++ () |
| Self & | operator-- () |
ImageRegionConstIteratorWithIndex is a templated class to represent a multi-dimensional iterator. ImageRegionConstIteratorWithIndex is templated over the image type. ImageRegionConstIteratorWithIndex is constrained to walk only within the specified region.
ImageRegionConstIteratorWithIndex is a multi-dimensional iterator, requiring more information be specified before the iterator can be used than conventional iterators. Whereas the std::vector::iterator from the STL only needs to be passed a pointer to establish the iterator, the multi-dimensional image iterator needs a pointer, the size of the buffer, the size of the region, the start index of the buffer, and the start index of the region. To gain access to this information, ImageRegionConstIteratorWithIndex holds a reference to the image over which it is traversing.
ImageRegionConstIteratorWithIndex assumes a particular layout of the image data. The is arranged in a 1D array as if it were [][][][slice][row][col] with Index[0] = col, Index[1] = row, Index[2] = slice, etc.
operator++ provides a simple syntax for walking around a region of a multidimensional image. operator++ iterates across a row, constraining the movement to within a region of image. When the iterator reaches the boundary of the region along a row, the iterator automatically wraps to the next row, starting at the first pixel in the row that is part of the region. This allows for simple processing loops of the form:
\example itkImageIteratorTest \example itkIteratorTests \example itkIteratorsForwardBackwardsTest
IteratorType it( image, image->GetRequestedRegion() );
it.Begin();
while( it.IsNotAtEnd() )
{
it.Set( 100.0 + it.Get() );
++it;
}
It also can be used for walking in the reverse direction like
IteratorType it( image, image->GetRequestedRegion() );
it.End();
while( !it.IsAtBegin() )
{
it.Set( 100.0 );
--it;
}
Definition at line 91 of file itkImageRegionConstIteratorWithIndex.h.
|
|||||
|
Image typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Image back to itk::Image to that is it not confused with ImageIterator::Image. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRegionIteratorWithIndex< TImage >. Definition at line 108 of file itkImageRegionConstIteratorWithIndex.h. |
|
|||||
|
Index typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Index back to itk::Index to that is it not confused with ImageIterator::Index. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRegionIteratorWithIndex< TImage >. Definition at line 102 of file itkImageRegionConstIteratorWithIndex.h. |
|
|||||
|
PixelContainer typedef support. Used to refer to the container for the pixel data. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRegionIteratorWithIndex< TImage >. Definition at line 113 of file itkImageRegionConstIteratorWithIndex.h. |
|
|||||
|
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRegionIteratorWithIndex< TImage >. Definition at line 114 of file itkImageRegionConstIteratorWithIndex.h. |
|
|||||
|
Region typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Region back to itk::ImageRegion so that is it not confused with ImageIterator::Index. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRegionIteratorWithIndex< TImage >. Definition at line 120 of file itkImageRegionConstIteratorWithIndex.h. Referenced by itk::ImageRegionConstIteratorWithIndex< TImage >::ImageRegionConstIteratorWithIndex(). |
|
|||||
|
Standard class typedefs. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRegionIteratorWithIndex< TImage >. Definition at line 95 of file itkImageRegionConstIteratorWithIndex.h. |
|
|||||
|
Reimplemented in itk::ImageRegionIteratorWithIndex< TImage >. Definition at line 96 of file itkImageRegionConstIteratorWithIndex.h. |
|
|||||||||
|
Default constructor. Needed since we provide a cast constructor. Definition at line 123 of file itkImageRegionConstIteratorWithIndex.h. |
|
||||||||||||||||
|
Constructor establishes an iterator to walk a particular image and a particular region of that image. Definition at line 127 of file itkImageRegionConstIteratorWithIndex.h. References itk::ImageRegionConstIteratorWithIndex< TImage >::RegionType. |
|
||||||||||
|
Constructor that can be used to cast from an ImageIterator to an ImageRegionConstIteratorWithIndex. Many routines return an ImageIterator but for a particular task, you may want an ImageRegionConstIteratorWithIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRegionConstIteratorWithIndex. Definition at line 137 of file itkImageRegionConstIteratorWithIndex.h. |
|
|||||||||
|
Increment (prefix) the fastest moving dimension of the iterator's index. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the end of the row of the region to the beginning of the next row of the region) up until the iterator tries to moves past the last pixel of the region. Here, the iterator will be set to be one pixel past the end of the region.
|
|
|||||||||
|
Decrement (prefix) the fastest moving dimension of the iterator's index. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the beginning of the row of the region to the end of the previous row of the region) up until the iterator tries to moves past the first pixel of the region. Here, the iterator will be set to be one pixel past the beginning of the region.
|
1.2.15 written by Dimitri van Heesch,
© 1997-2000