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

#include <itkImageRegionReverseConstIterator.h>

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

virtual const char * GetNameOfClass () const
 
- 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
 
 ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)
 
const IndexType GetIndex ()
 
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
 
SizeValueType m_SpanBeginOffset
 
SizeValueType m_SpanEndOffset
 
 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-- ()
 

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

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

ImageRegionReverseConstIterator is a templated class to represent a multi-dimensional iterator. ImageRegionReverseConstIterator is templated over the dimension of the image and the data type of the image. ImageRegionReverseConstIterator is constrained to walk only within the specified region.

ImageRegionReverseConstIterator 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, ImageRegionReverseConstIterator holds a reference to the image over which it is traversing.

ImageRegionReverseConstIterator 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. For a reverse iterator, operator++ moves backwards through the region. 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 previous row, starting at the last pixel in the row that is part of the region. This allows for simple processing loops of the form:

it.GoToBegin();
for (; !it.IsAtEnd(); ++it)
{
std::cout << it.Value() << std::endl;
}
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 103 of file itkImageRegionReverseConstIterator.h.

Member Typedef Documentation

◆ AccessorType

template<typename TImage>
using itk::ImageReverseConstIterator< TImage >::AccessorType = typename TImage::AccessorType

Accessor type that convert data between internal and external representations.

Definition at line 131 of file itkImageReverseConstIterator.h.

◆ ImageType

template<typename TImage>
using itk::ImageReverseConstIterator< TImage >::ImageType = TImage

Image type alias support

Definition at line 115 of file itkImageReverseConstIterator.h.

◆ IndexType

template<typename TImage>
using itk::ImageReverseConstIterator< TImage >::IndexType = typename TImage::IndexType

Index type alias support

Definition at line 103 of file itkImageReverseConstIterator.h.

◆ InternalPixelType

template<typename TImage>
using itk::ImageReverseConstIterator< TImage >::InternalPixelType = typename TImage::InternalPixelType

Internal Pixel Type

Definition at line 124 of file itkImageReverseConstIterator.h.

◆ OffsetType

template<typename TImage>
using itk::ImageReverseConstIterator< TImage >::OffsetType = typename TImage::OffsetType

Offset type alias support

Definition at line 109 of file itkImageReverseConstIterator.h.

◆ PixelContainer

template<typename TImage>
using itk::ImageReverseConstIterator< TImage >::PixelContainer = typename TImage::PixelContainer

PixelContainer type alias support Used to refer to the container for the pixel data. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc.

Definition at line 120 of file itkImageReverseConstIterator.h.

◆ PixelContainerPointer

template<typename TImage>
using itk::ImageRegionReverseConstIterator< TImage >::PixelContainerPointer = typename PixelContainer::Pointer

Definition at line 133 of file itkImageRegionReverseConstIterator.h.

◆ PixelType

template<typename TImage>
using itk::ImageReverseConstIterator< TImage >::PixelType = typename TImage::PixelType

External Pixel Type

Definition at line 127 of file itkImageReverseConstIterator.h.

◆ RegionType

template<typename TImage>
using itk::ImageReverseConstIterator< TImage >::RegionType = typename TImage::RegionType

Region type alias support

Definition at line 112 of file itkImageReverseConstIterator.h.

◆ Self

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

Standard class type aliases.

Definition at line 107 of file itkImageRegionReverseConstIterator.h.

◆ SizeType

template<typename TImage>
using itk::ImageReverseConstIterator< TImage >::SizeType = typename TImage::SizeType

Size type alias support

Definition at line 106 of file itkImageReverseConstIterator.h.

◆ Superclass

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

Definition at line 108 of file itkImageRegionReverseConstIterator.h.

Constructor & Destructor Documentation

◆ ImageRegionReverseConstIterator() [1/5]

template<typename TImage>
itk::ImageRegionReverseConstIterator< TImage >::ImageRegionReverseConstIterator ( )
inline

Default constructor. Needed since we provide a cast constructor.

Definition at line 149 of file itkImageRegionReverseConstIterator.h.

◆ ImageRegionReverseConstIterator() [2/5]

template<typename TImage>
itk::ImageRegionReverseConstIterator< TImage >::ImageRegionReverseConstIterator ( 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 159 of file itkImageRegionReverseConstIterator.h.

◆ ImageRegionReverseConstIterator() [3/5]

template<typename TImage>
itk::ImageRegionReverseConstIterator< TImage >::ImageRegionReverseConstIterator ( const ImageConstIterator< TImage > &  it)
inline

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

Definition at line 174 of file itkImageRegionReverseConstIterator.h.

◆ ImageRegionReverseConstIterator() [4/5]

template<typename TImage>
itk::ImageRegionReverseConstIterator< TImage >::ImageRegionReverseConstIterator ( const ImageReverseConstIterator< TImage > &  it)
inline

Constructor that takes in a reverse image iterator. This can be used to cast between the various types of reverse image iterators.

Definition at line 186 of file itkImageRegionReverseConstIterator.h.

◆ ImageRegionReverseConstIterator() [5/5]

template<typename TImage>
itk::ImageRegionReverseConstIterator< TImage >::ImageRegionReverseConstIterator ( const ImageRegionIterator< TImage > &  it)
inline

Constructor that takes in an image region iterator. This can be used to cast between the various types of reverse image iterators.

Definition at line 198 of file itkImageRegionReverseConstIterator.h.

Member Function Documentation

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ GoToBegin()

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

Move an iterator to the beginning of the region. "Begin" for a reverse iterator is the last pixel in the region.

Definition at line 211 of file itkImageRegionReverseConstIterator.h.

◆ GoToEnd()

template<typename TImage>
void itk::ImageRegionReverseConstIterator< TImage >::GoToEnd ( )
inline

Move an iterator to the end of the region. "End" for a reverse iterator is defined as one pixel before the first pixel in the region.

Definition at line 223 of file itkImageRegionReverseConstIterator.h.

◆ operator++()

template<typename TImage>
Self& itk::ImageRegionReverseConstIterator< TImage >::operator++ ( )
inline

iterator's index. For a reverse iterator, this moves backwards through the region. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the start of the row of the region to the end of the previous row of the region) up until the iterator tries to moves before the first pixel of the region. Here, the iterator will be set to be one pixel before the start of the region.

See also
operator++(int).

Definition at line 254 of file itkImageRegionReverseConstIterator.h.

References itk::ImageReverseConstIterator< TImage >::GetIndex().

◆ operator--()

template<typename TImage>
Self& itk::ImageRegionReverseConstIterator< TImage >::operator-- ( )
inline

Decrement (prefix) the fastest moving dimension of the iterator's index. For a reverse iterator, this moves forward through the region. 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 start 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 310 of file itkImageRegionReverseConstIterator.h.

References itk::ImageReverseConstIterator< TImage >::GetIndex().

◆ SetIndex()

template<typename TImage>
void itk::ImageRegionReverseConstIterator< 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::ImageReverseConstIterator< TImage >.

Definition at line 236 of file itkImageRegionReverseConstIterator.h.

Member Data Documentation

◆ m_SpanBeginOffset

template<typename TImage>
SizeValueType itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset
protected

Default constructor. Needed since we provide a cast constructor.

Definition at line 359 of file itkImageRegionReverseConstIterator.h.

◆ m_SpanEndOffset

template<typename TImage>
SizeValueType itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset
protected

Default constructor. Needed since we provide a cast constructor.

Definition at line 360 of file itkImageRegionReverseConstIterator.h.


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