itk::ImageIteratorWithIndex< TImage > Class Template Reference

#include <itkImageIteratorWithIndex.h>

Inheritance diagram for itk::ImageIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageIteratorWithIndex< TImage >:

Detailed Description

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

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

This class inherits from ImageConstIteratorWithIndex and only adds write-access functionality. See ImageConstIteratorWithIndex for more information.

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

ImageConstIteratorWithIndex

Definition at line 68 of file itkImageIteratorWithIndex.h.

Public Types
typedef Superclass::AccessorType	AccessorType
typedef Superclass::ImageType	ImageType
typedef Superclass::IndexType	IndexType
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::PixelContainer	PixelContainer
typedef Superclass::PixelContainerPointer	PixelContainerPointer
typedef Superclass::PixelType	PixelType
typedef Superclass::RegionType	RegionType
typedef ImageIteratorWithIndex	Self
typedef Superclass::SizeType	SizeType
typedef ImageConstIteratorWithIndex < TImage >	Superclass
Public Types inherited from itk::ImageConstIteratorWithIndex< TImage >
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
	ImageIteratorWithIndex ()
	ImageIteratorWithIndex (const Self &it)
	ImageIteratorWithIndex (TImage *ptr, const RegionType &region)
Self &	operator= (const Self &it)
void	Set (const PixelType &value) const
PixelType &	Value (void)
	~ImageIteratorWithIndex ()
Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
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 Attributes
static const unsigned int	ImageIteratorDimension = TImage::ImageDimension
Static Public Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
static const unsigned int	ImageDimension = TImage::ImageDimension

Protected Member Functions
	ImageIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
Self &	operator= (const ImageConstIteratorWithIndex< TImage > &it)

Additional Inherited Members
Static Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
static unsigned int	GetImageDimension ()
Protected Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
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 Superclass::AccessorType itk::ImageIteratorWithIndex< TImage >::AccessorType

Definition at line 95 of file itkImageIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 90 of file itkImageIteratorWithIndex.h.

template<typename TImage>

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

Inherit types from the superclass

Definition at line 86 of file itkImageIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 93 of file itkImageIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 88 of file itkImageIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::PixelContainer itk::ImageIteratorWithIndex< TImage >::PixelContainer

Definition at line 91 of file itkImageIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 92 of file itkImageIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 94 of file itkImageIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 89 of file itkImageIteratorWithIndex.h.

template<typename TImage>

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

Standard class typedefs.

Definition at line 73 of file itkImageIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 87 of file itkImageIteratorWithIndex.h.

template<typename TImage>

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

Define the superclass

Definition at line 83 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 102 of file itkImageIteratorWithIndex.h.

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>

Self& itk::ImageIteratorWithIndex< TImage >::operator=

(

const Self &

it

)

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

template<typename TImage>

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

protected

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

template<typename TImage>

void itk::ImageIteratorWithIndex< TImage >::Set ( const PixelType &  value ) const

inline

Set the pixel value

Definition at line 117 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 123 of file itkImageIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_Position.

Member Data Documentation

template<typename TImage>

const unsigned int itk::ImageIteratorWithIndex< TImage >::ImageIteratorDimension = 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 80 of file itkImageIteratorWithIndex.h.

---

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

• itkImageIteratorWithIndex.h