ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::ImageIterator< TImage > Class Template Reference
Data Access Objects » Iterators » Image IteratorsGroup Core » | Module ITKCommon

#include <itkImageIterator.h>

Detailed Description

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

A multi-dimensional iterator templated over image type.

This is a base class of ImageConstIterator that adds write-access functionality. Please see ImageConstIterator for more information.

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

Definition at line 65 of file itkImageIterator.h.

+ Inheritance diagram for itk::ImageIterator< TImage >:
+ Collaboration diagram for itk::ImageIterator< 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 = ImageIterator
 
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

ImageType * GetImage () const
 
 ImageIterator ()=default
 
 ImageIterator (TImage *ptr, const RegionType &region)
 
 ITK_DEFAULT_COPY_AND_MOVE (ImageIterator)
 
void Set (const PixelType &value) const
 
PixelType & Value ()
 
 ~ImageIterator () override=default
 
- 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 = TImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageConstIterator< TImage >
static constexpr unsigned int ImageIteratorDimension = TImage::ImageDimension
 

Protected Member Functions

 ImageIterator (const ImageConstIterator< TImage > &it)
 
Self & operator= (const ImageConstIterator< TImage > &it)
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageConstIterator< TImage >
static unsigned int GetImageIteratorDimension ()
 
- 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 {}
 

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

Standard class type aliases.

Definition at line 71 of file itkImageIterator.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::ImageIterator< TImage >::Superclass = ImageConstIterator<TImage>

Define the superclass

Definition at line 80 of file itkImageIterator.h.

Constructor & Destructor Documentation

◆ ImageIterator() [1/3]

template<typename TImage>
itk::ImageIterator< TImage >::ImageIterator ( )
default

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

◆ ~ImageIterator()

template<typename TImage>
itk::ImageIterator< TImage >::~ImageIterator ( )
overridedefault

Default Destructor

◆ ImageIterator() [2/3]

template<typename TImage>
itk::ImageIterator< TImage >::ImageIterator ( TImage *  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.

◆ ImageIterator() [3/3]

template<typename TImage>
itk::ImageIterator< TImage >::ImageIterator ( const ImageConstIterator< TImage > &  it)
protected

This constructor is declared protected in order to enforce const-correctness

Member Function Documentation

◆ GetImage()

template<typename TImage>
ImageType* itk::ImageIterator< TImage >::GetImage ( ) const
inline

Get the image that this iterator walks.

Definition at line 127 of file itkImageIterator.h.

◆ ITK_DEFAULT_COPY_AND_MOVE()

template<typename TImage>
itk::ImageIterator< TImage >::ITK_DEFAULT_COPY_AND_MOVE ( ImageIterator< TImage >  )

◆ operator=()

template<typename TImage>
Self& itk::ImageIterator< TImage >::operator= ( const ImageConstIterator< TImage > &  it)
protected

This constructor is declared protected in order to enforce const-correctness

◆ Set()

template<typename TImage>
void itk::ImageIterator< TImage >::Set ( const PixelType &  value) const
inline

Set the pixel value

Definition at line 107 of file itkImageIterator.h.

◆ Value()

template<typename TImage>
PixelType& itk::ImageIterator< TImage >::Value ( )
inline

Return a reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.

Definition at line 118 of file itkImageIterator.h.

Member Data Documentation

◆ ImageIteratorDimension

template<typename TImage>
constexpr unsigned int itk::ImageIterator< TImage >::ImageIteratorDimension = TImage::ImageDimension
staticconstexpr

Dimension of the image 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 77 of file itkImageIterator.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16