itk::ImageIteratorWithIndex< TImage > Class Template Reference

#include <itkImageIteratorWithIndex.h>

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 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

ImageConstIteratorWithIndex

Definition at line 68 of file itkImageIteratorWithIndex.h.

Inheritance diagram for itk::ImageIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageIteratorWithIndex< TImage >:

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

Public Member Functions
	ImageIteratorWithIndex ()=default
	ImageIteratorWithIndex (const Self &it)
	ImageIteratorWithIndex (TImage *ptr, const RegionType &region)
Self &	operator= (const Self &it)
void	Set (const PixelType &value) const
PixelType &	Value ()
	~ImageIteratorWithIndex () override=default
Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
PixelType	Get () const
const IndexType &	GetIndex () const
const RegionType &	GetRegion () const
void	GoToBegin ()
void	GoToReverseBegin ()
	ImageConstIteratorWithIndex ()=default
	ImageConstIteratorWithIndex (const Self &it)
	ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
bool	IsAtEnd () const
bool	IsAtReverseEnd () const
	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)
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 () const
virtual	~ImageConstIteratorWithIndex ()=default
void	SetIndex (const IndexType &ind)

Static Public Attributes
static constexpr unsigned int	ImageIteratorDimension = TImage::ImageDimension
Static Public Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
static constexpr 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 { nullptr }
IndexType	m_BeginIndex { { 0 } }
const InternalPixelType *	m_End { nullptr }
IndexType	m_EndIndex { { 0 } }
TImage::ConstWeakPointer	m_Image {}
OffsetValueType	m_OffsetTable [ImageDimension+1] {}
AccessorType	m_PixelAccessor {}
AccessorFunctorType	m_PixelAccessorFunctor {}
const InternalPixelType *	m_Position { nullptr }
IndexType	m_PositionIndex { { 0 } }
RegionType	m_Region {}
bool	m_Remaining { false }

Member Typedef Documentation

AccessorType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::AccessorType = typename TImage::AccessorType

Accessor type that converts data between internal and external representations.

Definition at line 132 of file itkImageConstIteratorWithIndex.h.

ImageType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::ImageType = TImage

Image type alias support

Definition at line 116 of file itkImageConstIteratorWithIndex.h.

IndexType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::IndexType = typename TImage::IndexType

Index type alias support

Definition at line 105 of file itkImageConstIteratorWithIndex.h.

InternalPixelType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::InternalPixelType = typename TImage::InternalPixelType

Internal Pixel Type

Definition at line 125 of file itkImageConstIteratorWithIndex.h.

OffsetType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::OffsetType = typename TImage::OffsetType

Type of the Offset taken from the image

Definition at line 136 of file itkImageConstIteratorWithIndex.h.

PixelContainer

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::PixelContainer = typename TImage::PixelContainer

PixelContainer type alias support Used to refer to the container for the pixel data. While this was already typedef'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.

PixelContainerPointer

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::PixelContainerPointer = typename PixelContainer::Pointer

Definition at line 122 of file itkImageConstIteratorWithIndex.h.

PixelType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::PixelType = typename TImage::PixelType

External Pixel Type

Definition at line 128 of file itkImageConstIteratorWithIndex.h.

RegionType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::RegionType = typename TImage::RegionType

Region type alias support

Definition at line 113 of file itkImageConstIteratorWithIndex.h.

Self

template<typename TImage >

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

Standard class type aliases.

Definition at line 73 of file itkImageIteratorWithIndex.h.

SizeType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::SizeType = typename TImage::SizeType

Size type alias support

Definition at line 109 of file itkImageConstIteratorWithIndex.h.

Superclass

template<typename TImage >

using itk::ImageIteratorWithIndex< TImage >::Superclass = ImageConstIteratorWithIndex<TImage>

Define the superclass

Definition at line 82 of file itkImageIteratorWithIndex.h.

Constructor & Destructor Documentation

ImageIteratorWithIndex() [1/4]

template<typename TImage >

itk::ImageIteratorWithIndex< TImage >::ImageIteratorWithIndex ( )

default

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

~ImageIteratorWithIndex()

template<typename TImage >

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

overridedefault

Default Destructor

ImageIteratorWithIndex() [2/4]

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.

ImageIteratorWithIndex() [3/4]

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.

ImageIteratorWithIndex() [4/4]

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

operator=() [1/2]

template<typename TImage >

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

protected

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

operator=() [2/2]

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.

Set()

template<typename TImage >

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

inline

Set the pixel value

Definition at line 118 of file itkImageIteratorWithIndex.h.

Value()

template<typename TImage >

PixelType & itk::ImageIteratorWithIndex< 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 127 of file itkImageIteratorWithIndex.h.

Member Data Documentation

ImageIteratorDimension

template<typename TImage >

constexpr unsigned int itk::ImageIteratorWithIndex< TImage >::ImageIteratorDimension = TImage::ImageDimension

staticconstexpr

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 79 of file itkImageIteratorWithIndex.h.

---

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

• itkImageIteratorWithIndex.h