itk::ImageRegionIteratorWithIndex< TImage > Class Template Reference

#include <itkImageRegionIteratorWithIndex.h>

Detailed Description

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

A multi-dimensional iterator templated over image type that walks pixels within a region and is specialized to keep track of its image index location.

This class is a specialization of ImageRegionConstIteratorWithIndex that adds write-access (the Set() method). Please see ImageRegionConstIteratorWithIndex 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

ImageRegionRange

ImageRegionIndexRange

ITK Sphinx Examples:

• All ITK Sphinx Examples

• Iterate Region In Image With Access To Current Index With Write Access

Examples

Examples/DataRepresentation/Image/ImageAdaptor1.cxx, Examples/Filtering/DigitallyReconstructedRadiograph1.cxx, and Examples/Iterators/ImageRegionIteratorWithIndex.cxx.

Definition at line 73 of file itkImageRegionIteratorWithIndex.h.

Inheritance diagram for itk::ImageRegionIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageRegionIteratorWithIndex< TImage >:

Public Types
using	AccessorType
using	ImageType
using	IndexType
using	InternalPixelType
using	OffsetType
using	PixelContainer
using	PixelContainerPointer
using	PixelType
using	RegionType
using	Self = ImageRegionIteratorWithIndex
using	SizeType
using	Superclass = ImageRegionConstIteratorWithIndex<TImage>
Public Types inherited from itk::ImageRegionConstIteratorWithIndex< TImage >
using	AccessorType
using	ImageType
using	IndexType
using	InternalPixelType
using	OffsetType
using	PixelContainer
using	PixelContainerPointer
using	PixelType
using	RegionType
using	Self = ImageRegionConstIteratorWithIndex
using	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
	ImageRegionIteratorWithIndex ()=default
	ImageRegionIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)
	ImageRegionIteratorWithIndex (TImage *ptr, const RegionType &region)
void	Set (const PixelType &value) const
PixelType &	Value ()
Public Member Functions inherited from itk::ImageRegionConstIteratorWithIndex< TImage >
	ImageRegionConstIteratorWithIndex ()
	ImageRegionConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
	ImageRegionConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
Self &	operator++ ()
Self &	operator-- ()
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)

Protected Member Functions
	ImageRegionIteratorWithIndex (const ImageRegionConstIteratorWithIndex< TImage > &it)
Self &	operator= (const ImageRegionConstIteratorWithIndex< TImage > &it)

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

Accessor type that converts data between internal and external representations.

Definition at line 152 of file itkImageConstIteratorWithIndex.h.

ImageType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::ImageType

Image type alias support

Definition at line 147 of file itkImageConstIteratorWithIndex.h.

IndexType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::IndexType

Index type alias support

Definition at line 143 of file itkImageConstIteratorWithIndex.h.

InternalPixelType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::InternalPixelType

Internal Pixel Type

Definition at line 150 of file itkImageConstIteratorWithIndex.h.

OffsetType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::OffsetType

Type of the Offset taken from the image

Definition at line 145 of file itkImageConstIteratorWithIndex.h.

PixelContainer

template<typename TImage>

using itk::ImageConstIteratorWithIndex< 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 148 of file itkImageConstIteratorWithIndex.h.

PixelContainerPointer

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::PixelContainerPointer

Definition at line 149 of file itkImageConstIteratorWithIndex.h.

PixelType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::PixelType

External Pixel Type

Definition at line 151 of file itkImageConstIteratorWithIndex.h.

RegionType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::RegionType

Region type alias support

Definition at line 146 of file itkImageConstIteratorWithIndex.h.

Self

template<typename TImage>

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

Standard class type aliases.

Definition at line 77 of file itkImageRegionIteratorWithIndex.h.

SizeType

template<typename TImage>

using itk::ImageConstIteratorWithIndex< TImage >::SizeType

Size type alias support

Definition at line 144 of file itkImageConstIteratorWithIndex.h.

Superclass

template<typename TImage>

using itk::ImageRegionIteratorWithIndex< TImage >::Superclass = ImageRegionConstIteratorWithIndex<TImage>

Definition at line 78 of file itkImageRegionIteratorWithIndex.h.

Constructor & Destructor Documentation

ImageRegionIteratorWithIndex() [1/4]

template<typename TImage>

itk::ImageRegionIteratorWithIndex< TImage >::ImageRegionIteratorWithIndex ( )

default

Default constructor. Needed since we provide a cast constructor.

ImageRegionIteratorWithIndex() [2/4]

template<typename TImage>

itk::ImageRegionIteratorWithIndex< TImage >::ImageRegionIteratorWithIndex	(	TImage *	ptr,
		const RegionType &	region )

Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes the iterator at the begin of the region.

ImageRegionIteratorWithIndex() [3/4]

template<typename TImage>

itk::ImageRegionIteratorWithIndex< TImage >::ImageRegionIteratorWithIndex

(

const ImageIteratorWithIndex< TImage > &

it

)

Constructor that can be used to cast from an ImageIterator to an ImageRegionIteratorWithIndex. Many routines return an ImageIterator, but for a particular task, you may want an ImageRegionIteratorWithIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRegionIteratorWithIndex.

ImageRegionIteratorWithIndex() [4/4]

template<typename TImage>

itk::ImageRegionIteratorWithIndex< TImage >::ImageRegionIteratorWithIndex ( const ImageRegionConstIteratorWithIndex< TImage > & it )

protected

The construction from a const iterator is declared protected in order to enforce const correctness.

Member Function Documentation

operator=()

template<typename TImage>

Self & itk::ImageRegionIteratorWithIndex< TImage >::operator= ( const ImageRegionConstIteratorWithIndex< TImage > & it )

protected

The construction from a const iterator is declared protected in order to enforce const correctness.

Set()

template<typename TImage>

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

inline

Set the pixel value

Definition at line 109 of file itkImageRegionIteratorWithIndex.h.

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

Value()

template<typename TImage>

PixelType & itk::ImageRegionIteratorWithIndex< 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 118 of file itkImageRegionIteratorWithIndex.h.

---

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

• itkImageRegionIteratorWithIndex.h