itk::ImageIterator< TImage > Class Template Reference

#include <itkImageIterator.h>

Inheritance diagram for itk::ImageIterator< TImage >:

Collaboration diagram for itk::ImageIterator< TImage >:

Detailed Description

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

A multi-dimensional iterator templated over image type.

This is a base class of ImageConstIterator that adds write-access functionality. Please see ImageConstIterator 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 https://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

Read-write access. Specialized for RLEImage.

Definition at line 65 of file itkImageIterator.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 ImageIterator	Self
typedef Superclass::SizeType	SizeType
typedef ImageConstIterator < TImage >	Superclass
Public Types inherited from itk::ImageConstIterator< TImage >
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
ImageType *	GetImage () const
	ImageIterator ()
	ImageIterator (const Self &it)
	ImageIterator (TImage *ptr, const RegionType &region)
	itkLegacyMacro (Self Begin(void) const)
	itkLegacyMacro (Self End(void) const)
Self &	operator= (const Self &it)
void	Set (const PixelType &value) const
PixelType &	Value (void)
	~ImageIterator ()
Public Member Functions inherited from itk::ImageConstIterator< TImage >
	ImageConstIterator (const Self &it)
	itkTypeMacroNoParent (ImageConstIterator)
virtual	~ImageConstIterator ()
	ImageConstIterator ()
	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 Public Attributes
static const unsigned int	ImageIteratorDimension = TImage::ImageDimension
Static Public Attributes inherited from itk::ImageConstIterator< TImage >
static const unsigned int	ImageIteratorDimension = TImage::ImageDimension

Protected Member Functions
	ImageIterator (const ImageConstIterator< TImage > &it)
Self &	operator= (const ImageConstIterator< TImage > &it)

Member Typedef Documentation

template<typename TImage>

typedef Superclass::AccessorType itk::ImageIterator< TImage >::AccessorType

Definition at line 92 of file itkImageIterator.h.

template<typename TImage>

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

Definition at line 87 of file itkImageIterator.h.

template<typename TImage>

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

Inherit types from the superclass

Definition at line 83 of file itkImageIterator.h.

template<typename TImage>

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

Definition at line 90 of file itkImageIterator.h.

template<typename TImage>

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

Definition at line 85 of file itkImageIterator.h.

template<typename TImage>

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

Definition at line 88 of file itkImageIterator.h.

template<typename TImage>

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

Definition at line 89 of file itkImageIterator.h.

template<typename TImage>

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

Definition at line 91 of file itkImageIterator.h.

template<typename TImage>

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

Definition at line 86 of file itkImageIterator.h.

template<typename TImage>

typedef ImageIterator itk::ImageIterator< TImage >::Self

Standard class typedefs.

Definition at line 70 of file itkImageIterator.h.

template<typename TImage>

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

Definition at line 84 of file itkImageIterator.h.

template<typename TImage>

typedef ImageConstIterator< TImage > itk::ImageIterator< TImage >::Superclass

Define the superclass

Definition at line 80 of file itkImageIterator.h.

Constructor & Destructor Documentation

template<typename TImage>

itk::ImageIterator< TImage >::ImageIterator

(

)

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

template<typename TImage>

itk::ImageIterator< TImage >::~ImageIterator ( )

inline

Default Destructor

Definition at line 99 of file itkImageIterator.h.

template<typename TImage>

itk::ImageIterator< TImage >::ImageIterator

(

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::ImageIterator< TImage >::ImageIterator	(	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::ImageIterator< TImage >::ImageIterator ( const ImageConstIterator< TImage > &  it )

protected

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

Member Function Documentation

template<typename TImage>

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

inline

Get the image that this iterator walks.

Definition at line 143 of file itkImageIterator.h.

template<typename TImage>

itk::ImageIterator< 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::ImageIterator< 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>

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

(

const Self &

it

)

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

Referenced by itk::ImageIteratorWithIndex< RLEImage< TPixel, VImageDimension, CounterType > >::ImageIteratorWithIndex().

template<typename TImage>

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

protected

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

template<typename TImage>

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

inline

Set the pixel value

Definition at line 114 of file itkImageIterator.h.

template<typename TImage>

PixelType& itk::ImageIterator< 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 125 of file itkImageIterator.h.

Member Data Documentation

template<typename TImage>

const unsigned int itk::ImageIterator< 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 77 of file itkImageIterator.h.

---

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

• itkImageIterator.h