ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::ImageRegionConstIteratorWithIndex< TImage > Class Template Reference

#include <itkImageRegionConstIteratorWithIndex.h>

+ Inheritance diagram for itk::ImageRegionConstIteratorWithIndex< TImage >:
+ Collaboration diagram for itk::ImageRegionConstIteratorWithIndex< TImage >:

Public Types

using AccessorType = typename Superclass::AccessorType
 
using ImageType = typename Superclass::ImageType
 
using IndexType = typename Superclass::IndexType
 
using InternalPixelType = typename Superclass::InternalPixelType
 
using OffsetType = typename Superclass::OffsetType
 
using PixelContainer = typename Superclass::PixelContainer
 
using PixelContainerPointer = typename Superclass::PixelContainerPointer
 
using PixelType = typename Superclass::PixelType
 
using RegionType = typename Superclass::RegionType
 
using Self = ImageRegionConstIteratorWithIndex
 
using SizeType = typename Superclass::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

 ImageRegionConstIteratorWithIndex ()
 
 ImageRegionConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
 
 ImageRegionConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
 
Selfoperator++ ()
 
Selfoperator-- ()
 
- Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
const IndexTypeGetIndex () const
 
const RegionTypeGetRegion () const
 
 ImageConstIteratorWithIndex ()
 
 ImageConstIteratorWithIndex (const Self &it)
 
 ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
 
bool operator!= (const Self &it) const
 
bool operator< (const Self &it) const
 
bool operator<= (const Self &it) const
 
Selfoperator= (const Self &it)
 
bool operator== (const Self &it) const
 
bool operator> (const Self &it) const
 
bool operator>= (const Self &it) const
 
virtual ~ImageConstIteratorWithIndex ()=default
 
void SetIndex (const IndexType &ind)
 
PixelType Get () const
 
const PixelTypeValue () const
 
void GoToBegin ()
 
void GoToReverseBegin ()
 
bool IsAtReverseEnd () const
 
bool IsAtEnd () const
 
bool Remaining ()
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
static 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 >
TImage::ConstWeakPointer m_Image
 
IndexType m_PositionIndex
 
IndexType m_BeginIndex
 
IndexType m_EndIndex
 
RegionType m_Region
 
OffsetValueType m_OffsetTable [ImageDimension+1]
 
const InternalPixelTypem_Position
 
const InternalPixelTypem_Begin
 
const InternalPixelTypem_End
 
bool m_Remaining
 
AccessorType m_PixelAccessor
 
AccessorFunctorType m_PixelAccessorFunctor
 

Detailed Description

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

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

The "WithIndex" family of iteators was designed for algorithms that use both the values and locations of image pixels in calculations. Unlike ImageRegionIterator, which calculates an index only when requested, ImageRegionIteratorWithIndex maintains its index location as a member variable that is updated during increment and decrement operations. Iteration speed is penalized, but index queries become more efficient.

ImageRegionConstIteratorWithIndex 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, ImageRegionConstIteratorWithIndex holds a reference to the image over which it is traversing.

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

IteratorType it( image, image->GetRequestedRegion() );
it.Begin();
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.End();
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:
Examples
Examples/RegistrationITKv4/ModelToImageRegistration1.cxx, and SphinxExamples/src/Core/Common/IterateRegionWithAccessToIndexWithoutWriteAccess/Code.cxx.

Definition at line 128 of file itkImageRegionConstIteratorWithIndex.h.

Member Typedef Documentation

◆ AccessorType

template<typename TImage>
using itk::ImageRegionConstIteratorWithIndex< TImage >::AccessorType = typename Superclass::AccessorType

Definition at line 150 of file itkImageRegionConstIteratorWithIndex.h.

◆ ImageType

template<typename TImage>
using itk::ImageRegionConstIteratorWithIndex< TImage >::ImageType = typename Superclass::ImageType

Definition at line 145 of file itkImageRegionConstIteratorWithIndex.h.

◆ IndexType

template<typename TImage>
using itk::ImageRegionConstIteratorWithIndex< TImage >::IndexType = typename Superclass::IndexType

Index type alias support While these were already typdef'ed in the superclass they need to be redone here for this subclass to compile properly with gcc. Types inherited from the Superclass

Definition at line 141 of file itkImageRegionConstIteratorWithIndex.h.

◆ InternalPixelType

template<typename TImage>
using itk::ImageRegionConstIteratorWithIndex< TImage >::InternalPixelType = typename Superclass::InternalPixelType

Definition at line 148 of file itkImageRegionConstIteratorWithIndex.h.

◆ OffsetType

template<typename TImage>
using itk::ImageRegionConstIteratorWithIndex< TImage >::OffsetType = typename Superclass::OffsetType

Definition at line 143 of file itkImageRegionConstIteratorWithIndex.h.

◆ PixelContainer

template<typename TImage>
using itk::ImageRegionConstIteratorWithIndex< TImage >::PixelContainer = typename Superclass::PixelContainer

Definition at line 146 of file itkImageRegionConstIteratorWithIndex.h.

◆ PixelContainerPointer

Definition at line 147 of file itkImageRegionConstIteratorWithIndex.h.

◆ PixelType

template<typename TImage>
using itk::ImageRegionConstIteratorWithIndex< TImage >::PixelType = typename Superclass::PixelType

Definition at line 149 of file itkImageRegionConstIteratorWithIndex.h.

◆ RegionType

template<typename TImage>
using itk::ImageRegionConstIteratorWithIndex< TImage >::RegionType = typename Superclass::RegionType

Definition at line 144 of file itkImageRegionConstIteratorWithIndex.h.

◆ Self

Standard class type aliases.

Definition at line 132 of file itkImageRegionConstIteratorWithIndex.h.

◆ SizeType

template<typename TImage>
using itk::ImageRegionConstIteratorWithIndex< TImage >::SizeType = typename Superclass::SizeType

Definition at line 142 of file itkImageRegionConstIteratorWithIndex.h.

◆ Superclass

template<typename TImage>
using itk::ImageRegionConstIteratorWithIndex< TImage >::Superclass = ImageConstIteratorWithIndex<TImage>

Definition at line 133 of file itkImageRegionConstIteratorWithIndex.h.

Constructor & Destructor Documentation

◆ ImageRegionConstIteratorWithIndex() [1/3]

template<typename TImage>
itk::ImageRegionConstIteratorWithIndex< TImage >::ImageRegionConstIteratorWithIndex ( )
inline

Default constructor. Needed since we provide a cast constructor.

Definition at line 153 of file itkImageRegionConstIteratorWithIndex.h.

◆ ImageRegionConstIteratorWithIndex() [2/3]

template<typename TImage>
itk::ImageRegionConstIteratorWithIndex< TImage >::ImageRegionConstIteratorWithIndex ( const TImage *  ptr,
const RegionType region 
)
inline

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

Definition at line 159 of file itkImageRegionConstIteratorWithIndex.h.

◆ ImageRegionConstIteratorWithIndex() [3/3]

template<typename TImage>
itk::ImageRegionConstIteratorWithIndex< TImage >::ImageRegionConstIteratorWithIndex ( const ImageConstIteratorWithIndex< TImage > &  it)
inline

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

Definition at line 169 of file itkImageRegionConstIteratorWithIndex.h.

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

Member Function Documentation

◆ operator++()

template<typename TImage>
Self& itk::ImageRegionConstIteratorWithIndex< 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--

◆ operator--()

template<typename TImage>
Self& itk::ImageRegionConstIteratorWithIndex< 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 previous 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++

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