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

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

Multi-dimensional image iterator. More...

#include <itkImageIteratorWithIndex.h>

Inheritance diagram for itk::ImageIteratorWithIndex:

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef ImageIteratorWithIndex Self
typedef ImageConstIteratorWithIndex<
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)
 ImageIteratorWithIndex ()
 ~ImageIteratorWithIndex ()
 ImageIteratorWithIndex (const Self &it)
 ImageIteratorWithIndex (TImage *ptr, const RegionType &region)
Selfoperator= (const Self &it)
void Set (const PixelType &value) const
PixelTypeValue (void)

Protected Methods

 ImageIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
Selfoperator= (const ImageConstIteratorWithIndex< TImage > &it)

Detailed Description

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

Multi-dimensional image iterator.

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

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

See also:
ImageConstIteratorWithIndex

Definition at line 43 of file itkImageIteratorWithIndex.h.


Member Typedef Documentation

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

Accessor type that convert data between internal and external representations.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 72 of file itkImageIteratorWithIndex.h.

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

Image typedef support.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 67 of file itkImageIteratorWithIndex.h.

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

Inherit types from the superclass

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 60 of file itkImageIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 61 of file itkImageIteratorWithIndex.h.

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

Internal Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 70 of file itkImageIteratorWithIndex.h.

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

Type of the Offset taken from the image

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 64 of file itkImageIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 65 of file itkImageIteratorWithIndex.h.

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

Definition at line 68 of file itkImageIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 69 of file itkImageIteratorWithIndex.h.

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

External Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 71 of file itkImageIteratorWithIndex.h.

Referenced by itk::ImageIteratorWithIndex< TImage >::~ImageIteratorWithIndex().

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

Region typedef support.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 66 of file itkImageIteratorWithIndex.h.

Referenced by itk::ImageIteratorWithIndex< TImage >::~ImageIteratorWithIndex().

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

Standard class typedefs.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 47 of file itkImageIteratorWithIndex.h.

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

Size typedef support.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 62 of file itkImageIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 63 of file itkImageIteratorWithIndex.h.

template<typename TImage>
typedef ImageConstIteratorWithIndex<TImage> itk::ImageIteratorWithIndex< TImage >::Superclass
 

Define the superclass

Definition at line 57 of file itkImageIteratorWithIndex.h.


Constructor & Destructor Documentation

template<typename TImage>
itk::ImageIteratorWithIndex< TImage >::ImageIteratorWithIndex  
 

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

template<typename TImage>
itk::ImageIteratorWithIndex< TImage >::~ImageIteratorWithIndex   [inline]
 

Default Destructor

Definition at line 80 of file itkImageIteratorWithIndex.h.

References itk::ImageIteratorWithIndex< TImage >::PixelType, and itk::ImageIteratorWithIndex< TImage >::RegionType.

template<typename TImage>
itk::ImageIteratorWithIndex< TImage >::ImageIteratorWithIndex 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::ImageIteratorWithIndex< TImage >::ImageIteratorWithIndex 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::ImageIteratorWithIndex< TImage >::ImageIteratorWithIndex const ImageConstIteratorWithIndex< TImage > &    it [protected]
 

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


Member Function Documentation

template<typename TImage>
itk::ImageIteratorWithIndex< 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::ImageConstIteratorWithIndex< TImage >.

template<typename TImage>
Self& itk::ImageIteratorWithIndex< TImage >::operator= const ImageConstIteratorWithIndex< TImage > &    it [protected]
 

template<typename TImage>
Self& itk::ImageIteratorWithIndex< TImage >::operator= const Self   it
 

operator= is provided to make sure the handle to the image is properly reference counted.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

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

Set the pixel value

Definition at line 96 of file itkImageIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_PixelAccessor, and itk::ImageConstIteratorWithIndex< TImage >::m_Position.

template<typename TImage>
PixelType& itk::ImageIteratorWithIndex< 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 itkImageIteratorWithIndex.h.


The documentation for this class was generated from the following file:
Generated at Wed Mar 12 01:17:16 2003 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000