ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Private Attributes
itk::ImageRegionExclusionConstIteratorWithIndex< TImage > Class Template Reference

A multi-dimensional image iterator that walks an image region, excluding a second region that may partially or completely overlap the first, with read-only access to pixels. More...

#include <itkImageRegionExclusionConstIteratorWithIndex.h>

Inheritance diagram for itk::ImageRegionExclusionConstIteratorWithIndex< TImage >:
Collaboration diagram for itk::ImageRegionExclusionConstIteratorWithIndex< TImage >:

List of all members.

Public Types

typedef Superclass::AccessorType AccessorType
typedef Superclass::ImageType ImageType
typedef Superclass::IndexType IndexType
typedef
Superclass::InternalPixelType 
InternalPixelType
typedef Superclass::OffsetType OffsetType
typedef Superclass::PixelContainer PixelContainer
typedef
Superclass::PixelContainerPointer 
PixelContainerPointer
typedef Superclass::PixelType PixelType
typedef Superclass::RegionType RegionType
typedef
ImageRegionExclusionConstIteratorWithIndex 
Self
typedef Superclass::SizeType SizeType
typedef
ImageRegionConstIteratorWithIndex
< TImage > 
Superclass

Public Member Functions

void GoToBegin (void)
void GoToReverseBegin (void)
 ImageRegionExclusionConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
 ImageRegionExclusionConstIteratorWithIndex ()
 ImageRegionExclusionConstIteratorWithIndex (const Superclass &it)
Selfoperator++ ()
Selfoperator-- ()
void SetExclusionRegion (const RegionType &region)
void SetExclusionRegionToInsetRegion ()

Private Attributes

IndexType m_ExclusionBegin
IndexType m_ExclusionEnd
RegionType m_ExclusionRegion

Detailed Description

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

A multi-dimensional image iterator that walks an image region, excluding a second region that may partially or completely overlap the first, with read-only access to pixels.

ImageRegionExclusionConstIteratorWithIndex is a class templated over the image type that represents a multi-dimensional iterator. The exclusion region is set after construction. By default the exclusion region is empty and the iterator will behave as the itk::ImageRegionConstIteratorWithIndex with a penalty in performance due to internal bounds checking. There are no restrictions on valid exclusion regions.

As with other ITK image iterators, ImageRegionExclusionConstIteratorWithIndex requires that 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.

The operator++ method 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:

  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;
  }
MORE INFORMATION
For a complete description of the ITK Image Iterators and their API, please see the Iterators chapter in the ITK Software Guide. The ITK Software Guide is available in print and as a free .pdf download from http://www.itk.org.
See also:
ImageConstIterator
ConditionalConstIterator
ConstNeighborhoodIterator
ConstShapedNeighborhoodIterator
ConstSliceIterator
CorrespondenceDataStructureIterator
FloodFilledFunctionConditionalConstIterator
FloodFilledImageFunctionConditionalConstIterator
FloodFilledImageFunctionConditionalIterator
FloodFilledSpatialFunctionConditionalConstIterator
FloodFilledSpatialFunctionConditionalIterator
ImageConstIterator
ImageConstIteratorWithIndex
ImageIterator
ImageIteratorWithIndex
ImageLinearConstIteratorWithIndex
ImageLinearIteratorWithIndex
ImageRandomConstIteratorWithIndex
ImageRandomIteratorWithIndex
ImageRegionConstIterator
ImageRegionConstIteratorWithIndex
ImageRegionExclusionConstIteratorWithIndex
ImageRegionExclusionIteratorWithIndex
ImageRegionIterator
ImageRegionIteratorWithIndex
ImageRegionReverseConstIterator
ImageRegionReverseIterator
ImageReverseConstIterator
ImageReverseIterator
ImageSliceConstIteratorWithIndex
ImageSliceIteratorWithIndex
NeighborhoodIterator
PathConstIterator
PathIterator
ShapedNeighborhoodIterator
SliceIterator
ImageConstIteratorWithIndex
Wiki Examples:

Definition at line 131 of file itkImageRegionExclusionConstIteratorWithIndex.h.


Member Typedef Documentation

Accessor type that converts data between internal and external representations.

Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRegionExclusionIteratorWithIndex< TImage >.

Definition at line 149 of file itkImageRegionExclusionConstIteratorWithIndex.h.

Types inherited from the Superclass

Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRegionExclusionIteratorWithIndex< TImage >.

Definition at line 140 of file itkImageRegionExclusionConstIteratorWithIndex.h.

Type of the Offset taken from the image

Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRegionExclusionIteratorWithIndex< TImage >.

Definition at line 142 of file itkImageRegionExclusionConstIteratorWithIndex.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::ImageRegionConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageRegionExclusionIteratorWithIndex< TImage >.

Definition at line 145 of file itkImageRegionExclusionConstIteratorWithIndex.h.


Constructor & Destructor Documentation

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>
itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::ImageRegionExclusionConstIteratorWithIndex ( const ImageType ptr,
const RegionType region 
)

Constructor establishes an iterator to walk a particular image and a particular region of that image.

Constructor that can be used to cast from an ImageRegionConstIteratorWithIndex 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.


Member Function Documentation

template<typename TImage>
void itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::GoToBegin ( void  )

Move an iterator to the beginning of the non-excluded region.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

template<typename TImage>
void itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::GoToReverseBegin ( void  )

Move an iterator to the End of the region.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

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)

Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >.

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)

Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >.

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 contained inside the normal region used to construct the iterator. A border of at least one pixel should exist between the normal region and the exclusion region.
template<typename TImage>
void itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::SetExclusionRegionToInsetRegion ( )

Set the exclusion region to be inset one pixel in from the region the iterator walks. This configures the iterator to only walk the pixels on the boundary of the region.


Member Data Documentation

template<typename TImage>
IndexType itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::m_ExclusionBegin [private]
template<typename TImage>
IndexType itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::m_ExclusionEnd [private]
template<typename TImage>
RegionType itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::m_ExclusionRegion [private]

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