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

#include <itkImageIteratorWithIndex.h>

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

 ImageIteratorWithIndex ()=default
 
 ImageIteratorWithIndex (const Self &it)
 
 ImageIteratorWithIndex (TImage *ptr, const RegionType &region)
 
Selfoperator= (const Self &it)
 
void Set (const PixelType &value) const
 
PixelTypeValue ()
 
 ~ImageIteratorWithIndex () override=default
 
- 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 ()
 

Static Public Attributes

static constexpr unsigned int ImageIteratorDimension = TImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
static constexpr unsigned int ImageDimension = TImage::ImageDimension
 

Protected Member Functions

 ImageIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
 
Selfoperator= (const ImageConstIteratorWithIndex< TImage > &it)
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
static unsigned int GetImageDimension ()
 
- 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::ImageIteratorWithIndex< TImage >

A base class for multi-dimensional iterators templated over image type that are designed to efficiently keep track of the iterator position.

This class inherits from ImageConstIteratorWithIndex and only adds write-access functionality. See ImageConstIteratorWithIndex 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
ImageConstIteratorWithIndex

Definition at line 68 of file itkImageIteratorWithIndex.h.

Member Typedef Documentation

◆ AccessorType

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

Definition at line 94 of file itkImageIteratorWithIndex.h.

◆ ImageType

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

Definition at line 89 of file itkImageIteratorWithIndex.h.

◆ IndexType

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

Inherit types from the superclass

Definition at line 85 of file itkImageIteratorWithIndex.h.

◆ InternalPixelType

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

Definition at line 92 of file itkImageIteratorWithIndex.h.

◆ OffsetType

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

Definition at line 87 of file itkImageIteratorWithIndex.h.

◆ PixelContainer

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

Definition at line 90 of file itkImageIteratorWithIndex.h.

◆ PixelContainerPointer

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

Definition at line 91 of file itkImageIteratorWithIndex.h.

◆ PixelType

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

Definition at line 93 of file itkImageIteratorWithIndex.h.

◆ RegionType

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

Definition at line 88 of file itkImageIteratorWithIndex.h.

◆ Self

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

Standard class type aliases.

Definition at line 73 of file itkImageIteratorWithIndex.h.

◆ SizeType

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

Definition at line 86 of file itkImageIteratorWithIndex.h.

◆ Superclass

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

Define the superclass

Definition at line 82 of file itkImageIteratorWithIndex.h.

Constructor & Destructor Documentation

◆ ImageIteratorWithIndex() [1/4]

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

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

◆ ~ImageIteratorWithIndex()

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

Default Destructor

◆ ImageIteratorWithIndex() [2/4]

template<typename TImage>
itk::ImageIteratorWithIndex< TImage >::ImageIteratorWithIndex ( const Self it)

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

◆ ImageIteratorWithIndex() [3/4]

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

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

◆ ImageIteratorWithIndex() [4/4]

template<typename TImage>
itk::ImageIteratorWithIndex< TImage >::ImageIteratorWithIndex ( const ImageConstIteratorWithIndex< TImage > &  it)
protected

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

Member Function Documentation

◆ operator=() [1/2]

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

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

◆ operator=() [2/2]

template<typename TImage>
Self& itk::ImageIteratorWithIndex< TImage >::operator= ( const Self it)

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

◆ Set()

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

Set the pixel value

Definition at line 118 of file itkImageIteratorWithIndex.h.

◆ Value()

template<typename TImage>
PixelType& itk::ImageIteratorWithIndex< 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 127 of file itkImageIteratorWithIndex.h.

Member Data Documentation

◆ ImageIteratorDimension

template<typename TImage>
constexpr unsigned int itk::ImageIteratorWithIndex< TImage >::ImageIteratorDimension = 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 79 of file itkImageIteratorWithIndex.h.


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