itk::ImageRegionReverseIterator< TImage > Class Template Reference

#include <itkImageRegionReverseIterator.h>

Detailed Description

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

A multi-dimensional image iterator which only walks a region.

ImageRegionReverseIterator is a templated class to represent a multi-dimensional iterator. ImageRegionReverseIterator is templated over the image type ImageRegionReverseIterator is constrained to walk only within the specified region and along a line parallel to one of the coordinate axis.

Most of the functionality is inherited from the ImageRegionReverseConstIterator. The current class only adds write access to image pixels.

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 69 of file itkImageRegionReverseIterator.h.

Inheritance diagram for itk::ImageRegionReverseIterator< TImage >:

Collaboration diagram for itk::ImageRegionReverseIterator< TImage >:

Public Types
using	AccessorType
using	ImageType
using	IndexType
using	InternalPixelType
using	OffsetType
using	PixelContainer
using	PixelContainerPointer
using	PixelType
using	RegionType
using	Self = ImageRegionReverseIterator
using	SizeType
using	Superclass = ImageRegionReverseConstIterator<TImage>
Public Types inherited from itk::ImageRegionReverseConstIterator< TImage >
using	AccessorType
using	ImageType
using	IndexType
using	InternalPixelType
using	OffsetType
using	PixelContainer
using	PixelContainerPointer = typename PixelContainer::Pointer
using	PixelType
using	RegionType
using	Self = ImageRegionReverseConstIterator
using	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
	ImageRegionReverseIterator ()=default
	ImageRegionReverseIterator (const ImageConstIterator< TImage > &it)
	ImageRegionReverseIterator (ImageType *ptr, const RegionType &region)
void	Set (const PixelType &value) const
PixelType &	Value ()
Public Member Functions inherited from itk::ImageRegionReverseConstIterator< TImage >
const char *	GetNameOfClass () const override
void	GoToBegin ()
void	GoToEnd ()
	ImageRegionReverseConstIterator (const ImageConstIterator< TImage > &it)
	ImageRegionReverseConstIterator (const ImageRegionIterator< TImage > &it)
	ImageRegionReverseConstIterator (const ImageReverseConstIterator< TImage > &it)
Self &	operator++ ()
Self &	operator-- ()
	ImageRegionReverseConstIterator ()
	ImageRegionReverseConstIterator (const ImageType *ptr, const RegionType &region)
void	SetIndex (const IndexType &ind) override
Public Member Functions inherited from itk::ImageReverseConstIterator< TImage >
const PixelType	Get () const
const IndexType	GetIndex ()
const RegionType &	GetRegion () const
void	GoToBegin ()
void	GoToEnd ()
	ImageReverseConstIterator (const ImageType *ptr, const RegionType &region)
	ImageReverseConstIterator (const Self &it)
bool	IsAtBegin () const
bool	IsAtEnd () const
	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)
bool	operator== (const Self &it) const
void	Set (const PixelType &value) const
const PixelType &	Value ()
const PixelType &	Value () const
virtual	~ImageReverseConstIterator ()=default
	ImageReverseConstIterator ()
	ImageReverseConstIterator (const ImageConstIterator< TImage > &it)
Self &	operator= (const Self &it)
Self &	operator= (const ImageConstIterator< TImage > &it)

Protected Member Functions
	ImageRegionReverseIterator (const ImageRegionReverseConstIterator< TImage > &it)
Self &	operator= (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 >
SizeValueType	m_BeginOffset {}
const InternalPixelType *	m_Buffer {}
SizeValueType	m_EndOffset {}
ImageType::ConstWeakPointer	m_Image {}
SizeValueType	m_Offset {}
AccessorType	m_PixelAccessor {}
AccessorFunctorType	m_PixelAccessorFunctor {}
RegionType	m_Region {}

Member Typedef Documentation

AccessorType

template<typename TImage>

using itk::ImageReverseConstIterator< TImage >::AccessorType

Accessor type that convert data between internal and external representations.

Definition at line 143 of file itkImageReverseConstIterator.h.

ImageType

template<typename TImage>

using itk::ImageReverseConstIterator< TImage >::ImageType

Image type alias support

Definition at line 127 of file itkImageReverseConstIterator.h.

IndexType

template<typename TImage>

using itk::ImageReverseConstIterator< TImage >::IndexType

Index type alias support

Definition at line 112 of file itkImageReverseConstIterator.h.

InternalPixelType

template<typename TImage>

using itk::ImageReverseConstIterator< TImage >::InternalPixelType

Internal Pixel Type

Definition at line 136 of file itkImageReverseConstIterator.h.

OffsetType

template<typename TImage>

using itk::ImageReverseConstIterator< TImage >::OffsetType

Offset type alias support

Definition at line 120 of file itkImageReverseConstIterator.h.

PixelContainer

template<typename TImage>

using itk::ImageReverseConstIterator< 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 132 of file itkImageReverseConstIterator.h.

PixelContainerPointer

template<typename TImage>

using itk::ImageRegionReverseConstIterator< TImage >::PixelContainerPointer

Definition at line 133 of file itkImageRegionReverseConstIterator.h.

PixelType

template<typename TImage>

using itk::ImageReverseConstIterator< TImage >::PixelType

External Pixel Type

Definition at line 139 of file itkImageReverseConstIterator.h.

RegionType

template<typename TImage>

using itk::ImageReverseConstIterator< TImage >::RegionType

Region type alias support

Definition at line 123 of file itkImageReverseConstIterator.h.

Self

template<typename TImage>

using itk::ImageRegionReverseIterator< TImage >::Self = ImageRegionReverseIterator

Standard class type aliases.

Definition at line 73 of file itkImageRegionReverseIterator.h.

SizeType

template<typename TImage>

using itk::ImageReverseConstIterator< TImage >::SizeType

Size type alias support

Definition at line 116 of file itkImageReverseConstIterator.h.

Superclass

template<typename TImage>

using itk::ImageRegionReverseIterator< TImage >::Superclass = ImageRegionReverseConstIterator<TImage>

Definition at line 74 of file itkImageRegionReverseIterator.h.

Constructor & Destructor Documentation

ImageRegionReverseIterator() [1/4]

template<typename TImage>

itk::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator ( )

default

Default constructor. Needed since we provide a cast constructor.

ImageRegionReverseIterator() [2/4]

template<typename TImage>

itk::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator	(	ImageType *	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.

ImageRegionReverseIterator() [3/4]

template<typename TImage>

itk::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator

(

const ImageConstIterator< TImage > &

it

)

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

ImageRegionReverseIterator() [4/4]

template<typename TImage>

itk::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator ( const ImageRegionReverseConstIterator< TImage > & it )

protected

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

References itk::ImageRegionReverseConstIterator< TImage >::ImageRegionReverseConstIterator().

Member Function Documentation

operator=()

template<typename TImage>

Self & itk::ImageRegionReverseIterator< TImage >::operator= ( const ImageRegionReverseConstIterator< TImage > & it )

protected

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

References itk::ImageRegionReverseConstIterator< TImage >::ImageRegionReverseConstIterator().

Set()

template<typename TImage>

void itk::ImageRegionReverseIterator< TImage >::Set ( const PixelType & value ) const

inline

Set the pixel value

Definition at line 105 of file itkImageRegionReverseIterator.h.

References itk::ImageReverseConstIterator< TImage >::m_Buffer, itk::ImageReverseConstIterator< TImage >::m_Offset, and itk::ImageReverseConstIterator< TImage >::m_PixelAccessor.

Value()

template<typename TImage>

PixelType & itk::ImageRegionReverseIterator< 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 114 of file itkImageRegionReverseIterator.h.

References itk::ImageReverseConstIterator< TImage >::m_Buffer, and itk::ImageReverseConstIterator< TImage >::m_Offset.

---

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

• itkImageRegionReverseIterator.h