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

#include <itkImageRegionIteratorWithIndex.h>

+ Inheritance diagram for itk::ImageRegionIteratorWithIndex< TImage >:
+ Collaboration diagram for itk::ImageRegionIteratorWithIndex< 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 = ImageRegionIteratorWithIndex
 
using SizeType = typename Superclass::SizeType
 
using Superclass = ImageRegionConstIteratorWithIndex< TImage >
 
- Public Types inherited from itk::ImageRegionConstIteratorWithIndex< TImage >
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

 ImageRegionIteratorWithIndex ()=default
 
 ImageRegionIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)
 
 ImageRegionIteratorWithIndex (TImage *ptr, const RegionType &region)
 
void Set (const PixelType &value) const
 
PixelTypeValue ()
 
- Public Member Functions inherited from itk::ImageRegionConstIteratorWithIndex< TImage >
 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 ()
 

Protected Member Functions

 ImageRegionIteratorWithIndex (const ImageRegionConstIteratorWithIndex< TImage > &it)
 
Selfoperator= (const ImageRegionConstIteratorWithIndex< TImage > &it)
 

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::ImageRegionIteratorWithIndex< TImage >

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

This class is a specialization of ImageRegionConstIteratorWithIndex that adds write-access (the Set() method). Please see ImageRegionConstIteratorWithIndex 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
ITK Sphinx Examples:
\li All ITK Sphinx Examples
Examples
Examples/DataRepresentation/Image/ImageAdaptor1.cxx, Examples/Filtering/DigitallyReconstructedRadiograph1.cxx, Examples/Iterators/ImageRegionIteratorWithIndex.cxx, SphinxExamples/src/Core/Common/IterateRegionWithAccessToIndexWithWriteAccess/Code.cxx, SphinxExamples/src/Numerics/Statistics/ComputeHistogramOfMaskedRegion/Code.cxx, SphinxExamples/src/Registration/Metricsv4/PerformRegistrationOnVectorImages/Code.cxx, SphinxExamples/src/Segmentation/Classifiers/KMeansClusterOfPixelsInImage/Code.cxx, SphinxExamples/src/Segmentation/LevelSetsv4Visualization/VisualizeEvolvingDense2DLevelSetAsElevationMap/Code.cxx, and SphinxExamples/src/Segmentation/LevelSetsv4Visualization/VisualizeEvolvingDense2DLevelSetZeroSet/Code.cxx.

Definition at line 71 of file itkImageRegionIteratorWithIndex.h.

Member Typedef Documentation

◆ AccessorType

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

Definition at line 88 of file itkImageRegionIteratorWithIndex.h.

◆ ImageType

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

Definition at line 83 of file itkImageRegionIteratorWithIndex.h.

◆ IndexType

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

Types inherited from the Superclass

Definition at line 79 of file itkImageRegionIteratorWithIndex.h.

◆ InternalPixelType

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

Definition at line 86 of file itkImageRegionIteratorWithIndex.h.

◆ OffsetType

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

Definition at line 81 of file itkImageRegionIteratorWithIndex.h.

◆ PixelContainer

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

Definition at line 84 of file itkImageRegionIteratorWithIndex.h.

◆ PixelContainerPointer

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

Definition at line 85 of file itkImageRegionIteratorWithIndex.h.

◆ PixelType

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

Definition at line 87 of file itkImageRegionIteratorWithIndex.h.

◆ RegionType

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

Definition at line 82 of file itkImageRegionIteratorWithIndex.h.

◆ Self

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

Standard class type aliases.

Definition at line 75 of file itkImageRegionIteratorWithIndex.h.

◆ SizeType

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

Definition at line 80 of file itkImageRegionIteratorWithIndex.h.

◆ Superclass

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

Definition at line 76 of file itkImageRegionIteratorWithIndex.h.

Constructor & Destructor Documentation

◆ ImageRegionIteratorWithIndex() [1/4]

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

Default constructor. Needed since we provide a cast constructor.

◆ ImageRegionIteratorWithIndex() [2/4]

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

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

◆ ImageRegionIteratorWithIndex() [3/4]

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

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

◆ ImageRegionIteratorWithIndex() [4/4]

template<typename TImage>
itk::ImageRegionIteratorWithIndex< TImage >::ImageRegionIteratorWithIndex ( const ImageRegionConstIteratorWithIndex< TImage > &  it)
protected

The construction from a const iterator is declared protected in order to enforce const correctness.

Member Function Documentation

◆ operator=()

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

The construction from a const iterator is declared protected in order to enforce const correctness.

◆ Set()

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

Set the pixel value

Definition at line 107 of file itkImageRegionIteratorWithIndex.h.

◆ Value()

template<typename TImage>
PixelType& itk::ImageRegionIteratorWithIndex< 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 116 of file itkImageRegionIteratorWithIndex.h.


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