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

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

A multi-dimensional image iterator templated over image type. More...

#include <itkImageConstIterator.h>

Inheritance diagram for itk::ImageConstIterator< TImage >:

Inheritance graph
[legend]
List of all members.

[NOHEADER]

 ImageConstIterator (const ImageType *ptr, const RegionType &region)
Selfoperator= (const Self &it)
unsigned int GetImageIteratorDimension ()

Public Types

typedef ImageConstIterator Self
typedef TImage::IndexType IndexType
typedef TImage::IndexValueType IndexValueType
typedef TImage::SizeType SizeType
typedef TImage::SizeValueType SizeValueType
typedef TImage::OffsetType OffsetType
typedef TImage::OffsetValueType OffsetValueType
typedef TImage::RegionType RegionType
typedef TImage ImageType
typedef TImage::PixelContainer PixelContainer
typedef PixelContainer::Pointer PixelContainerPointer
typedef TImage::InternalPixelType InternalPixelType
typedef TImage::PixelType PixelType
typedef TImage::AccessorType AccessorType

Public Member Functions

 itkStaticConstMacro (ImageIteratorDimension, unsigned int, TImage::ImageDimension)
virtual ~ImageConstIterator ()
 ImageConstIterator (const Self &it)
const IndexType GetIndex () const
virtual void SetIndex (const IndexType &ind)
const RegionTypeGetRegion () const
const ImageTypeGetImage () const
PixelType Get (void) const
const PixelTypeValue (void) const
Self Begin (void) const
void GoToBegin ()
Self End (void) const
void GoToEnd ()
bool IsAtBegin (void) const
bool IsAtEnd (void) const
 ImageConstIterator ()
bool operator!= (const Self &it) const
bool operator== (const Self &it) const
bool operator<= (const Self &it) const
bool operator< (const Self &it) const
bool operator>= (const Self &it) const
bool operator> (const Self &it) const

Protected Attributes

TImage::ConstWeakPointer m_Image
RegionType m_Region
unsigned long m_Offset
unsigned long m_BeginOffset
unsigned long m_EndOffset
const InternalPixelTypem_Buffer
AccessorType m_PixelAccessor

Detailed Description

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

A multi-dimensional image iterator templated over image type.

ImageConstIterator is a templated class to represent a multi-dimensional iterator. ImageConstIterator is templated over the type of the image to be iterated over.

ImageConstIterator is a base class for all the image iterators. It provides the basic construction and comparison operations. However, it does not provide mechanisms for moving the iterator. A subclass of ImageConstIterator must be used to move the iterator.

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

ImageConstIterator assumes a particular layout of the image data. In particular, the data is arranged in a 1D array as if it were [][][][slice][row][col] with Index[0] = col, Index[1] = row, Index[2] = slice, etc.

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

Definition at line 84 of file itkImageConstIterator.h.


Member Typedef Documentation

template<typename TImage>
typedef TImage::AccessorType itk::ImageConstIterator< TImage >::AccessorType
 

Accessor type that convert data between internal and external representations.

Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 129 of file itkImageConstIterator.h.

template<typename TImage>
typedef TImage itk::ImageConstIterator< TImage >::ImageType
 

Image typedef support.

Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 113 of file itkImageConstIterator.h.

template<typename TImage>
typedef TImage::IndexType itk::ImageConstIterator< TImage >::IndexType
 

Index typedef support.

Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 98 of file itkImageConstIterator.h.

template<typename TImage>
typedef TImage::IndexValueType itk::ImageConstIterator< TImage >::IndexValueType
 

Reimplemented in itk::ImageIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 99 of file itkImageConstIterator.h.

template<typename TImage>
typedef TImage::InternalPixelType itk::ImageConstIterator< TImage >::InternalPixelType
 

Internal Pixel Type

Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 122 of file itkImageConstIterator.h.

template<typename TImage>
typedef TImage::OffsetType itk::ImageConstIterator< TImage >::OffsetType
 

Offset typedef support.

Reimplemented in itk::ImageIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 106 of file itkImageConstIterator.h.

template<typename TImage>
typedef TImage::OffsetValueType itk::ImageConstIterator< TImage >::OffsetValueType
 

Reimplemented in itk::ImageIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 107 of file itkImageConstIterator.h.

template<typename TImage>
typedef TImage::PixelContainer itk::ImageConstIterator< 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 in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 118 of file itkImageConstIterator.h.

template<typename TImage>
typedef PixelContainer::Pointer itk::ImageConstIterator< TImage >::PixelContainerPointer
 

Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 119 of file itkImageConstIterator.h.

template<typename TImage>
typedef TImage::PixelType itk::ImageConstIterator< TImage >::PixelType
 

External Pixel Type

Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 125 of file itkImageConstIterator.h.

template<typename TImage>
typedef TImage::RegionType itk::ImageConstIterator< TImage >::RegionType
 

Region typedef support.

Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 110 of file itkImageConstIterator.h.

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

Standard class typedefs.

Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 88 of file itkImageConstIterator.h.

Referenced by itk::ImageConstIterator< TImage >::Get(), itk::ImageConstIterator< TImage >::GetImageIteratorDimension(), itk::ImageConstIterator< TImage >::operator>=(), and itk::ImageConstIterator< TImage >::~ImageConstIterator().

template<typename TImage>
typedef TImage::SizeType itk::ImageConstIterator< TImage >::SizeType
 

Size typedef support.

Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 102 of file itkImageConstIterator.h.

template<typename TImage>
typedef TImage::SizeValueType itk::ImageConstIterator< TImage >::SizeValueType
 

Reimplemented in itk::ImageIterator< TImage >, and itk::ImageRegionIterator< TImage >.

Definition at line 103 of file itkImageConstIterator.h.


Constructor & Destructor Documentation

template<typename TImage>
itk::ImageConstIterator< TImage >::ImageConstIterator  )  [inline]
 

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

Definition at line 133 of file itkImageConstIterator.h.

template<typename TImage>
virtual itk::ImageConstIterator< TImage >::~ImageConstIterator  )  [inline, virtual]
 

Default Destructor.

Definition at line 146 of file itkImageConstIterator.h.

References itk::ImageConstIterator< TImage >::Self.

template<typename TImage>
itk::ImageConstIterator< TImage >::ImageConstIterator const Self it  )  [inline]
 

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

Definition at line 150 of file itkImageConstIterator.h.

References itk::ImageConstIterator< TImage >::m_BeginOffset, itk::ImageConstIterator< TImage >::m_Buffer, itk::ImageConstIterator< TImage >::m_EndOffset, itk::ImageConstIterator< TImage >::m_Image, itk::ImageConstIterator< TImage >::m_Offset, itk::ImageConstIterator< TImage >::m_PixelAccessor, and itk::ImageConstIterator< TImage >::m_Region.

template<typename TImage>
itk::ImageConstIterator< TImage >::ImageConstIterator 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 itkImageConstIterator.h.


Member Function Documentation

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

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

template<typename TImage>
PixelType itk::ImageConstIterator< TImage >::Get void   )  const [inline]
 

Get the pixel value

Definition at line 307 of file itkImageConstIterator.h.

References itk::ImageConstIterator< TImage >::Self.

Referenced by itk::ImageConstIterator< TImage >::GetRegion(), and itk::ImageReverseConstIterator< TImage >::SetIndex().

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

Get the image that this iterator walks.

Reimplemented in itk::ImageIterator< TImage >.

Definition at line 303 of file itkImageConstIterator.h.

template<typename TImage>
unsigned int itk::ImageConstIterator< TImage >::GetImageIteratorDimension  )  [inline, static]
 

Get the dimension (size) of the index.

Definition at line 218 of file itkImageConstIterator.h.

References itk::ImageConstIterator< TImage >::Self.

template<typename TImage>
const IndexType itk::ImageConstIterator< TImage >::GetIndex void   )  const [inline]
 

Get the index. This provides a read only reference to the index. This causes the index to be calculated from pointer arithmetic and is therefore an expensive operation.

See also:
SetIndex

Definition at line 289 of file itkImageConstIterator.h.

Referenced by itk::ImageRegionConstIterator< TImage >::ImageRegionConstIterator().

template<typename TImage>
const RegionType& itk::ImageConstIterator< TImage >::GetRegion  )  const [inline]
 

Get the region that this iterator walks. ImageConstIterators know the beginning and the end of the region of the image to iterate over.

Definition at line 299 of file itkImageConstIterator.h.

References itk::ImageConstIterator< TImage >::Get().

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

Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region.

Reimplemented in itk::ImageRegionConstIterator< TImage >.

Definition at line 324 of file itkImageConstIterator.h.

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

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

Reimplemented in itk::ImageRegionConstIterator< TImage >.

Definition at line 337 of file itkImageConstIterator.h.

template<typename TImage>
bool itk::ImageConstIterator< TImage >::IsAtBegin void   )  const [inline]
 

Is the iterator at the beginning of the region? "Begin" is defined as the first pixel in the region.

Definition at line 344 of file itkImageConstIterator.h.

template<typename TImage>
bool itk::ImageConstIterator< TImage >::IsAtEnd void   )  const [inline]
 

Is the iterator at the end of the region? "End" is defined as one pixel past the last pixel of the region.

Definition at line 351 of file itkImageConstIterator.h.

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

template<typename TImage>
bool itk::ImageConstIterator< TImage >::operator!= const Self it  )  const [inline]
 

Comparison operator. Two iterators are the same if they "point to" the same memory location

Definition at line 224 of file itkImageConstIterator.h.

template<typename TImage>
bool itk::ImageConstIterator< TImage >::operator< const Self it  )  const [inline]
 

Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.

Definition at line 255 of file itkImageConstIterator.h.

template<typename TImage>
bool itk::ImageConstIterator< TImage >::operator<= const Self it  )  const [inline]
 

Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.

Definition at line 244 of file itkImageConstIterator.h.

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

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

Reimplemented in itk::ImageIterator< TImage >.

Definition at line 203 of file itkImageConstIterator.h.

template<typename TImage>
bool itk::ImageConstIterator< TImage >::operator== const Self it  )  const [inline]
 

Comparison operator. Two iterators are the same if they "point to" the same memory location

Definition at line 234 of file itkImageConstIterator.h.

template<typename TImage>
bool itk::ImageConstIterator< TImage >::operator> const Self it  )  const [inline]
 

Comparison operator. An iterator is "greater than" another if it "points to" a higher location.

Definition at line 277 of file itkImageConstIterator.h.

template<typename TImage>
bool itk::ImageConstIterator< TImage >::operator>= const Self it  )  const [inline]
 

Comparison operator. An iterator is "greater than" another if it "points to" a higher location.

Definition at line 266 of file itkImageConstIterator.h.

References itk::ImageConstIterator< TImage >::m_Buffer, itk::ImageConstIterator< TImage >::m_Offset, and itk::ImageConstIterator< TImage >::Self.

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

Set the index. No bounds checking is performed.

See also:
GetIndex

Reimplemented in itk::ImageRegionConstIterator< TImage >.

Definition at line 294 of file itkImageConstIterator.h.

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

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

Definition at line 313 of file itkImageConstIterator.h.


Member Data Documentation

template<typename TImage>
unsigned long itk::ImageConstIterator< TImage >::m_BeginOffset [protected]
 

Definition at line 362 of file itkImageConstIterator.h.

Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator().

template<typename TImage>
const InternalPixelType* itk::ImageConstIterator< TImage >::m_Buffer [protected]
 

Definition at line 365 of file itkImageConstIterator.h.

Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator(), and itk::ImageConstIterator< TImage >::operator>=().

template<typename TImage>
unsigned long itk::ImageConstIterator< TImage >::m_EndOffset [protected]
 

Definition at line 363 of file itkImageConstIterator.h.

Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator().

template<typename TImage>
TImage::ConstWeakPointer itk::ImageConstIterator< TImage >::m_Image [protected]
 

Definition at line 358 of file itkImageConstIterator.h.

Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator().

template<typename TImage>
unsigned long itk::ImageConstIterator< TImage >::m_Offset [protected]
 

Definition at line 361 of file itkImageConstIterator.h.

Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator(), and itk::ImageConstIterator< TImage >::operator>=().

template<typename TImage>
AccessorType itk::ImageConstIterator< TImage >::m_PixelAccessor [protected]
 

Definition at line 367 of file itkImageConstIterator.h.

Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator().

template<typename TImage>
RegionType itk::ImageConstIterator< TImage >::m_Region [protected]
 

Definition at line 359 of file itkImageConstIterator.h.

Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator().


The documentation for this class was generated from the following file:
Generated at Wed Mar 30 01:01:44 2005 for ITK by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2000