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

#include <itkImageRegionConstIterator.h>

+ Inheritance diagram for itk::ImageRegionConstIterator< TImage >:
+ Collaboration diagram for itk::ImageRegionConstIterator< 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 = ImageRegionConstIterator
 
using SizeType = typename Superclass::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

virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::ImageConstIterator< TImage >
 itkTypeMacroNoParent (ImageConstIterator)
 
 ImageConstIterator ()
 
virtual ~ImageConstIterator ()=default
 
 ImageConstIterator (const Self &it)
 
 ImageConstIterator (const ImageType *ptr, const RegionType &region)
 
Selfoperator= (const Self &it)
 
virtual void SetRegion (const RegionType &region)
 
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
 
bool operator> (const Self &it) const
 
const IndexType GetIndex () const
 
const RegionTypeGetRegion () const
 
const ImageTypeGetImage () const
 
PixelType Get () const
 
const PixelTypeValue () const
 
void GoToBegin ()
 
void GoToEnd ()
 
bool IsAtBegin () const
 
bool IsAtEnd () const
 

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
 
OffsetValueType m_SpanBeginOffset
 
OffsetValueType m_SpanEndOffset
 
 ImageRegionConstIterator ()
 
 ImageRegionConstIterator (const ImageType *ptr, const RegionType &region)
 
 ImageRegionConstIterator (const ImageIterator< TImage > &it)
 
 ImageRegionConstIterator (const ImageConstIterator< TImage > &it)
 
void GoToBegin ()
 
void GoToEnd ()
 
void SetIndex (const IndexType &ind) override
 
Selfoperator++ ()
 
Selfoperator-- ()
 
void Increment ()
 
void Decrement ()
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageConstIterator< TImage >
static unsigned int GetImageIteratorDimension ()
 
- Protected Attributes inherited from itk::ImageConstIterator< TImage >
TImage::ConstWeakPointer m_Image
 
RegionType m_Region
 
OffsetValueType m_Offset
 
OffsetValueType m_BeginOffset
 
OffsetValueType m_EndOffset
 
const InternalPixelTypem_Buffer
 
AccessorType m_PixelAccessor
 
AccessorFunctorType m_PixelAccessorFunctor
 

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
ITK Sphinx Examples:
Examples
Examples/RegistrationITKv4/DeformableRegistration2.cxx, Examples/RegistrationITKv4/DeformableRegistration5.cxx, Examples/Statistics/BayesianClassifierInitializer.cxx, SphinxExamples/src/Core/Common/DeepCopyImage/Code.cxx, SphinxExamples/src/Core/Common/FilterImageUsingMultipleThreads/Code.cxx, SphinxExamples/src/Core/Common/UseParallelizeImageRegion/Code.cxx, and SphinxExamples/src/Developer/MultiThreadedImageFilter.cxx.

Definition at line 107 of file itkImageRegionConstIterator.h.

Member Typedef Documentation

◆ AccessorType

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

Definition at line 135 of file itkImageRegionConstIterator.h.

◆ ImageType

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

Definition at line 130 of file itkImageRegionConstIterator.h.

◆ IndexType

template<typename TImage>
using itk::ImageRegionConstIterator< 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 126 of file itkImageRegionConstIterator.h.

◆ InternalPixelType

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

Definition at line 133 of file itkImageRegionConstIterator.h.

◆ OffsetType

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

Definition at line 128 of file itkImageRegionConstIterator.h.

◆ PixelContainer

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

Definition at line 131 of file itkImageRegionConstIterator.h.

◆ PixelContainerPointer

template<typename TImage>
using itk::ImageRegionConstIterator< TImage >::PixelContainerPointer = typename Superclass::PixelContainerPointer

Definition at line 132 of file itkImageRegionConstIterator.h.

◆ PixelType

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

Definition at line 134 of file itkImageRegionConstIterator.h.

◆ RegionType

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

Definition at line 129 of file itkImageRegionConstIterator.h.

◆ Self

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

Standard class type alias.

Definition at line 111 of file itkImageRegionConstIterator.h.

◆ SizeType

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

Definition at line 127 of file itkImageRegionConstIterator.h.

◆ Superclass

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

Definition at line 112 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 141 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.

Definition at line 151 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 165 of file itkImageRegionConstIterator.h.

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

Member Function Documentation

◆ Decrement()

template<typename TImage>
void itk::ImageRegionConstIterator< TImage >::Decrement ( )
private

Default constructor. Needed since we provide a cast constructor.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ GoToBegin()

template<typename TImage>
void itk::ImageRegionConstIterator< TImage >::GoToBegin ( )
inline

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

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

◆ Increment()

template<typename TImage>
void itk::ImageRegionConstIterator< TImage >::Increment ( )
private

Default constructor. Needed since we provide a cast constructor.

◆ 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 236 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 254 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 219 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 118 of file itkImageRegionConstIterator.h.

◆ m_SpanBeginOffset

template<typename TImage>
OffsetValueType itk::ImageRegionConstIterator< TImage >::m_SpanBeginOffset
protected

Default constructor. Needed since we provide a cast constructor.

Definition at line 265 of file itkImageRegionConstIterator.h.

◆ m_SpanEndOffset

template<typename TImage>
OffsetValueType itk::ImageRegionConstIterator< TImage >::m_SpanEndOffset
protected

Default constructor. Needed since we provide a cast constructor.

Definition at line 267 of file itkImageRegionConstIterator.h.


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