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

Multi-dimensional image iterator. More...

#include <itkImageIterator.h>

Inheritance diagram for itk::ImageIterator:

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

[legend]List of all members.

Public Types
typedef ImageIterator	Self
typedef ImageConstIterator< 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 Methods
	itkStaticConstMacro (ImageIteratorDimension, unsigned int, TImage::ImageDimension)
	ImageIterator ()
	~ImageIterator ()
	ImageIterator (const Self &it)
	ImageIterator (TImage *ptr, const RegionType &region)
Self &	operator= (const Self &it)
void	Set (const PixelType &value) const
PixelType &	Value (void)
Self	Begin (void) const
Self	End (void) const
ImageType *	GetImage () const
Protected Methods
	ImageIterator (const ImageConstIterator< TImage > &it)
Self &	operator= (const ImageConstIterator< TImage > &it)

---

Detailed Description

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

Multi-dimensional image iterator.

ImageIterator is a templated class to represent a multi-dimensional iterator. ImageIterator is templated over the dimension of the image and the data type of the image.

Most of the ImageIterator functionality is inherited from its superclass the ImageConstIterator. This iterator only adds read/write access to image pixels.

See also:

ImageConstIterator

Definition at line 43 of file itkImageIterator.h.

---

Member Typedef Documentation

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

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

template<typename TImage> typedef Superclass::ImageType itk::ImageIterator< TImage >::ImageType

Image typedef support. Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 67 of file itkImageIterator.h.

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

Inherit types from the superclass Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 60 of file itkImageIterator.h.

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

Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 61 of file itkImageIterator.h.

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

Internal Pixel Type Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 70 of file itkImageIterator.h.

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

Offset typedef support. Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 64 of file itkImageIterator.h.

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

Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 65 of file itkImageIterator.h.

template<typename TImage> typedef Superclass::PixelContainer itk::ImageIterator< 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 >. Definition at line 68 of file itkImageIterator.h.

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

Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 69 of file itkImageIterator.h.

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

External Pixel Type Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 71 of file itkImageIterator.h. Referenced by itk::ImageIterator< TImage >::~ImageIterator().

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

Region typedef support. Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 66 of file itkImageIterator.h. Referenced by itk::ImageIterator< TImage >::~ImageIterator().

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

Standard class typedefs. Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 47 of file itkImageIterator.h.

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

Size typedef support. Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 62 of file itkImageIterator.h.

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

Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 63 of file itkImageIterator.h.

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

Define the superclass Definition at line 57 of file itkImageIterator.h.

---

Constructor & Destructor Documentation

template<typename TImage> itk::ImageIterator< TImage >::ImageIterator (    )

Default Constructor. Need to provide a default constructor since we provide a copy constructor.

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

Default Destructor Definition at line 80 of file itkImageIterator.h. References itk::ImageIterator< TImage >::PixelType, and itk::ImageIterator< TImage >::RegionType.

template<typename TImage> itk::ImageIterator< TImage >::ImageIterator (  const Self &    it )

Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted.

template<typename TImage> itk::ImageIterator< TImage >::ImageIterator (  TImage *    ptr, const RegionType &    region )

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

template<typename TImage> itk::ImageIterator< TImage >::ImageIterator (  const ImageConstIterator< TImage > &    it )  [protected]

This constructor is declared protected in order to enforce const-correctness

---

Member Function Documentation

template<typename TImage> Self itk::ImageIterator< 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 >.

template<typename TImage> Self itk::ImageIterator< 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 >.

template<typename TImage> ImageType* itk::ImageIterator< TImage >::GetImage (    )  const [inline]

Get the image that this iterator walks. Reimplemented from itk::ImageConstIterator< TImage >. Definition at line 116 of file itkImageIterator.h. References itk::SmartPointer< const ImageType >::GetPointer(), and itk::ImageConstIterator< TImage >::m_Image.

template<typename TImage> itk::ImageIterator< TImage >::itkStaticConstMacro (  ImageIteratorDimension   , unsigned    int, TImage::ImageDimension    )

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. Reimplemented from itk::ImageConstIterator< TImage >.

template<typename TImage> Self& itk::ImageIterator< TImage >::operator= (  const ImageConstIterator< TImage > &    it )  [protected]

template<typename TImage> Self& itk::ImageIterator< TImage >::operator= (  const Self &    it )

operator= is provided to make sure the handle to the image is properly reference counted. Reimplemented from itk::ImageConstIterator< TImage >.

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

Set the pixel value Definition at line 96 of file itkImageIterator.h. References itk::ImageConstIterator< TImage >::m_Buffer, itk::ImageConstIterator< TImage >::m_Offset, and itk::ImageConstIterator< TImage >::m_PixelAccessor.

template<typename TImage> PixelType& itk::ImageIterator< 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 102 of file itkImageIterator.h. References itk::ImageConstIterator< TImage >::m_Offset.

---

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

• itkImageIterator.h

---