#include <itkImageRegionConstIterator.h>

Detailed Description

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

A multi-dimensional iterator templated over image type that walks a region of pixels.

The itk::ImageRegionConstIterator is optimized for iteration speed and is the first choice for iterative, pixel-wise operations on an image. ImageRegionIterator is the least specialized of the ITK image iterator classes. ImageRegionConstIterator is templated over the image type, and is constrained to walk only within the specified region and along a line parallel to one of the coordinate axes, "wrapping" to the next line as it reaches the boundary of the image. To walk the entire image, specify the region to be image->GetRequestedRegion().

ImageRegionConstIterator provides read-only access to image data. It is the base class for the read/write access ImageRegionIterator.

ImageRegionConstIterator is a multi-dimensional iterator, requiring more information be specified before the iterator can be used than conventional iterators. Whereas the std::vector::iterator from the STL only needs to be passed a pointer to establish the iterator, the multi-dimensional image iterator needs a pointer, the size of the buffer, the size of the region, the start index of the buffer, and the start index of the region. To gain access to this information, ImageRegionConstIterator holds a reference to the image over which it is traversing.

ImageRegionConstIterator assumes a particular layout of the image data. The is arranged in a 1D array as if it were [][][][slice][row][col] with Index[0] = col, Index[1] = row, Index[2] = slice, etc.

operator++ provides a simple syntax for walking around a region of a multidimensional image. operator++ iterates across a row, constraining the movement to within a region of image. When the iterator reaches the boundary of the region along a row, the iterator automatically wraps to the next row, starting at the first pixel in the row that is part of the region. This allows for simple processing loops of the form:

it = it.Begin();
for (; !it.IsAtEnd(); ++it)
   {
   *it += 100.0;
   }

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:

<a href=
<a href=

Definition at line 109 of file itkImageRegionConstIterator.h.

Inheritance diagram for itk::ImageRegionConstIterator< TImage >:

Collaboration diagram for itk::ImageRegionConstIterator< 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 = ImageRegionConstIterator

using	SizeType = typename TImage::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
const char *	GetNameOfClass () const override

void	GoToBegin ()

void	GoToEnd ()

	ImageRegionConstIterator (const ImageConstIterator< TImage > &it)

	ImageRegionConstIterator (const ImageIterator< TImage > &it)


	ImageRegionConstIterator ()


	ImageRegionConstIterator (const ImageType *ptr, const RegionType &region)


void	SetIndex (const IndexType &ind) override


Self &	operator++ ()


Self &	operator-- ()

Public Member Functions inherited from itk::ImageConstIterator< TImage >
PixelType	Get () const

const ImageType *	GetImage () const

const IndexType	GetIndex () const

virtual const char *	GetNameOfClass () const

const RegionType &	GetRegion () const

void	GoToBegin ()

void	GoToEnd ()

	ImageConstIterator (const Self &it)

bool	IsAtBegin () const

bool	IsAtEnd () const

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)

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

virtual void	SetIndex (const IndexType &ind)

virtual void	SetRegion (const RegionType &region)

const PixelType &	Value () const

virtual	~ImageConstIterator ()=default

	ImageConstIterator ()

	ImageConstIterator (const ImageType *ptr, const RegionType &region)

Self &	operator= (const Self &it)

Static Public Attributes
static constexpr unsigned int	ImageIteratorDimension = Superclass::ImageIteratorDimension

Static Public Attributes inherited from itk::ImageConstIterator< TImage >
static constexpr unsigned int	ImageIteratorDimension = TImage::ImageDimension

Protected Attributes
OffsetValueType	m_SpanBeginOffset {}

OffsetValueType	m_SpanEndOffset {}

Protected Attributes inherited from itk::ImageConstIterator< TImage >
OffsetValueType	m_BeginOffset {}

const InternalPixelType *	m_Buffer {}

OffsetValueType	m_EndOffset {}

TImage::ConstWeakPointer	m_Image {}

OffsetValueType	m_Offset {}

AccessorType	m_PixelAccessor {}

AccessorFunctorType	m_PixelAccessorFunctor {}

RegionType	m_Region {}

Private Member Functions
void	Decrement ()

void	Increment ()

Additional Inherited Members
Static Public Member Functions inherited from itk::ImageConstIterator< TImage >
static unsigned int	GetImageIteratorDimension ()

Member Typedef Documentation

◆ AccessorType

template<typename TImage >

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

Accessor type that convert data between internal and external representations.

Definition at line 128 of file itkImageConstIterator.h.

◆ ImageType

template<typename TImage >

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

Image type alias support

Definition at line 112 of file itkImageConstIterator.h.

◆ IndexType

template<typename TImage >

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

Index type alias support

Definition at line 100 of file itkImageConstIterator.h.

◆ InternalPixelType

template<typename TImage >

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

Internal Pixel Type

Definition at line 121 of file itkImageConstIterator.h.

◆ OffsetType

template<typename TImage >

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

Offset type alias support

Definition at line 106 of file itkImageConstIterator.h.

◆ PixelContainer

template<typename TImage >

using itk::ImageConstIterator< 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 117 of file itkImageConstIterator.h.

◆ PixelContainerPointer

template<typename TImage >

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

Definition at line 118 of file itkImageConstIterator.h.

◆ PixelType

template<typename TImage >

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

External Pixel Type

Definition at line 124 of file itkImageConstIterator.h.

◆ RegionType

template<typename TImage >

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

Region type alias support

Definition at line 109 of file itkImageConstIterator.h.

◆ Self

template<typename TImage >

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

Standard class type alias.

Definition at line 113 of file itkImageRegionConstIterator.h.

◆ SizeType

template<typename TImage >

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

Size type alias support

Definition at line 103 of file itkImageConstIterator.h.

◆ Superclass

template<typename TImage >

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

Definition at line 114 of file itkImageRegionConstIterator.h.

Constructor & Destructor Documentation

◆ ImageRegionConstIterator() [1/4]

template<typename TImage >

itk::ImageRegionConstIterator< TImage >::ImageRegionConstIterator ( )

inline

Default constructor. Needed since we provide a cast constructor.

Definition at line 143 of file itkImageRegionConstIterator.h.

◆ ImageRegionConstIterator() [2/4]

template<typename TImage >

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

inline

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.

Definition at line 153 of file itkImageRegionConstIterator.h.

◆ ImageRegionConstIterator() [3/4]

template<typename TImage >

itk::ImageRegionConstIterator< TImage >::ImageRegionConstIterator ( const ImageIterator< TImage > & it )

inline

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

Definition at line 167 of file itkImageRegionConstIterator.h.

References itk::ImageConstIterator< TImage >::operator=().

◆ ImageRegionConstIterator() [4/4]

template<typename TImage >

itk::ImageRegionConstIterator< TImage >::ImageRegionConstIterator ( const ImageConstIterator< TImage > & it )

inline

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

Definition at line 183 of file itkImageRegionConstIterator.h.

References itk::ImageConstIterator< TImage >::operator=().

Member Function Documentation

◆ Decrement()

template<typename TImage >

void itk::ImageRegionConstIterator< TImage >::Decrement ( )

private

◆ GetNameOfClass()

template<typename TImage >

const char * itk::ImageRegionConstIterator< TImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageConstIterator< TImage >.

◆ GoToBegin()

template<typename TImage >

void itk::ImageRegionConstIterator< TImage >::GoToBegin ( )

inline

Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region.

Definition at line 196 of file itkImageRegionConstIterator.h.

Referenced by itk::Statistics::ImageToListSampleAdaptor< TImage >::Begin(), and itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SetLevelSet().

◆ GoToEnd()

template<typename TImage >

void itk::ImageRegionConstIterator< TImage >::GoToEnd ( )

inline

Move an iterator to the end of the region. "End" is defined as one pixel past the last pixel of the region.

Definition at line 208 of file itkImageRegionConstIterator.h.

Referenced by itk::Statistics::ImageToListSampleAdaptor< TImage >::End().

◆ Increment()

template<typename TImage >

void itk::ImageRegionConstIterator< TImage >::Increment ( )

private

◆ operator++()

template<typename TImage >

Self & itk::ImageRegionConstIterator< TImage >::operator++ ( )

inline

Increment (prefix) the fastest moving dimension of the iterator's index. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the end of the row of the region to the beginning of the next row of the region) up until the iterator tries to moves past the last pixel of the region. Here, the iterator will be set to be one pixel past the end of the region.

See also: operator++(int)

Definition at line 238 of file itkImageRegionConstIterator.h.

◆ operator--()

template<typename TImage >

Self & itk::ImageRegionConstIterator< TImage >::operator-- ( )

inline

Decrement (prefix) the fastest moving dimension of the iterator's index. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the beginning of the row of the region to the end of the next row of the region) up until the iterator tries to moves past the first pixel of the region. Here, the iterator will be set to be one pixel past the beginning of the region.

See also: operator--(int)

Definition at line 256 of file itkImageRegionConstIterator.h.

◆ SetIndex()

template<typename TImage >

void itk::ImageRegionConstIterator< TImage >::SetIndex ( const IndexType & ind )

inlineoverridevirtual

Set the index. No bounds checking is performed. This is overridden from the parent because we have an extra ivar.

See also: GetIndex

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 221 of file itkImageRegionConstIterator.h.

Member Data Documentation

◆ ImageIteratorDimension

template<typename TImage >

constexpr unsigned int itk::ImageRegionConstIterator< TImage >::ImageIteratorDimension = Superclass::ImageIteratorDimension

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 120 of file itkImageRegionConstIterator.h.

◆ m_SpanBeginOffset

template<typename TImage >

OffsetValueType itk::ImageRegionConstIterator< TImage >::m_SpanBeginOffset {}

protected

Definition at line 267 of file itkImageRegionConstIterator.h.

◆ m_SpanEndOffset

template<typename TImage >

OffsetValueType itk::ImageRegionConstIterator< TImage >::m_SpanEndOffset {}

protected

Definition at line 269 of file itkImageRegionConstIterator.h.

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

itkImageRegionConstIterator.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ AccessorType

◆ ImageType

◆ IndexType

◆ InternalPixelType

◆ OffsetType

◆ PixelContainer

◆ PixelContainerPointer

◆ PixelType

◆ RegionType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ ImageRegionConstIterator() [1/4]

◆ ImageRegionConstIterator() [2/4]

◆ ImageRegionConstIterator() [3/4]

◆ ImageRegionConstIterator() [4/4]

Member Function Documentation

◆ Decrement()

◆ GetNameOfClass()

◆ GoToBegin()

◆ GoToEnd()

◆ Increment()

◆ operator++()

◆ operator--()

◆ SetIndex()

Member Data Documentation

◆ ImageIteratorDimension

◆ m_SpanBeginOffset

◆ m_SpanEndOffset