itk::ImageRegionExclusionConstIteratorWithIndex< TImage > Class Template Reference
[Image Iterators]

Multi-dimensional image iterator which walks a region excluding a second region completly contained in the first. More...

#include <itkImageRegionExclusionConstIteratorWithIndex.h>

Inheritance diagram for itk::ImageRegionExclusionConstIteratorWithIndex< TImage >:

[legend]Collaboration diagram for itk::ImageRegionExclusionConstIteratorWithIndex< TImage >:

[legend]List of all members.

Public Types
typedef ImageRegionExclusionConstIteratorWithIndex	Self
typedef ImageConstIteratorWithIndex< TImage >	Superclass
typedef TImage::IndexType	IndexType
typedef TImage::SizeType	SizeType
typedef TImage	ImageType
typedef TImage::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef TImage::RegionType	RegionType
Public Member Functions
	ImageRegionExclusionConstIteratorWithIndex ()
	ImageRegionExclusionConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
	ImageRegionExclusionConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
Self &	operator++ ()
Self &	operator-- ()
void	SetExclusionRegion (const RegionType &region)

---

Detailed Description

template<typename TImage>
class itk::ImageRegionExclusionConstIteratorWithIndex< TImage >

Multi-dimensional image iterator which walks a region excluding a second region completly contained in the first.

ImageRegionExclusionConstIteratorWithIndex is a templated class to represent a multi-dimensional iterator. ImageRegionExclusionConstIteratorWithIndex is templated over the image type. ImageRegionExclusionConstIteratorWithIndex is constrained to walk only within the specified region. The exclusion regions has to be set after construction. By default the exclusion region is empty and the iterator will behave as the itk::ImageRegionIteratorWithIndex with a penalty in performace due to internal extra checking.

ImageRegionExclusionConstIteratorWithIndex 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, ImageRegionExclusionConstIteratorWithIndex holds a reference to the image over which it is traversing.

ImageRegionExclusionConstIteratorWithIndex 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:

itkImageRegionExclusionConstIteratorWithIndex

  IteratorType it( image, image->GetRequestedRegion() );

  it.SetExclusionRegion( exclusionRegion );

  it.GoToBegin();

  while( ! it.IsAtEnd() ) 
  {  
    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.SetExclusionRegion( exclusionRegion );
  it.GoToEnd();

  while( !it.IsAtBegin() ) 
  {  
    it.Set( 100.0 );
    --it;
  }

Definition at line 96 of file itkImageRegionExclusionConstIteratorWithIndex.h.

---

Member Typedef Documentation

template<typename TImage> typedef TImage itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::ImageType

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::ImageRegionExclusionIteratorWithIndex< TImage >. Definition at line 114 of file itkImageRegionExclusionConstIteratorWithIndex.h.

template<typename TImage> typedef TImage::IndexType itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::IndexType

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::ImageRegionExclusionIteratorWithIndex< TImage >. Definition at line 107 of file itkImageRegionExclusionConstIteratorWithIndex.h.

template<typename TImage> typedef TImage::PixelContainer itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::PixelContainer

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::ImageRegionExclusionIteratorWithIndex< TImage >. Definition at line 119 of file itkImageRegionExclusionConstIteratorWithIndex.h.

template<typename TImage> typedef PixelContainer::Pointer itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::PixelContainerPointer

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRegionExclusionIteratorWithIndex< TImage >. Definition at line 120 of file itkImageRegionExclusionConstIteratorWithIndex.h.

template<typename TImage> typedef TImage::RegionType itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::RegionType

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::ImageRegionExclusionIteratorWithIndex< TImage >. Definition at line 126 of file itkImageRegionExclusionConstIteratorWithIndex.h. Referenced by itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::ImageRegionExclusionConstIteratorWithIndex().

template<typename TImage> typedef ImageRegionExclusionConstIteratorWithIndex itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::Self

Standard class typedefs. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRegionExclusionIteratorWithIndex< TImage >. Definition at line 100 of file itkImageRegionExclusionConstIteratorWithIndex.h.

template<typename TImage> typedef TImage::SizeType itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::SizeType

Size typedef support. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageRegionExclusionIteratorWithIndex< TImage >. Definition at line 108 of file itkImageRegionExclusionConstIteratorWithIndex.h.

template<typename TImage> typedef ImageConstIteratorWithIndex<TImage> itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::Superclass

Reimplemented in itk::ImageRegionExclusionIteratorWithIndex< TImage >. Definition at line 101 of file itkImageRegionExclusionConstIteratorWithIndex.h.

---

Constructor & Destructor Documentation

template<typename TImage> itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::ImageRegionExclusionConstIteratorWithIndex (   )  [inline]

Default constructor. Needed since we provide a cast constructor. Definition at line 129 of file itkImageRegionExclusionConstIteratorWithIndex.h.

template<typename TImage> itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::ImageRegionExclusionConstIteratorWithIndex (  const TImage *  ptr, const RegionType &  region )  [inline]

Constructor establishes an iterator to walk a particular image and a particular region of that image. Definition at line 133 of file itkImageRegionExclusionConstIteratorWithIndex.h. References itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::RegionType.

template<typename TImage> itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::ImageRegionExclusionConstIteratorWithIndex (  const ImageConstIteratorWithIndex< TImage > &  it  )  [inline]

Constructor that can be used to cast from an ImageIterator to an ImageRegionExclusionConstIteratorWithIndex. Many routines return an ImageIterator but for a particular task, you may want an ImageRegionExclusionConstIteratorWithIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRegionExclusionConstIteratorWithIndex. Definition at line 143 of file itkImageRegionExclusionConstIteratorWithIndex.h.

---

Member Function Documentation

template<typename TImage> Self& itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::operator++ (   )

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. See also: operator++(int)

template<typename TImage> Self& itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::operator-- (   )

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 next 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. See also: operator--(int)

template<typename TImage> void itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::SetExclusionRegion (  const RegionType &  region  )

Method to define the Exclusion region. The iterator will skip pixels inside this region. Warning: The exclusion region must be completly containe inside the normal region used to construct the iterator. A border of at least on pixels should exist between the normal region and the exclusion region.

---

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

• itkImageRegionExclusionConstIteratorWithIndex.h

---