#include <itkImageRegionReverseConstIterator.h>

Inheritance diagram for itk::ImageRegionReverseConstIterator< TImage >:

Collaboration diagram for itk::ImageRegionReverseConstIterator< TImage >:

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 http://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.

Public Types
enum	{ ImageIteratorDimension = Superclass::ImageIteratorDimension }

typedef Superclass::AccessorType	AccessorType

typedef Superclass::ImageType	ImageType

typedef Superclass::IndexType	IndexType

typedef Superclass::InternalPixelType	InternalPixelType

typedef Superclass::OffsetType	OffsetType

typedef Superclass::PixelContainer	PixelContainer

typedef PixelContainer::Pointer	PixelContainerPointer

typedef Superclass::PixelType	PixelType

typedef Superclass::RegionType	RegionType

typedef ImageRegionReverseConstIterator	Self

typedef Superclass::SizeType	SizeType

typedef ImageReverseConstIterator < TImage >	Superclass

Public Types inherited from itk::ImageReverseConstIterator< TImage >
typedef TImage::AccessorFunctorType	AccessorFunctorType

typedef TImage::AccessorType	AccessorType

typedef TImage	ImageType

typedef TImage::IndexType	IndexType

typedef TImage::InternalPixelType	InternalPixelType

typedef TImage::OffsetType	OffsetType

typedef TImage::PixelContainer	PixelContainer

typedef PixelContainer::Pointer	PixelContainerPointer

typedef TImage::PixelType	PixelType

typedef TImage::RegionType	RegionType

typedef ImageReverseConstIterator	Self

typedef TImage::SizeType	SizeType

Public Member Functions
virtual const char *	GetNameOfClass () const

void	GoToBegin ()

void	GoToEnd ()

	ImageRegionReverseConstIterator ()

	ImageRegionReverseConstIterator (const ImageConstIterator< TImage > &it)

	ImageRegionReverseConstIterator (const ImageReverseConstIterator< TImage > &it)

	ImageRegionReverseConstIterator (const ImageRegionIterator< TImage > &it)

	itkLegacyMacro (Self Begin(void) const)

	itkLegacyMacro (Self End(void) const)

Self &	operator++ ()

Self &	operator-- ()


	ImageRegionReverseConstIterator (const ImageType *ptr, const RegionType &region)


void	SetIndex (const IndexType &ind)

Public Member Functions inherited from itk::ImageReverseConstIterator< TImage >
	ImageReverseConstIterator (const Self &it)

	ImageReverseConstIterator (const ImageType *ptr, const RegionType &region)

virtual	~ImageReverseConstIterator ()

	ImageReverseConstIterator ()

	ImageReverseConstIterator (const ImageConstIterator< TImage > &it)

Self &	operator= (const Self &it)

Self &	operator= (const ImageConstIterator< TImage > &it)

bool	operator!= (const Self &it) const

bool	operator== (const Self &it) const

const IndexType	GetIndex ()

const RegionType &	GetRegion () const

const PixelType	Get (void) const

void	Set (const PixelType &value) const

const PixelType &	Value (void) const

const PixelType &	Value (void)

	itkLegacyMacro (Self Begin() const)

void	GoToBegin ()

	itkLegacyMacro (Self End() const)

void	GoToEnd ()

bool	IsAtBegin ()

bool	IsAtEnd ()

Protected Attributes
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 InternalPixelType *	m_Buffer

AccessorType	m_PixelAccessor

AccessorFunctorType	m_PixelAccessorFunctor

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 const unsigned int	ImageIteratorDimension = TImage::ImageDimension

Member Typedef Documentation

template<typename TImage>

typedef Superclass::AccessorType itk::ImageRegionReverseConstIterator< TImage >::AccessorType

Accessor type that convert data between internal and external representations.

Definition at line 150 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>

typedef Superclass::ImageType itk::ImageRegionReverseConstIterator< TImage >::ImageType

Image typedef support. 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 134 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>

typedef Superclass::IndexType itk::ImageRegionReverseConstIterator< TImage >::IndexType

Index typedef support. 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 119 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>

typedef Superclass::InternalPixelType itk::ImageRegionReverseConstIterator< TImage >::InternalPixelType

Internal Pixel Type

Definition at line 143 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>

typedef Superclass::OffsetType itk::ImageRegionReverseConstIterator< TImage >::OffsetType

Offset typedef support. 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 127 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>

typedef Superclass::PixelContainer itk::ImageRegionReverseConstIterator< TImage >::PixelContainer

PixelContainer typedef 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 139 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>

typedef PixelContainer::Pointer itk::ImageRegionReverseConstIterator< TImage >::PixelContainerPointer

Definition at line 140 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>

typedef Superclass::PixelType itk::ImageRegionReverseConstIterator< TImage >::PixelType

External Pixel Type

Definition at line 146 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>

typedef Superclass::RegionType itk::ImageRegionReverseConstIterator< TImage >::RegionType

Region typedef support.

Definition at line 130 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>

typedef ImageRegionReverseConstIterator itk::ImageRegionReverseConstIterator< TImage >::Self

Standard class typedefs.

Definition at line 108 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>

typedef Superclass::SizeType itk::ImageRegionReverseConstIterator< TImage >::SizeType

Size typedef support. 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 123 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>

typedef ImageReverseConstIterator< TImage > itk::ImageRegionReverseConstIterator< TImage >::Superclass

Definition at line 109 of file itkImageRegionReverseConstIterator.h.

Member Enumeration Documentation

template<typename TImage>

anonymous enum

Dimension of the image the iterator walks. This enum is needed so that 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.

Enumerator
ImageIteratorDimension

Definition at line 115 of file itkImageRegionReverseConstIterator.h.

Constructor & Destructor Documentation

template<typename TImage>

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

inline

Default constructor. Needed since we provide a cast constructor.

Definition at line 156 of file itkImageRegionReverseConstIterator.h.

References itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset.

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 164 of file itkImageRegionReverseConstIterator.h.

References itk::ImageReverseConstIterator< TImage >::m_BeginOffset, itk::ImageReverseConstIterator< TImage >::m_Region, itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset.

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 179 of file itkImageRegionReverseConstIterator.h.

References itk::ImageReverseConstIterator< TImage >::GetIndex(), itk::ImageReverseConstIterator< TImage >::m_Offset, itk::ImageReverseConstIterator< TImage >::m_Region, itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset.

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 190 of file itkImageRegionReverseConstIterator.h.

References itk::ImageReverseConstIterator< TImage >::GetIndex(), itk::ImageReverseConstIterator< TImage >::m_Offset, itk::ImageReverseConstIterator< TImage >::m_Region, itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset.

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 201 of file itkImageRegionReverseConstIterator.h.

References itk::ImageReverseConstIterator< TImage >::GetIndex(), itk::ImageReverseConstIterator< TImage >::m_Offset, itk::ImageReverseConstIterator< TImage >::m_Region, itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset.

Member Function Documentation

template<typename TImage>

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

virtual

Run-time type information (and related methods).

template<typename TImage>

void itk::ImageRegionReverseConstIterator< TImage >::GoToBegin ( void )

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 212 of file itkImageRegionReverseConstIterator.h.

References itk::ImageReverseConstIterator< TImage >::GoToBegin(), itk::ImageReverseConstIterator< TImage >::m_BeginOffset, itk::ImageReverseConstIterator< TImage >::m_Region, itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset.

template<typename TImage>

void itk::ImageRegionReverseConstIterator< TImage >::GoToEnd ( void )

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.

References itk::ImageReverseConstIterator< TImage >::GoToEnd(), itk::ImageReverseConstIterator< TImage >::m_EndOffset, itk::ImageReverseConstIterator< TImage >::m_Region, itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset.

template<typename TImage>

itk::ImageRegionReverseConstIterator< TImage >::itkLegacyMacro ( Self Begin(void) const )

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

Deprecated:: Use GoToBegin() instead

template<typename TImage>

itk::ImageRegionReverseConstIterator< TImage >::itkLegacyMacro ( Self End(void) const )

Return an iterator for the end of the region. "End" for a reverse iterator is one pixel before the first pixel in the region.

Deprecated:: Use GoToEnd() instead

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 264 of file itkImageRegionReverseConstIterator.h.

References itk::ImageRegionReverseConstIterator< TImage >::ImageIteratorDimension, itk::ImageReverseConstIterator< TImage >::m_Image, itk::ImageReverseConstIterator< TImage >::m_Offset, itk::ImageReverseConstIterator< TImage >::m_Region, itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset.

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.