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

#include <itkImageReverseIterator.h>

+ Inheritance diagram for itk::ImageReverseIterator< TImage >:
+ Collaboration diagram for itk::ImageReverseIterator< 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 = ImageReverseIterator
 
using SizeType = typename Superclass::SizeType
 
using Superclass = ImageRegionReverseConstIterator< TImage >
 
- Public Types inherited from itk::ImageRegionReverseConstIterator< 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 PixelContainer::Pointer
 
using PixelType = typename Superclass::PixelType
 
using RegionType = typename Superclass::RegionType
 
using Self = ImageRegionReverseConstIterator
 
using SizeType = typename Superclass::SizeType
 
using Superclass = ImageReverseConstIterator< TImage >
 
- Public Types inherited from itk::ImageReverseConstIterator< 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 = ImageReverseConstIterator
 
using SizeType = typename TImage::SizeType
 

Public Member Functions

 ImageReverseIterator ()=default
 
 ImageReverseIterator (const ImageIteratorWithIndex< TImage > &it)
 
 ImageReverseIterator (ImageType *ptr, const RegionType &region)
 
void Set (const PixelType &value) const
 
PixelTypeValue ()
 
- Public Member Functions inherited from itk::ImageRegionReverseConstIterator< TImage >
virtual const char * GetNameOfClass () const
 
 ImageRegionReverseConstIterator ()
 
 ImageRegionReverseConstIterator (const ImageType *ptr, const RegionType &region)
 
 ImageRegionReverseConstIterator (const ImageConstIterator< TImage > &it)
 
 ImageRegionReverseConstIterator (const ImageReverseConstIterator< TImage > &it)
 
 ImageRegionReverseConstIterator (const ImageRegionIterator< TImage > &it)
 
void GoToBegin ()
 
void GoToEnd ()
 
void SetIndex (const IndexType &ind) override
 
Selfoperator++ ()
 
Selfoperator-- ()
 
- Public Member Functions inherited from itk::ImageReverseConstIterator< TImage >
 itkTypeMacroNoParent (ImageReverseConstIterator)
 
 ImageReverseConstIterator ()
 
virtual ~ImageReverseConstIterator ()=default
 
 ImageReverseConstIterator (const Self &it)
 
 ImageReverseConstIterator (const ImageType *ptr, const RegionType &region)
 
 ImageReverseConstIterator (const ImageConstIterator< TImage > &it)
 
Selfoperator= (const Self &it)
 
Selfoperator= (const ImageConstIterator< TImage > &it)
 
bool operator!= (const Self &it) const
 
bool operator== (const Self &it) const
 
const IndexType GetIndex ()
 
virtual void SetIndex (const IndexType &ind)
 
const RegionTypeGetRegion () const
 
const PixelType Get () const
 
void Set (const PixelType &value) const
 
const PixelTypeValue () const
 
const PixelTypeValue ()
 
void GoToBegin ()
 
void GoToEnd ()
 
bool IsAtBegin () const
 
bool IsAtEnd () const
 

Protected Member Functions

 ImageReverseIterator (const ImageRegionReverseConstIterator< TImage > &it)
 
Selfoperator= (const ImageRegionReverseConstIterator< TImage > &it)
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageReverseConstIterator< TImage >
static unsigned int GetImageIteratorDimension ()
 
- Static Public Attributes inherited from itk::ImageReverseConstIterator< TImage >
static constexpr unsigned int ImageIteratorDimension = TImage::ImageDimension
 
- Protected Attributes inherited from itk::ImageRegionReverseConstIterator< TImage >
SizeValueType m_SpanBeginOffset
 
SizeValueType m_SpanEndOffset
 
- Protected Attributes inherited from itk::ImageReverseConstIterator< TImage >
ImageType::ConstWeakPointer m_Image
 
RegionType m_Region
 
SizeValueType m_Offset
 
SizeValueType m_BeginOffset
 
SizeValueType m_EndOffset
 
const InternalPixelTypem_Buffer
 
AccessorType m_PixelAccessor
 
AccessorFunctorType m_PixelAccessorFunctor
 

Detailed Description

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

A multi-dimensional image iterator designed to walk a specified region in reverse.

This is a subclass of ImageReverseConstIterator that adds write-access functionality. Please see ImageReverseConstIterator for details.

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 65 of file itkImageReverseIterator.h.

Member Typedef Documentation

◆ AccessorType

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

Definition at line 82 of file itkImageReverseIterator.h.

◆ ImageType

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

Definition at line 77 of file itkImageReverseIterator.h.

◆ IndexType

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

Types inherited from the Superclass

Definition at line 73 of file itkImageReverseIterator.h.

◆ InternalPixelType

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

Definition at line 80 of file itkImageReverseIterator.h.

◆ OffsetType

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

Definition at line 75 of file itkImageReverseIterator.h.

◆ PixelContainer

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

Definition at line 78 of file itkImageReverseIterator.h.

◆ PixelContainerPointer

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

Definition at line 79 of file itkImageReverseIterator.h.

◆ PixelType

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

Definition at line 81 of file itkImageReverseIterator.h.

◆ RegionType

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

Definition at line 76 of file itkImageReverseIterator.h.

◆ Self

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

Standard class type aliases.

Definition at line 69 of file itkImageReverseIterator.h.

◆ SizeType

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

Definition at line 74 of file itkImageReverseIterator.h.

◆ Superclass

template<typename TImage >
using itk::ImageReverseIterator< TImage >::Superclass = ImageRegionReverseConstIterator<TImage>

Definition at line 70 of file itkImageReverseIterator.h.

Constructor & Destructor Documentation

◆ ImageReverseIterator() [1/4]

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

Default constructor. Needed since we provide a cast constructor.

◆ ImageReverseIterator() [2/4]

template<typename TImage >
itk::ImageReverseIterator< TImage >::ImageReverseIterator ( ImageType ptr,
const RegionType region 
)

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

◆ ImageReverseIterator() [3/4]

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

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

◆ ImageReverseIterator() [4/4]

template<typename TImage >
itk::ImageReverseIterator< TImage >::ImageReverseIterator ( const ImageRegionReverseConstIterator< 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::ImageReverseIterator< TImage >::operator= ( const ImageRegionReverseConstIterator< TImage > &  it)
protected

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

◆ Set()

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

Set the pixel value

Definition at line 101 of file itkImageReverseIterator.h.

◆ Value()

template<typename TImage >
PixelType& itk::ImageReverseIterator< 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 110 of file itkImageReverseIterator.h.


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