#include <itkImageConstIteratorWithOnlyIndex.h>

Detailed Description

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

A base class for multi-dimensional iterators templated over image type that are designed to provide only index information, and no pixel access.

ImageConstIteratorWithOnlyIndex is a templated class to represent a multi-dimensional iterator, and is templated over the dimension of the image.

The "WithOnlyIndex" family of iterators differs from the "WithIndex" family of iterators in that only index information is available. The iterator does not access image data at all, and thus can be safely used with images of type ImageBase.

ImageConstIteratorWithOnlyIndex is a base class for the "WithOnlyIndex" family of ITK image iterators, which are designed to efficiently keep track of the image index position of the iterator during increment and decrement operations. This iterator is a base class and provides only the basic construction and comparison operations. It does not provide mechanisms for moving the iterator. A subclass of ImageConstIteratorWithOnlyIndex must be used to move the iterator.

ImageConstIteratorWithOnlyIndex 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 region, and the start index of the region. To gain access to this information, ImageConstIteratorWithOnlyIndex holds a reference to the image over which it is traversing.

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: ImageRegionConstIteratorWithOnlyIndex; ImageRandomConstIteratorWithOnlyIndex; ConstNeighborhoodIteratorWithOnlyIndex; 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

Definition at line 95 of file itkImageConstIteratorWithOnlyIndex.h.

Inheritance diagram for itk::ImageConstIteratorWithOnlyIndex< TImage >:

Public Types
using	ImageType = TImage

using	IndexType = typename TImage::IndexType

using	IndexValueType = typename IndexType::IndexValueType

using	OffsetType = typename TImage::OffsetType

using	OffsetValueType = typename OffsetType::OffsetValueType

using	RegionType = typename TImage::RegionType

using	Self = ImageConstIteratorWithOnlyIndex

using	SizeType = typename TImage::SizeType

using	SizeValueType = typename SizeType::SizeValueType

Public Member Functions
const IndexType &	GetIndex () const

const RegionType &	GetRegion () const

void	GoToBegin ()

void	GoToReverseBegin ()

	ImageConstIteratorWithOnlyIndex ()=default

	ImageConstIteratorWithOnlyIndex (const Self &it)

	ImageConstIteratorWithOnlyIndex (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 ()

void	SetIndex (const IndexType &ind)

virtual	~ImageConstIteratorWithOnlyIndex ()=default

Static Public Member Functions
static unsigned int	GetImageDimension ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TImage::ImageDimension

Protected Attributes
IndexType	m_BeginIndex { { 0 } }

IndexType	m_EndIndex { { 0 } }

TImage::ConstPointer	m_Image {}

OffsetValueType	m_OffsetTable [ImageDimension+1] {}

IndexType	m_PositionIndex { { 0 } }

RegionType	m_Region {}

bool	m_Remaining { false }

Member Typedef Documentation

◆ ImageType

template<typename TImage>

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

Image type alias support

Definition at line 119 of file itkImageConstIteratorWithOnlyIndex.h.

◆ IndexType

template<typename TImage>

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

Index type alias support

Definition at line 108 of file itkImageConstIteratorWithOnlyIndex.h.

◆ IndexValueType

template<typename TImage>

using itk::ImageConstIteratorWithOnlyIndex< TImage >::IndexValueType = typename IndexType::IndexValueType

Definition at line 109 of file itkImageConstIteratorWithOnlyIndex.h.

◆ OffsetType

template<typename TImage>

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

Type of the Offset taken from the image

Definition at line 122 of file itkImageConstIteratorWithOnlyIndex.h.

◆ OffsetValueType

template<typename TImage>

using itk::ImageConstIteratorWithOnlyIndex< TImage >::OffsetValueType = typename OffsetType::OffsetValueType

Definition at line 123 of file itkImageConstIteratorWithOnlyIndex.h.

◆ RegionType

template<typename TImage>

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

Region type alias support

Definition at line 116 of file itkImageConstIteratorWithOnlyIndex.h.

◆ Self

template<typename TImage>

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

Standard class type aliases.

Definition at line 99 of file itkImageConstIteratorWithOnlyIndex.h.

◆ SizeType

template<typename TImage>

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

Size type alias support

Definition at line 112 of file itkImageConstIteratorWithOnlyIndex.h.

◆ SizeValueType

template<typename TImage>

using itk::ImageConstIteratorWithOnlyIndex< TImage >::SizeValueType = typename SizeType::SizeValueType

Definition at line 113 of file itkImageConstIteratorWithOnlyIndex.h.

Constructor & Destructor Documentation

◆ ImageConstIteratorWithOnlyIndex() [1/3]

template<typename TImage>

itk::ImageConstIteratorWithOnlyIndex< TImage >::ImageConstIteratorWithOnlyIndex ( )

default

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

◆ ImageConstIteratorWithOnlyIndex() [2/3]

template<typename TImage>

itk::ImageConstIteratorWithOnlyIndex< TImage >::ImageConstIteratorWithOnlyIndex ( const Self & it )

Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted.

◆ ImageConstIteratorWithOnlyIndex() [3/3]

template<typename TImage>

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

Constructor establishes an iterator to walk a particular image and a particular region of that image.

◆ ~ImageConstIteratorWithOnlyIndex()

template<typename TImage>

virtual itk::ImageConstIteratorWithOnlyIndex< TImage >::~ImageConstIteratorWithOnlyIndex ( )

virtualdefault

Default Destructor.

Member Function Documentation

◆ GetImageDimension()

template<typename TImage>

static unsigned int itk::ImageConstIteratorWithOnlyIndex< TImage >::GetImageDimension ( )

inlinestatic

Get the dimension (size) of the index.

Definition at line 147 of file itkImageConstIteratorWithOnlyIndex.h.

◆ GetIndex()

template<typename TImage>

const IndexType& itk::ImageConstIteratorWithOnlyIndex< TImage >::GetIndex ( ) const

inline

Get the index. This provides a read only reference to the index.

See also: SetIndex

Definition at line 206 of file itkImageConstIteratorWithOnlyIndex.h.

◆ GetRegion()

template<typename TImage>

const RegionType& itk::ImageConstIteratorWithOnlyIndex< TImage >::GetRegion ( ) const

inline

Get the region that this iterator walks. ImageIterators know the beginning and the end of the region of the image to iterate over.

Definition at line 214 of file itkImageConstIteratorWithOnlyIndex.h.

◆ GoToBegin()

template<typename TImage>

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

Move an iterator to the beginning of the region.

◆ GoToReverseBegin()

template<typename TImage>

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

Move an iterator to the End of the region.

◆ IsAtEnd()

template<typename TImage>

bool itk::ImageConstIteratorWithOnlyIndex< TImage >::IsAtEnd ( ) const

inline

Is the iterator at the end of the region?

Definition at line 244 of file itkImageConstIteratorWithOnlyIndex.h.

◆ IsAtReverseEnd()

template<typename TImage>

bool itk::ImageConstIteratorWithOnlyIndex< TImage >::IsAtReverseEnd ( ) const

inline

Is the iterator at the beginning of the region?

Definition at line 237 of file itkImageConstIteratorWithOnlyIndex.h.

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION()

template<typename TImage>

itk::ImageConstIteratorWithOnlyIndex< TImage >::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION ( Self )

◆ operator<()

template<typename TImage>

bool itk::ImageConstIteratorWithOnlyIndex< TImage >::operator< ( const Self & it ) const

inline

Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.

Definition at line 176 of file itkImageConstIteratorWithOnlyIndex.h.

References itk::ImageConstIteratorWithOnlyIndex< TImage >::m_PositionIndex.

◆ operator<=()

template<typename TImage>

bool itk::ImageConstIteratorWithOnlyIndex< TImage >::operator<= ( const Self & it ) const

inline

Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.

Definition at line 166 of file itkImageConstIteratorWithOnlyIndex.h.

References itk::ImageConstIteratorWithOnlyIndex< TImage >::m_PositionIndex.

◆ operator=()

template<typename TImage>

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

operator= is provided to make sure the handle to the image is properly reference counted.

Referenced by itk::ImageRandomConstIteratorWithOnlyIndex< TImage >::ImageRandomConstIteratorWithOnlyIndex(), and itk::ImageRegionConstIteratorWithOnlyIndex< TImage >::ImageRegionConstIteratorWithOnlyIndex().

◆ operator==()

template<typename TImage>

bool itk::ImageConstIteratorWithOnlyIndex< TImage >::operator== ( const Self & it ) const

inline

Comparison operator. Two iterators are the same if they "point to" the same memory location

Definition at line 155 of file itkImageConstIteratorWithOnlyIndex.h.

References itk::ImageConstIteratorWithOnlyIndex< TImage >::m_PositionIndex.

◆ operator>()

template<typename TImage>

bool itk::ImageConstIteratorWithOnlyIndex< TImage >::operator> ( const Self & it ) const

inline

Comparison operator. An iterator is "greater than" another if it "points to" a higher location.

Definition at line 196 of file itkImageConstIteratorWithOnlyIndex.h.

References itk::ImageConstIteratorWithOnlyIndex< TImage >::m_PositionIndex.

◆ operator>=()

template<typename TImage>

bool itk::ImageConstIteratorWithOnlyIndex< TImage >::operator>= ( const Self & it ) const

inline

Comparison operator. An iterator is "greater than" another if it "points to" a higher location.

Definition at line 186 of file itkImageConstIteratorWithOnlyIndex.h.

References itk::ImageConstIteratorWithOnlyIndex< TImage >::m_PositionIndex.

◆ Remaining()

template<typename TImage>

bool itk::ImageConstIteratorWithOnlyIndex< TImage >::Remaining ( )

inline

Are there data remaining in the region ?

Definition at line 251 of file itkImageConstIteratorWithOnlyIndex.h.

◆ SetIndex()

template<typename TImage>

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

inline

Set the index. No bounds checking is performed.

See also: GetIndex

Definition at line 222 of file itkImageConstIteratorWithOnlyIndex.h.

Member Data Documentation

◆ ImageDimension

template<typename TImage>

constexpr unsigned int itk::ImageConstIteratorWithOnlyIndex< TImage >::ImageDimension = 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 105 of file itkImageConstIteratorWithOnlyIndex.h.