#include <itkImageConstIteratorWithIndex.h>

Inheritance diagram for itk::ImageConstIteratorWithIndex< TImage >:

Detailed Description

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

A base class for multi-dimensional iterators templated over image type that are designed to efficiently keep track of the iterator position.

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

ImageConstIteratorWithIndex is a base class for the "WithIndex" family of ITK image iterators, which are designed to efficiently keep track of the image index position of the iterator during increment and decrement operations. This iterator is a base class and provides only the basic construction and comparison operations. 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.

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 92 of file itkImageConstIteratorWithIndex.h.

Public Types
typedef TImage::AccessorFunctorType	AccessorFunctorType

typedef TImage::AccessorType	AccessorType

typedef TImage	ImageType

typedef TImage::IndexType	IndexType

typedef IndexType::IndexValueType	IndexValueType

typedef TImage::InternalPixelType	InternalPixelType

typedef TImage::OffsetType	OffsetType

typedef OffsetType::OffsetValueType	OffsetValueType

typedef TImage::PixelContainer	PixelContainer

typedef PixelContainer::Pointer	PixelContainerPointer

typedef TImage::PixelType	PixelType

typedef TImage::RegionType	RegionType

typedef ImageConstIteratorWithIndex	Self

typedef TImage::SizeType	SizeType

typedef SizeType::SizeValueType	SizeValueType

Public Member Functions
PixelType	Get (void) const

const IndexType &	GetIndex () const

const RegionType &	GetRegion () const

void	GoToBegin (void)

void	GoToReverseBegin (void)

	ImageConstIteratorWithIndex ()

	ImageConstIteratorWithIndex (const Self &it)

	ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)

bool	IsAtEnd (void) const

bool	IsAtReverseEnd (void) const

	itkLegacyMacro (Self Begin(void) const)

	itkLegacyMacro (Self End(void) const)

bool	operator!= (const Self &it) const

bool	operator< (const Self &it) const

bool	operator<= (const Self &it) const

Self &	operator= (const Self &it)

bool	operator== (const Self &it) const

bool	operator> (const Self &it) const

bool	operator>= (const Self &it) const

bool	Remaining ()

const PixelType &	Value (void) const

virtual	~ImageConstIteratorWithIndex ()


void	SetIndex (const IndexType &ind)

Static Public Member Functions
static unsigned int	GetImageDimension ()

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

Protected Attributes
const InternalPixelType *	m_Begin

IndexType	m_BeginIndex

const InternalPixelType *	m_End

IndexType	m_EndIndex

TImage::ConstWeakPointer	m_Image

OffsetValueType	m_OffsetTable [ImageDimension+1]

AccessorType	m_PixelAccessor

AccessorFunctorType	m_PixelAccessorFunctor

const InternalPixelType *	m_Position

IndexType	m_PositionIndex

RegionType	m_Region

bool	m_Remaining

Member Typedef Documentation

template<typename TImage>

typedef TImage::AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::AccessorFunctorType

Definition at line 133 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::AccessorType itk::ImageConstIteratorWithIndex< TImage >::AccessorType

Accessor type that converts data between internal and external representations.

Definition at line 132 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage itk::ImageConstIteratorWithIndex< TImage >::ImageType

Image typedef support.

Definition at line 116 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

Index typedef support.

Definition at line 105 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 106 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

Internal Pixel Type

Definition at line 125 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

Type of the Offset taken from the image

Definition at line 136 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 137 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::PixelContainer itk::ImageConstIteratorWithIndex< 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 121 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 122 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

External Pixel Type

Definition at line 128 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef TImage::RegionType itk::ImageConstIteratorWithIndex< TImage >::RegionType

Region typedef support.

Definition at line 113 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

typedef ImageConstIteratorWithIndex itk::ImageConstIteratorWithIndex< TImage >::Self

Standard class typedefs.

Definition at line 96 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

Size typedef support.

Definition at line 109 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 110 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.

template<typename TImage>

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

inlinevirtual

Default Destructor.

Definition at line 153 of file itkImageConstIteratorWithIndex.h.

Member Function Documentation

template<typename TImage>

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

inline

Get the pixel value

Definition at line 247 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

static unsigned int itk::ImageConstIteratorWithIndex< TImage >::GetImageDimension ( )

inlinestatic

Get the dimension (size) of the index.

Definition at line 160 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

const IndexType& itk::ImageConstIteratorWithIndex< TImage >::GetIndex ( void ) const

inline

Get the index. This provides a read only reference to the index.

See Also: SetIndex

Definition at line 225 of file itkImageConstIteratorWithIndex.h.

Referenced by itk::ConstrainedRegionBasedLevelSetFunctionSharedData< TInputImage, TFeatureImage, TSingleData >::PopulateListImage().

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 232 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

Move an iterator to the beginning of the region.

Examples:: itkVectorImageTest.cxx.

Referenced by itk::ConstrainedRegionBasedLevelSetFunctionSharedData< TInputImage, TFeatureImage, TSingleData >::PopulateListImage(), and itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetBinaryMask().

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?

Definition at line 281 of file itkImageConstIteratorWithIndex.h.

Referenced by itk::ConstrainedRegionBasedLevelSetFunctionSharedData< TInputImage, TFeatureImage, TSingleData >::PopulateListImage().

template<typename TImage>

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

inline

Is the iterator at the beginning of the region?

Definition at line 275 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

Move an iterator to the beginning of the region.

Deprecated:: Use GoToBegin() instead

template<typename TImage>

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

Move an iterator to the End of the region.

Deprecated:: Use GoToReverseBegin() instead

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 168 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 196 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 186 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.

Referenced by itk::ImageLinearConstIteratorWithIndex< TImageType >::ImageLinearConstIteratorWithIndex(), itk::ImageRandomConstIteratorWithIndex< TImage >::ImageRandomConstIteratorWithIndex(), itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >::ImageRandomNonRepeatingConstIteratorWithIndex(), itk::ImageRegionConstIteratorWithIndex< TImage >::ImageRegionConstIteratorWithIndex(), and itk::ImageSliceConstIteratorWithIndex< TImage >::ImageSliceConstIteratorWithIndex().

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 177 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 216 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 206 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

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

inline

Are there data remaining in the region ?

Definition at line 287 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 239 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 255 of file itkImageConstIteratorWithIndex.h.

Member Data Documentation

template<typename TImage>

const unsigned int itk::ImageConstIteratorWithIndex< TImage >::ImageDimension = TImage::ImageDimension

static

Dimension of the image that 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 102 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_Begin

protected

Definition at line 306 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

IndexType itk::ImageConstIteratorWithIndex< TImage >::m_BeginIndex

protected

Definition at line 296 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>

const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_End

protected