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

Multi-dimensional image iterator which walks a region. More...

#include <itkImageRegionIterator.h>

Inheritance diagram for itk::ImageRegionIterator< TImage >:

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

[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
PixelType &	Value (void)
Self	Begin (void) const
Self	End (void) const
Protected Member Functions
	ImageRegionIterator (const ImageRegionConstIterator< TImage > &it)
Self &	operator= (const ImageRegionConstIterator< TImage > &it)

---

Detailed Description

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

Multi-dimensional image iterator which walks a region.

ImageRegionIterator is a templated class to represent a multi-dimensional iterator. 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->GetLargestPossibleRegion().

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

See also:

ImageRegionConstIterator

Definition at line 48 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 68 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 63 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 56 of file itkImageRegionIterator.h.

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

Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 57 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 66 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 60 of file itkImageRegionIterator.h.

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

Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 61 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 64 of file itkImageRegionIterator.h.

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

Reimplemented from itk::ImageRegionConstIterator< TImage >. Definition at line 65 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 67 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 62 of file itkImageRegionIterator.h.

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

Standard class typedefs. Reimplemented from itk::ImageRegionConstIterator< TImage >. Definition at line 52 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 58 of file itkImageRegionIterator.h.

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

Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 59 of file itkImageRegionIterator.h.

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

Reimplemented from itk::ImageRegionConstIterator< TImage >. Definition at line 53 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 87 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 93 of file itkImageRegionIterator.h. References itk::ImageRegionIterator< TImage >::PixelType.

---

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

• itkImageRegionIterator.h

---