#include <itkImageRegionExclusionConstIteratorWithIndex.h>

Detailed Description

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

A multi-dimensional image iterator that walks an image region, excluding a second region that may partially or completely overlap the first, with read-only access to pixels.

ImageRegionExclusionConstIteratorWithIndex is a class templated over the image type that represents a multi-dimensional iterator. The exclusion region is set after construction. By default the exclusion region is empty and the iterator will behave as the itk::ImageRegionConstIteratorWithIndex with a penalty in performance due to internal bounds checking. There are no restrictions on valid exclusion regions.

As with other ITK image iterators, ImageRegionExclusionConstIteratorWithIndex requires that 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, ImageRegionExclusionConstIteratorWithIndex holds a reference to the image over which it is traversing.

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

The operator++ method 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:

IteratorType it( image, image->GetRequestedRegion() );
 
it.SetExclusionRegion( exclusionRegion );
it.GoToBegin();
 
while( ! it.IsAtEnd() )
{
  it.Set( 100.0 + it.Get() );
  ++it;
}

It also can be used for walking in the reverse direction like

IteratorType it( image, image->GetRequestedRegion() );
 
it.SetExclusionRegion( exclusionRegion );
it.GoToEnd();
 
while( !it.IsAtBegin() )
{
  it.Set( 100.0 );
  --it;
}

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

ITK Sphinx Examples:

All ITK Sphinx Examples

Iterate Over Image While Skipping Specific Region

Examples: SphinxExamples/src/Core/Common/IterateOverSpecificRegion/Code.cxx.

Definition at line 131 of file itkImageRegionExclusionConstIteratorWithIndex.h.

Inheritance diagram for itk::ImageRegionExclusionConstIteratorWithIndex< TImage >:

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

using	SizeType = typename TImage::SizeType

using	Superclass = ImageRegionConstIteratorWithIndex< TImage >

Public Types inherited from itk::ImageRegionConstIteratorWithIndex< TImage >
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 = ImageRegionConstIteratorWithIndex

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
void	GoToBegin ()

void	GoToReverseBegin ()

	ImageRegionExclusionConstIteratorWithIndex ()=default

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

	ImageRegionExclusionConstIteratorWithIndex (const Superclass &it)

Self &	operator++ ()

Self &	operator-- ()

void	SetExclusionRegion (const RegionType &region)

void	SetExclusionRegionToInsetRegion ()

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)

Private Attributes
IndexType	m_ExclusionBegin

IndexType	m_ExclusionEnd

RegionType	m_ExclusionRegion

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 = 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::ImageRegionExclusionConstIteratorWithIndex< TImage >::Self = ImageRegionExclusionConstIteratorWithIndex

Standard class type aliases.

Definition at line 135 of file itkImageRegionExclusionConstIteratorWithIndex.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::ImageRegionExclusionConstIteratorWithIndex< TImage >::Superclass = ImageRegionConstIteratorWithIndex<TImage>

Definition at line 136 of file itkImageRegionExclusionConstIteratorWithIndex.h.

Constructor & Destructor Documentation

◆ ImageRegionExclusionConstIteratorWithIndex() [1/3]

template<typename TImage>

itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::ImageRegionExclusionConstIteratorWithIndex ( )

default

Default constructor. Needed since we provide a cast constructor.

◆ ImageRegionExclusionConstIteratorWithIndex() [2/3]

template<typename TImage>

itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::ImageRegionExclusionConstIteratorWithIndex	(	const ImageType *	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.

◆ ImageRegionExclusionConstIteratorWithIndex() [3/3]

template<typename TImage>

itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::ImageRegionExclusionConstIteratorWithIndex ( const Superclass & it )

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

Member Function Documentation

◆ GoToBegin()

template<typename TImage>

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

Move an iterator to the beginning of the non-excluded region.

◆ GoToReverseBegin()

template<typename TImage>

void itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::GoToReverseBegin ( )

Move an iterator to the End of the region.

◆ operator++()

template<typename TImage>

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

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)

◆ operator--()

template<typename TImage>

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

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)

◆ SetExclusionRegion()

template<typename TImage>

void itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::SetExclusionRegion ( const RegionType & region )

Method to define the Exclusion region. The iterator will skip pixels inside this region.

Warning: The exclusion region must be completely contained inside the normal region used to construct the iterator. A border of at least one pixel should exist between the normal region and the exclusion region.

Examples: SphinxExamples/src/Core/Common/IterateOverSpecificRegion/Code.cxx.

◆ SetExclusionRegionToInsetRegion()

template<typename TImage>

void itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::SetExclusionRegionToInsetRegion ( )

Set the exclusion region to be inset one pixel in from the region the iterator walks. This configures the iterator to only walk the pixels on the boundary of the region.

Member Data Documentation

◆ m_ExclusionBegin

template<typename TImage>

IndexType itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::m_ExclusionBegin

private

Definition at line 213 of file itkImageRegionExclusionConstIteratorWithIndex.h.

◆ m_ExclusionEnd

template<typename TImage>

IndexType itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::m_ExclusionEnd

private

Definition at line 214 of file itkImageRegionExclusionConstIteratorWithIndex.h.

◆ m_ExclusionRegion

template<typename TImage>

RegionType itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::m_ExclusionRegion

private

Definition at line 211 of file itkImageRegionExclusionConstIteratorWithIndex.h.

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

itkImageRegionExclusionConstIteratorWithIndex.h

Detailed Description

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

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ AccessorType

◆ ImageType

◆ IndexType

◆ InternalPixelType

◆ OffsetType

◆ PixelContainer

◆ PixelContainerPointer

◆ PixelType

◆ RegionType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ ImageRegionExclusionConstIteratorWithIndex() [1/3]

◆ ImageRegionExclusionConstIteratorWithIndex() [2/3]

◆ ImageRegionExclusionConstIteratorWithIndex() [3/3]

Member Function Documentation

◆ GoToBegin()

◆ GoToReverseBegin()

◆ operator++()

◆ operator--()

◆ SetExclusionRegion()

◆ SetExclusionRegionToInsetRegion()

Member Data Documentation

◆ m_ExclusionBegin

◆ m_ExclusionEnd

◆ m_ExclusionRegion

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