#include <itkImageConstIterator.h>

Inheritance diagram for itk::ImageConstIterator< TImage >:

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.

Public Types
typedef TImage::AccessorFunctorType	AccessorFunctorType

typedef TImage::AccessorType	AccessorType

typedef TImage	ImageType

typedef TImage::IndexType	IndexType

typedef TImage::InternalPixelType	InternalPixelType

typedef TImage::OffsetType	OffsetType

typedef TImage::PixelContainer	PixelContainer

typedef PixelContainer::Pointer	PixelContainerPointer

typedef TImage::PixelType	PixelType

typedef TImage::RegionType	RegionType

typedef ImageConstIterator	Self

typedef TImage::SizeType	SizeType

Public Member Functions
	ImageConstIterator (const Self &it)

	itkTypeMacroNoParent (ImageConstIterator)

virtual	~ImageConstIterator ()


	ImageConstIterator ()

Static Public Attributes
static const unsigned int	ImageIteratorDimension = TImage::ImageDimension

TImage::ConstWeakPointer	m_Image

RegionType	m_Region

OffsetValueType	m_Offset

OffsetValueType	m_BeginOffset

OffsetValueType	m_EndOffset

const InternalPixelType *	m_Buffer

AccessorType	m_PixelAccessor

AccessorFunctorType	m_PixelAccessorFunctor

	ImageConstIterator (const ImageType *ptr, const RegionType &region)

Self &	operator= (const Self &it)

virtual void	SetRegion (const RegionType &region)

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

const IndexType	GetIndex () const

virtual void	SetIndex (const IndexType &ind)

const RegionType &	GetRegion () const

const ImageType *	GetImage () const

PixelType	Get (void) const

const PixelType &	Value (void) const

	itkLegacyMacro (Self Begin(void) const)

void	GoToBegin ()

	itkLegacyMacro (Self End(void) const)

void	GoToEnd ()

bool	IsAtBegin (void) const

bool	IsAtEnd (void) const

static unsigned int	GetImageIteratorDimension ()

Member Typedef Documentation

template<typename TImage>

typedef TImage::AccessorFunctorType itk::ImageConstIterator< TImage >::AccessorFunctorType

Definition at line 130 of file itkImageConstIterator.h.

template<typename TImage>

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

Accessor type that convert data between internal and external representations.

Definition at line 129 of file itkImageConstIterator.h.

template<typename TImage>

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

Image typedef support.

Definition at line 113 of file itkImageConstIterator.h.

template<typename TImage>

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

Index typedef support.

Definition at line 101 of file itkImageConstIterator.h.

template<typename TImage>

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

Internal Pixel Type

Definition at line 122 of file itkImageConstIterator.h.

template<typename TImage>

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

Offset typedef support.

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.

Definition at line 118 of file itkImageConstIterator.h.

template<typename TImage>

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

Definition at line 119 of file itkImageConstIterator.h.

template<typename TImage>

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

External Pixel Type

Definition at line 125 of file itkImageConstIterator.h.

template<typename TImage>

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

Region typedef support.

Definition at line 110 of file itkImageConstIterator.h.

template<typename TImage>

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

Standard class typedefs.

Definition at line 88 of file itkImageConstIterator.h.

template<typename TImage>

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

Size typedef support.

Definition at line 104 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 134 of file itkImageConstIterator.h.

template<typename TImage>

virtual itk::ImageConstIterator< TImage >::~ImageConstIterator ( )

inlinevirtual

Default Destructor.

Definition at line 149 of file itkImageConstIterator.h.

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 153 of file itkImageConstIterator.h.

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 170 of file itkImageConstIterator.h.

Member Function Documentation

template<typename TImage>

PixelType itk::ImageConstIterator< TImage >::Get ( void ) const

inline

Get the pixel value

Examples:: Examples/RegistrationITKv3/DeformableRegistration15.cxx, Examples/RegistrationITKv3/DeformableRegistration6.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, and WikiExamples/Developer/MultiThreadedImageFilter.cxx.

Definition at line 327 of file itkImageConstIterator.h.

Referenced by itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::TransformOutputPixel().

template<typename TImage>

const ImageType* itk::ImageConstIterator< TImage >::GetImage ( ) const

inline

Get the image that this iterator walks.

Definition at line 323 of file itkImageConstIterator.h.

Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), itk::ImageReverseConstIterator< TImage >::operator=(), itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::SetOutputPixel(), and itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::TransformOutputPixel().

template<typename TImage>

static unsigned int itk::ImageConstIterator< TImage >::GetImageIteratorDimension ( )

inlinestatic

Get the dimension (size) of the index.

Definition at line 244 of file itkImageConstIterator.h.

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 309 of file itkImageConstIterator.h.

Referenced by itk::ImageRegionConstIterator< ImageType >::ImageRegionConstIterator(), itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().

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 319 of file itkImageConstIterator.h.

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

template<typename TImage>

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

inline

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

Definition at line 344 of file itkImageConstIterator.h.

Referenced by itk::ImageScanlineConstIterator< TImage >::GoToBegin(), and itk::ImageRegionConstIterator< ImageType >::GoToBegin().

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.

Definition at line 357 of file itkImageConstIterator.h.

Referenced by itk::ImageScanlineConstIterator< TImage >::GoToEnd(), and itk::ImageRegionConstIterator< ImageType >::GoToEnd().

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 364 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 371 of file itkImageConstIterator.h.

template<typename TImage>

itk::ImageConstIterator< TImage >::itkLegacyMacro ( Self 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.

template<typename TImage>

itk::ImageConstIterator< TImage >::itkLegacyMacro ( Self 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.

template<typename TImage>

itk::ImageConstIterator< TImage >::itkTypeMacroNoParent ( ImageConstIterator< TImage > )

Run-time type information (and related methods).

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 250 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 278 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 268 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.

Definition at line 186 of file itkImageConstIterator.h.

Referenced by itk::ImageRegionConstIterator< ImageType >::ImageRegionConstIterator(), and itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator().

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 259 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 298 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 288 of file itkImageConstIterator.h.

template<typename TImage>

virtual void itk::ImageConstIterator< TImage >::SetIndex ( const IndexType & ind )

inlinevirtual

Set the index. No bounds checking is performed.

See Also: GetIndex

Reimplemented in itk::ImageRegionConstIterator< TImage >, itk::ImageRegionConstIterator< ImageType >, and itk::ImageScanlineConstIterator< TImage >.

Definition at line 314 of file itkImageConstIterator.h.

Referenced by itk::ImageScanlineConstIterator< TImage >::SetIndex(), and itk::ImageRegionConstIterator< ImageType >::SetIndex().

template<typename TImage>

virtual void itk::ImageConstIterator< TImage >::SetRegion ( const RegionType & region )

inlinevirtual

Set the region of the image to iterate over.

Definition at line 206 of file itkImageConstIterator.h.

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

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 333 of file itkImageConstIterator.h.

Member Data Documentation

template<typename TImage>

const unsigned int itk::ImageConstIterator< TImage >::ImageIteratorDimension = TImage::ImageDimension

static

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.

Definition at line 95 of file itkImageConstIterator.h.

template<typename TImage>

OffsetValueType itk::ImageConstIterator< TImage >::m_BeginOffset

protected

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

Definition at line 382 of file itkImageConstIterator.h.

Referenced by itk::ImageScanlineConstIterator< TImage >::GoToBegin(), itk::ImageRegionConstIterator< ImageType >::GoToBegin(), itk::ImageConstIterator< ImageType >::GoToBegin(), itk::ImageConstIterator< ImageType >::ImageConstIterator(), itk::ImageRegionConstIterator< ImageType >::ImageRegionConstIterator(), itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator(), itk::ImageConstIterator< ImageType >::IsAtBegin(), itk::ImageConstIterator< ImageType >::operator=(), and itk::ImageConstIterator< ImageType >::SetRegion().