Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

A multi-dimensional iterator templated over image type that walks a region of pixels. More...

#include <itkImageRegionIterator.h>

Inheritance diagram for itk::ImageRegionIterator< TImage >:

Inheritance graph
[legend]
Collaboration diagram for itk::ImageRegionIterator< TImage >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ImageRegionIterator Self
typedef ImageRegionConstIterator<
TImage
Superclass
typedef Superclass::IndexType IndexType
typedef Superclass::IndexValueType IndexValueType
typedef Superclass::SizeType SizeType
typedef Superclass::SizeValueType SizeValueType
typedef Superclass::OffsetType OffsetType
typedef Superclass::OffsetValueType OffsetValueType
typedef Superclass::RegionType RegionType
typedef Superclass::ImageType ImageType
typedef Superclass::PixelContainer PixelContainer
typedef Superclass::PixelContainerPointer PixelContainerPointer
typedef Superclass::InternalPixelType InternalPixelType
typedef Superclass::PixelType PixelType
typedef Superclass::AccessorType AccessorType

Public Member Functions

 ImageRegionIterator ()
 ImageRegionIterator (ImageType *ptr, const RegionType &region)
 ImageRegionIterator (const ImageIteratorWithIndex< TImage > &it)
void Set (const PixelType &value) const
PixelTypeValue (void)
Self Begin (void) const
Self End (void) const

Protected Member Functions

 ImageRegionIterator (const ImageRegionConstIterator< TImage > &it)
Selfoperator= (const ImageRegionConstIterator< TImage > &it)

Detailed Description

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

A multi-dimensional iterator templated over image type that walks a region of pixels.

The itk::ImageRegionIterator is optimized for iteration speed and is the first choice for iterative, pixel-wise operations on an image. ImageRegionIterator is the least specialized of the ITK image iterator classes. ImageRegionIterator is templated over the image type, and is constrained to walk only within the specified region and along a line parallel to one of the coordinate axes, "wrapping" to the next line as it reaches the boundary of the image. To walk the entire image, specify the region to be image->GetRequestedRegion().

Most of the functionality is inherited from the ImageRegionConstIterator. The current class only adds write access to image pixels.

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.
Iterators/ImageRegionIterator.cxx

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

Definition at line 73 of file itkImageRegionIterator.h.


Member Typedef Documentation

template<typename TImage>
typedef Superclass::AccessorType itk::ImageRegionIterator< TImage >::AccessorType
 

Accessor type that convert data between internal and external representations.

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 93 of file itkImageRegionIterator.h.

template<typename TImage>
typedef Superclass::ImageType itk::ImageRegionIterator< 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.

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 88 of file itkImageRegionIterator.h.

template<typename TImage>
typedef Superclass::IndexType itk::ImageRegionIterator< TImage >::IndexType
 

Types inherited from the Superclass

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 81 of file itkImageRegionIterator.h.

template<typename TImage>
typedef Superclass::IndexValueType itk::ImageRegionIterator< TImage >::IndexValueType
 

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 82 of file itkImageRegionIterator.h.

template<typename TImage>
typedef Superclass::InternalPixelType itk::ImageRegionIterator< TImage >::InternalPixelType
 

Internal Pixel Type

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 91 of file itkImageRegionIterator.h.

template<typename TImage>
typedef Superclass::OffsetType itk::ImageRegionIterator< TImage >::OffsetType
 

Offset typedef support.

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 85 of file itkImageRegionIterator.h.

template<typename TImage>
typedef Superclass::OffsetValueType itk::ImageRegionIterator< TImage >::OffsetValueType
 

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 86 of file itkImageRegionIterator.h.

template<typename TImage>
typedef Superclass::PixelContainer itk::ImageRegionIterator< 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::ImageRegionConstIterator< TImage >.

Definition at line 89 of file itkImageRegionIterator.h.

template<typename TImage>
typedef Superclass::PixelContainerPointer itk::ImageRegionIterator< TImage >::PixelContainerPointer
 

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 90 of file itkImageRegionIterator.h.

template<typename TImage>
typedef Superclass::PixelType itk::ImageRegionIterator< TImage >::PixelType
 

External Pixel Type

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 92 of file itkImageRegionIterator.h.

Referenced by itk::ImageRegionIterator< TImage >::Set(), and itk::ImageRegionIterator< TImage >::Value().

template<typename TImage>
typedef Superclass::RegionType itk::ImageRegionIterator< TImage >::RegionType
 

Region typedef support.

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 87 of file itkImageRegionIterator.h.

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

Standard class typedefs.

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 77 of file itkImageRegionIterator.h.

template<typename TImage>
typedef Superclass::SizeType itk::ImageRegionIterator< TImage >::SizeType
 

Size 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.

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 83 of file itkImageRegionIterator.h.

template<typename TImage>
typedef Superclass::SizeValueType itk::ImageRegionIterator< TImage >::SizeValueType
 

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 84 of file itkImageRegionIterator.h.

template<typename TImage>
typedef ImageRegionConstIterator<TImage> itk::ImageRegionIterator< TImage >::Superclass
 

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 78 of file itkImageRegionIterator.h.


Constructor & Destructor Documentation

template<typename TImage>
itk::ImageRegionIterator< TImage >::ImageRegionIterator  ) 
 

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>
itk::ImageRegionIterator< TImage >::ImageRegionIterator ImageType ptr,
const RegionType region
 

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

template<typename TImage>
itk::ImageRegionIterator< TImage >::ImageRegionIterator const ImageIteratorWithIndex< TImage > &  it  ) 
 

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

template<typename TImage>
itk::ImageRegionIterator< TImage >::ImageRegionIterator const ImageRegionConstIterator< TImage > &  it  )  [protected]
 

the construction from a const iterator is declared protected in order to enforce const correctness.


Member Function Documentation

template<typename TImage>
Self itk::ImageRegionIterator< TImage >::Begin void   )  const
 

Return an iterator for the beginning of the region. "Begin" is defined as the first pixel in the region.

Deprecated:
Use GoToBegin() instead

Reimplemented from itk::ImageRegionConstIterator< TImage >.

template<typename TImage>
Self itk::ImageRegionIterator< TImage >::End void   )  const
 

Return an iterator for the end of the region. "End" is defined as one pixel past the last pixel of the region.

Deprecated:
Use GoToEnd() instead

Reimplemented from itk::ImageRegionConstIterator< TImage >.

template<typename TImage>
Self& itk::ImageRegionIterator< TImage >::operator= const ImageRegionConstIterator< TImage > &  it  )  [protected]
 

the construction from a const iterator is declared protected in order to enforce const correctness.

template<typename TImage>
void itk::ImageRegionIterator< TImage >::Set const PixelType value  )  const [inline]
 

Set the pixel value

Definition at line 112 of file itkImageRegionIterator.h.

References itk::ImageRegionIterator< TImage >::PixelType.

template<typename TImage>
PixelType& itk::ImageRegionIterator< TImage >::Value void   )  [inline]
 

Return a reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.

Definition at line 121 of file itkImageRegionIterator.h.

References itk::ImageRegionIterator< TImage >::PixelType.


The documentation for this class was generated from the following file:
Generated at Thu May 25 01:20:37 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000