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
using	AccessorType = typename Superclass::AccessorType
using	ImageType = typename Superclass::ImageType
using	IndexType = typename Superclass::IndexType
using	InternalPixelType = typename Superclass::InternalPixelType
using	OffsetType = typename Superclass::OffsetType
using	PixelContainer = typename Superclass::PixelContainer
using	PixelContainerPointer = typename Superclass::PixelContainerPointer
using	PixelType = typename Superclass::PixelType
using	RegionType = typename Superclass::RegionType
using	Self = ImageIterator
using	SizeType = typename Superclass::SizeType
using	Superclass = ImageConstIterator< TImage >
Public Types inherited from itk::ImageConstIterator< TImage >
using	AccessorFunctorType = typename TImage::AccessorFunctorType
using	AccessorType = typename TImage::AccessorType
using	ImageType = TImage
using	IndexType = typename TImage::IndexType
using	InternalPixelType = typename TImage::InternalPixelType
using	OffsetType = typename TImage::OffsetType
using	PixelContainer = typename TImage::PixelContainer
using	PixelContainerPointer = typename PixelContainer::Pointer
using	PixelType = typename TImage::PixelType
using	RegionType = typename TImage::RegionType
using	Self = ImageConstIterator
using	SizeType = typename TImage::SizeType

Public Member Functions
ImageType *	GetImage () const
	ImageIterator ()=default
	ImageIterator (const Self &it)
	ImageIterator (TImage *ptr, const RegionType &region)
Self &	operator= (const Self &it)
void	Set (const PixelType &value) const
PixelType &	Value ()
	~ImageIterator () override=default
Public Member Functions inherited from itk::ImageConstIterator< TImage >
	ImageConstIterator (const Self &it)
	itkTypeMacroNoParent (ImageConstIterator)
virtual	~ImageConstIterator ()=default
	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 () const
const PixelType &	Value () const
void	GoToBegin ()
void	GoToEnd ()
bool	IsAtBegin () const
bool	IsAtEnd () const

Static Public Attributes
static constexpr unsigned int	ImageIteratorDimension = TImage::ImageDimension
Static Public Attributes inherited from itk::ImageConstIterator< TImage >
static constexpr 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>

using itk::ImageIterator< TImage >::AccessorType = typename Superclass::AccessorType

Definition at line 91 of file itkImageIterator.h.

template<typename TImage>

using itk::ImageIterator< TImage >::ImageType = typename Superclass::ImageType

Definition at line 86 of file itkImageIterator.h.

template<typename TImage>

using itk::ImageIterator< TImage >::IndexType = typename Superclass::IndexType

Inherit types from the superclass

Definition at line 82 of file itkImageIterator.h.

template<typename TImage>

using itk::ImageIterator< TImage >::InternalPixelType = typename Superclass::InternalPixelType

Definition at line 89 of file itkImageIterator.h.

template<typename TImage>

using itk::ImageIterator< TImage >::OffsetType = typename Superclass::OffsetType

Definition at line 84 of file itkImageIterator.h.

template<typename TImage>

using itk::ImageIterator< TImage >::PixelContainer = typename Superclass::PixelContainer

Definition at line 87 of file itkImageIterator.h.

template<typename TImage>

using itk::ImageIterator< TImage >::PixelContainerPointer = typename Superclass::PixelContainerPointer

Definition at line 88 of file itkImageIterator.h.

template<typename TImage>

using itk::ImageIterator< TImage >::PixelType = typename Superclass::PixelType

Definition at line 90 of file itkImageIterator.h.

template<typename TImage>

using itk::ImageIterator< TImage >::RegionType = typename Superclass::RegionType

Definition at line 85 of file itkImageIterator.h.

template<typename TImage>

using itk::ImageIterator< TImage >::Self = ImageIterator

Standard class type aliases.

Definition at line 70 of file itkImageIterator.h.

template<typename TImage>

using itk::ImageIterator< TImage >::SizeType = typename Superclass::SizeType

Definition at line 83 of file itkImageIterator.h.

template<typename TImage>

using itk::ImageIterator< TImage >::Superclass = ImageConstIterator< TImage >

Define the superclass

Definition at line 79 of file itkImageIterator.h.

Constructor & Destructor Documentation

template<typename TImage>

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

default

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

template<typename TImage>

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

overridedefault

Default Destructor

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 132 of file itkImageIterator.h.

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 113 of file itkImageIterator.h.

template<typename TImage>

PixelType& itk::ImageIterator< TImage >::Value ( )

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 124 of file itkImageIterator.h.

Member Data Documentation

template<typename TImage>

constexpr 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 76 of file itkImageIterator.h.

---

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

• itkImageIterator.h