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

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

#include <itkImageRegionConstIterator.h>

Inheritance diagram for itk::ImageRegionConstIterator< TImage >:

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

[legend]List of all members.

Public Types
typedef ImageRegionConstIterator	Self
typedef ImageConstIterator< TImage >	Superclass
typedef Superclass::IndexType	IndexType
typedef Superclass::SizeType	SizeType
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
	itkStaticConstMacro (ImageIteratorDimension, unsigned int, Superclass::ImageIteratorDimension)
virtual const char *	GetNameOfClass () const
	ImageRegionConstIterator ()
void	GoToBegin ()
void	GoToEnd ()
Self	Begin (void) const
Self	End (void) const
	ImageRegionConstIterator (const ImageType *ptr, const RegionType &region)
	ImageRegionConstIterator (const ImageIterator< TImage > &it)
	ImageRegionConstIterator (const ImageConstIterator< TImage > &it)
void	SetIndex (const IndexType &ind)
Self &	operator++ ()
Self &	operator-- ()
Protected Attributes
unsigned long	m_SpanBeginOffset
unsigned long	m_SpanEndOffset

---

Detailed Description

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

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

The itk::ImageRegionConstIterator 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. ImageRegionConstIterator 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().

ImageRegionConstIterator provides read-only access to image data. It is the base class for the read/write access ImageRegionIterator.

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

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

      it = it.Begin();
      for (; !it.IsAtEnd(); ++it)
         {
         *it += 100.0;
         }

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 108 of file itkImageRegionConstIterator.h.

---

Member Typedef Documentation

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

Accessor type that convert data between internal and external representations. Reimplemented from itk::ImageConstIterator< TImage >. Reimplemented in itk::ImageRegionIterator< TImage >. Definition at line 151 of file itkImageRegionConstIterator.h.

template<typename TImage> typedef Superclass::ImageType itk::ImageRegionConstIterator< 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::ImageConstIterator< TImage >. Reimplemented in itk::ImageRegionIterator< TImage >. Definition at line 135 of file itkImageRegionConstIterator.h. Referenced by itk::ImageRegionConstIterator< TImage >::ImageRegionConstIterator().

template<typename TImage> typedef Superclass::IndexType itk::ImageRegionConstIterator< 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. Reimplemented from itk::ImageConstIterator< TImage >. Reimplemented in itk::ImageRegionIterator< TImage >. Definition at line 124 of file itkImageRegionConstIterator.h. Referenced by itk::ImageRegionConstIterator< TImage >::ImageRegionConstIterator().

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

Internal Pixel Type Reimplemented from itk::ImageConstIterator< TImage >. Reimplemented in itk::ImageRegionIterator< TImage >. Definition at line 144 of file itkImageRegionConstIterator.h.

template<typename TImage> typedef Superclass::PixelContainer itk::ImageRegionConstIterator< 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::ImageConstIterator< TImage >. Reimplemented in itk::ImageRegionIterator< TImage >. Definition at line 140 of file itkImageRegionConstIterator.h.

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

Reimplemented from itk::ImageConstIterator< TImage >. Reimplemented in itk::ImageRegionIterator< TImage >. Definition at line 141 of file itkImageRegionConstIterator.h.

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

External Pixel Type Reimplemented from itk::ImageConstIterator< TImage >. Reimplemented in itk::ImageRegionIterator< TImage >. Definition at line 147 of file itkImageRegionConstIterator.h.

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

Region typedef support. Reimplemented from itk::ImageConstIterator< TImage >. Reimplemented in itk::ImageRegionIterator< TImage >. Definition at line 131 of file itkImageRegionConstIterator.h. Referenced by itk::ImageRegionConstIterator< TImage >::ImageRegionConstIterator().

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

Standard class typedef. Reimplemented from itk::ImageConstIterator< TImage >. Reimplemented in itk::ImageRegionIterator< TImage >. Definition at line 112 of file itkImageRegionConstIterator.h.

template<typename TImage> typedef Superclass::SizeType itk::ImageRegionConstIterator< 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::ImageConstIterator< TImage >. Reimplemented in itk::ImageRegionIterator< TImage >. Definition at line 128 of file itkImageRegionConstIterator.h.

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

Reimplemented in itk::ImageRegionIterator< TImage >. Definition at line 113 of file itkImageRegionConstIterator.h.

---

Constructor & Destructor Documentation

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

Default constructor. Needed since we provide a cast constructor. Definition at line 157 of file itkImageRegionConstIterator.h.

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

Constructor establishes an iterator to walk a particular image and a particular region of that image. Definition at line 165 of file itkImageRegionConstIterator.h. References itk::ImageRegionConstIterator< TImage >::ImageType, and itk::ImageRegionConstIterator< TImage >::RegionType.

template<typename TImage> itk::ImageRegionConstIterator< TImage >::ImageRegionConstIterator (  const ImageIterator< TImage > &  it  )  [inline]

Constructor that can be used to cast from an ImageIterator to an ImageRegionConstIterator. Many routines return an ImageIterator but for a particular task, you may want an ImageRegionConstIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRegionConstIterator. Definition at line 180 of file itkImageRegionConstIterator.h. References itk::ImageRegionConstIterator< TImage >::IndexType.

template<typename TImage> itk::ImageRegionConstIterator< TImage >::ImageRegionConstIterator (  const ImageConstIterator< TImage > &  it  )  [inline]

Constructor that can be used to cast from an ImageConstIterator to an ImageRegionConstIterator. Many routines return an ImageIterator but for a particular task, you may want an ImageRegionConstIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRegionConstIterator. Definition at line 197 of file itkImageRegionConstIterator.h. References itk::ImageRegionConstIterator< TImage >::IndexType.

---

Member Function Documentation

template<typename TImage> Self itk::ImageRegionConstIterator< 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::ImageConstIterator< TImage >. Reimplemented in itk::ImageRegionIterator< TImage >.

template<typename TImage> Self itk::ImageRegionConstIterator< 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::ImageConstIterator< TImage >. Reimplemented in itk::ImageRegionIterator< TImage >.

template<typename TImage> virtual const char* itk::ImageRegionConstIterator< TImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods).

template<typename TImage> void itk::ImageRegionConstIterator< TImage >::GoToBegin (  void   )  [inline]

Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region. Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 210 of file itkImageRegionConstIterator.h.

template<typename TImage> void itk::ImageRegionConstIterator< TImage >::GoToEnd (  void   )  [inline]

Move an iterator to the end of the region. "End" is defined as one pixel past the last pixel of the region. Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 222 of file itkImageRegionConstIterator.h.

template<typename TImage> itk::ImageRegionConstIterator< TImage >::itkStaticConstMacro (  ImageIteratorDimension  , unsigned  int, Superclass::ImageIteratorDimension  )

Dimension of the image the iterator walks. This constant is needed so functions that are templated over image iterator type (as opposed to being templated over pixel type and dimension) can have compile time access to the dimension of the image that the iterator walks.

template<typename TImage> Self& itk::ImageRegionConstIterator< TImage >::operator++ (   )  [inline]

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) Definition at line 263 of file itkImageRegionConstIterator.h.

template<typename TImage> Self& itk::ImageRegionConstIterator< TImage >::operator-- (   )  [inline]

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) Definition at line 280 of file itkImageRegionConstIterator.h.

template<typename TImage> void itk::ImageRegionConstIterator< TImage >::SetIndex (  const IndexType &  ind  )  [inline, virtual]

Set the index. No bounds checking is performed. This is overridden from the parent because we have an extra ivar. See also: GetIndex Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 246 of file itkImageRegionConstIterator.h.

---

Member Data Documentation

template<typename TImage> unsigned long itk::ImageRegionConstIterator< TImage >::m_SpanBeginOffset [protected]

Definition at line 295 of file itkImageRegionConstIterator.h.

template<typename TImage> unsigned long itk::ImageRegionConstIterator< TImage >::m_SpanEndOffset [protected]

Definition at line 296 of file itkImageRegionConstIterator.h.

---

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

• itkImageRegionConstIterator.h

---