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

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

Multi-dimensional image iterator. More...

#include <itkImageConstIteratorWithIndex.h>

Inheritance diagram for itk::ImageConstIteratorWithIndex:

[legend]List of all members.

Public Types
typedef ImageConstIteratorWithIndex	Self
typedef TImage::IndexType	IndexType
typedef IndexType::IndexValueType	IndexValueType
typedef TImage::SizeType	SizeType
typedef SizeType::SizeValueType	SizeValueType
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
typedef TImage::OffsetType	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
Public Methods
	itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension)
	ImageConstIteratorWithIndex ()
	ImageConstIteratorWithIndex (const Self &it)
	ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
Self &	operator= (const Self &it)
const IndexType	GetIndex ()
const RegionType &	GetRegion () const
PixelType	Get (void) const
const PixelType &	Value (void) const
Self	Begin (void) const
void	GoToBegin (void)
Self	End (void) const
void	GoToReverseBegin (void)
bool	IsAtReverseEnd (void) const
bool	IsAtEnd (void) const
bool	Remaining ()

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

void	SetIndex (const IndexType &ind)
Static Public Methods
unsigned int	GetImageDimension ()
Protected Attributes
TImage::ConstPointer	m_Image
IndexType	m_PositionIndex
IndexType	m_BeginIndex
IndexType	m_EndIndex
RegionType	m_Region
unsigned long	m_OffsetTable [ImageDimension+1]
const InternalPixelType *	m_Position
const InternalPixelType *	m_Begin
const InternalPixelType *	m_End
bool	m_Remaining
AccessorType	m_PixelAccessor

Detailed Description

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

Multi-dimensional image iterator.

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

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

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

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

Definition at line 58 of file itkImageConstIteratorWithIndex.h.

Member Typedef Documentation

template<typename TImage>

typedef IndexType::IndexValueType itk::ImageConstIteratorWithIndex< TImage >::IndexValueType

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, itk::ImageSliceIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >.
Definition at line 72 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::InternalPixelType itk::ImageConstIteratorWithIndex< TImage >::InternalPixelType

Internal Pixel Type
Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, itk::ImageSliceIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >.
Definition at line 91 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::OffsetType itk::ImageConstIteratorWithIndex< TImage >::OffsetType

Type of the Offset taken from the image
Reimplemented in itk::ReflectiveImageRegionConstIterator< TImage >, itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, itk::ImageSliceIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >.
Definition at line 101 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::PixelType itk::ImageConstIteratorWithIndex< TImage >::PixelType

External Pixel Type
Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, itk::ImageSliceIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >.
Definition at line 94 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::SizeType itk::ImageConstIteratorWithIndex< TImage >::SizeType

Size typedef support.
Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRegionExclusionConstIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, itk::ImageSliceIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >.
Definition at line 75 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef SizeType::SizeValueType itk::ImageConstIteratorWithIndex< TImage >::SizeValueType

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, itk::ImageSliceIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >.
Definition at line 76 of file itkImageConstIteratorWithIndex.h.

Constructor & Destructor Documentation

template<typename TImage>

itk::ImageConstIteratorWithIndex< TImage >::ImageConstIteratorWithIndex ( )

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

template<typename TImage>

itk::ImageConstIteratorWithIndex< TImage >::ImageConstIteratorWithIndex ( 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::ImageConstIteratorWithIndex< TImage >::ImageConstIteratorWithIndex ( const TImage * ptr,

const RegionType & region

)

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

Member Function Documentation

template<typename TImage>

Self itk::ImageConstIteratorWithIndex< TImage >::Begin ( void ) const

Move an iterator to the beginning of the region.
Deprecated:
Use GoToBegin() instead

template<typename TImage>

Self itk::ImageConstIteratorWithIndex< TImage >::End ( void ) const

Move an iterator to the End of the region.
Deprecated:
Use GoToReverseBegin() instead

template<typename TImage>

PixelType itk::ImageConstIteratorWithIndex< TImage >::Get ( void ) const [inline]

Get the pixel value
Definition at line 207 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

unsigned int itk::ImageConstIteratorWithIndex< TImage >::GetImageDimension ( ) [inline, static]

Get the dimension (size) of the index.
Definition at line 122 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

const IndexType itk::ImageConstIteratorWithIndex< TImage >::GetIndex ( void ) [inline]

Get the index. This provides a read only reference to the index.
See also:
SetIndex

Definition at line 191 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

const RegionType& itk::ImageConstIteratorWithIndex< TImage >::GetRegion ( ) const [inline]

Get the region that this iterator walks. ImageIterators know the beginning and the end of the region of the image to iterate over.
Definition at line 196 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

void itk::ImageConstIteratorWithIndex< TImage >::GoToBegin ( void )

Move an iterator to the beginning of the region.
Reimplemented in itk::ReflectiveImageRegionConstIterator< TImage >, and itk::ImageRandomConstIteratorWithIndex< TImage >.

template<typename TImage>

void itk::ImageConstIteratorWithIndex< TImage >::GoToReverseBegin ( void )

Move an iterator to the End of the region.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::IsAtEnd ( void ) const [inline]

Is the iterator at the end of the region?
Reimplemented in itk::ImageRandomConstIteratorWithIndex< TImage >.
Definition at line 237 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::IsAtReverseEnd ( void ) const [inline]

Is the iterator at the beginning of the region?
Definition at line 231 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

itk::ImageConstIteratorWithIndex< TImage >::itkStaticConstMacro ( ImageDimension ,

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::ImageIteratorWithIndex< TImage >.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< 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 128 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< 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 159 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< 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 148 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

Self& itk::ImageConstIteratorWithIndex< TImage >::operator= ( const Self & it )

operator= is provided to make sure the handle to the image is properly reference counted.
Reimplemented in itk::ReflectiveImageRegionConstIterator< TImage >, and itk::ImageIteratorWithIndex< TImage >.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< 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 138 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< 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 181 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< 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 170 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::Remaining ( ) [inline]

Are there data remainning in the region ?
Definition at line 243 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

void itk::ImageConstIteratorWithIndex< TImage >::SetIndex ( const IndexType & ind ) [inline]

Set the index. No bounds checking is performed.
See also:
GetIndex

Definition at line 201 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

const PixelType& itk::ImageConstIteratorWithIndex< 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 213 of file itkImageConstIteratorWithIndex.h.

Member Data Documentation

template<typename TImage>

const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_Begin [protected]

Definition at line 262 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

IndexType itk::ImageConstIteratorWithIndex< TImage >::m_BeginIndex [protected]

Definition at line 252 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_End [protected]

Definition at line 263 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

IndexType itk::ImageConstIteratorWithIndex< TImage >::m_EndIndex [protected]

Definition at line 253 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

TImage::ConstPointer itk::ImageConstIteratorWithIndex< TImage >::m_Image [protected]

Definition at line 249 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

unsigned long itk::ImageConstIteratorWithIndex< TImage >::m_OffsetTable[ ImageDimension + 1 ] [protected]

Definition at line 259 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

AccessorType itk::ImageConstIteratorWithIndex< TImage >::m_PixelAccessor [protected]

Definition at line 267 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_Position [protected]

Definition at line 261 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

IndexType itk::ImageConstIteratorWithIndex< TImage >::m_PositionIndex [protected]

Definition at line 251 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

RegionType itk::ImageConstIteratorWithIndex< TImage >::m_Region [protected]

Definition at line 257 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageConstIteratorWithIndex< TImage >::m_Remaining [protected]

Definition at line 265 of file itkImageConstIteratorWithIndex.h.

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

itkImageConstIteratorWithIndex.h

Generated at Tue Sep 16 11:35:58 2003 for ITK by

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

Public Types

Public Methods

Static Public Methods

Protected Attributes