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

#include <itkImageReverseIterator.h>

Inheritance diagram for itk::ImageReverseIterator< TImage >:

Collaboration diagram for itk::ImageReverseIterator< TImage >:

Public Types
enum	{ ImageIteratorDimension = Superclass::ImageIteratorDimension }
typedef TImage::AccessorFunctorType	AccessorFunctorType
typedef Superclass::AccessorType	AccessorType
typedef Superclass::ImageType	ImageType
typedef Superclass::IndexType	IndexType
typedef Superclass::IndexValueType	IndexValueType
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::OffsetValueType	OffsetValueType
typedef Superclass::PixelContainer	PixelContainer
typedef Superclass::PixelContainerPointer	PixelContainerPointer
typedef Superclass::PixelType	PixelType
typedef Superclass::RegionType	RegionType
typedef ImageReverseIterator	Self
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef ImageRegionReverseConstIterator < TImage >	Superclass

Public Member Functions
	ImageReverseIterator ()
	ImageReverseIterator (ImageType *ptr, const RegionType &region)
	ImageReverseIterator (const ImageIteratorWithIndex< TImage > &it)
Self	Begin (void) const
Self	End (void) const
const PixelType	Get (void) const
const IndexType	GetIndex ()
virtual const char *	GetNameOfClass () const
const RegionType &	GetRegion () const
void	GoToBegin ()
void	GoToEnd ()
bool	IsAtBegin ()
bool	IsAtEnd ()
bool	operator!= (const Self &it) const
Self &	operator++ ()
Self &	operator-- ()
bool	operator== (const Self &it) const
void	Set (const PixelType &value) const
void	SetIndex (const IndexType &ind)
PixelType &	Value (void)
const PixelType &	Value (void) const

Static Public Member Functions
static unsigned int	GetImageIteratorDimension ()

Protected Member Functions
	ImageReverseIterator (const ImageRegionReverseConstIterator< TImage > &it)
Self &	operator= (const ImageRegionReverseConstIterator< TImage > &it)

Protected Attributes
unsigned long	m_BeginOffset
const InternalPixelType *	m_Buffer
unsigned long	m_EndOffset
ImageType::ConstWeakPointer	m_Image
unsigned long	m_Offset
AccessorType	m_PixelAccessor
AccessorFunctorType	m_PixelAccessorFunctor
RegionType	m_Region
unsigned long	m_SpanBeginOffset
unsigned long	m_SpanEndOffset

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

Member Typedef Documentation

template<typename TImage>

typedef TImage::AccessorFunctorType itk::ImageReverseConstIterator< TImage >::AccessorFunctorType

inherited

Functor to choose the appropriate accessor. (for Image vs VectorImage)

Definition at line 135 of file itkImageReverseConstIterator.h.

template<typename TImage >

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

Accessor type that convert data between internal and external representations.

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 83 of file itkImageReverseIterator.h.

template<typename TImage >

typedef Superclass::ImageType itk::ImageReverseIterator< 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.

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 78 of file itkImageReverseIterator.h.

template<typename TImage >

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

Types inherited from the Superclass

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 71 of file itkImageReverseIterator.h.

template<typename TImage >

typedef Superclass::IndexValueType itk::ImageReverseIterator< TImage >::IndexValueType

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 72 of file itkImageReverseIterator.h.

template<typename TImage >

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

Internal Pixel Type

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 81 of file itkImageReverseIterator.h.

template<typename TImage >

typedef Superclass::OffsetType itk::ImageReverseIterator< 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.

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 75 of file itkImageReverseIterator.h.

template<typename TImage >

typedef Superclass::OffsetValueType itk::ImageReverseIterator< TImage >::OffsetValueType

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 76 of file itkImageReverseIterator.h.

template<typename TImage >

typedef Superclass::PixelContainer itk::ImageReverseIterator< 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.

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 79 of file itkImageReverseIterator.h.

template<typename TImage >

typedef Superclass::PixelContainerPointer itk::ImageReverseIterator< TImage >::PixelContainerPointer

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 80 of file itkImageReverseIterator.h.

template<typename TImage >

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

External Pixel Type

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 82 of file itkImageReverseIterator.h.

template<typename TImage >

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

Region typedef support.

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 77 of file itkImageReverseIterator.h.

template<typename TImage >

typedef ImageReverseIterator itk::ImageReverseIterator< TImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 67 of file itkImageReverseIterator.h.

template<typename TImage >

typedef Superclass::SizeType itk::ImageReverseIterator< 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.

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 73 of file itkImageReverseIterator.h.

template<typename TImage >

typedef Superclass::SizeValueType itk::ImageReverseIterator< TImage >::SizeValueType

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 74 of file itkImageReverseIterator.h.

template<typename TImage >

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

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 68 of file itkImageReverseIterator.h.

Member Enumeration Documentation

template<typename TImage>

anonymous enum

inherited

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

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

Definition at line 112 of file itkImageRegionReverseConstIterator.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::ImageReverseIterator< TImage >::ImageReverseIterator ( )

Default constructor. Needed since we provide a cast constructor.

Definition at line 28 of file itkImageReverseIterator.txx.

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.

Definition at line 38 of file itkImageReverseIterator.txx.

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.

Definition at line 49 of file itkImageReverseIterator.txx.

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.

Definition at line 57 of file itkImageReverseIterator.txx.

Member Function Documentation

template<typename TImage >

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

inherited

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

Reimplemented from itk::ImageReverseConstIterator< TImage >.

Reimplemented in itk::ImageRegionReverseIterator< TImage >.

Definition at line 28 of file itkImageRegionReverseConstIterator.txx.

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

template<typename TImage >

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

inherited

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

Reimplemented from itk::ImageReverseConstIterator< TImage >.

Reimplemented in itk::ImageRegionReverseIterator< TImage >.

Definition at line 43 of file itkImageRegionReverseConstIterator.txx.

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

template<typename TImage>

const PixelType itk::ImageReverseConstIterator< TImage >::Get ( void ) const

inlineinherited

Get the pixel value

Definition at line 319 of file itkImageReverseConstIterator.h.

template<typename TImage>

static unsigned int itk::ImageReverseConstIterator< TImage >::GetImageIteratorDimension ( )

inlinestaticinherited

Get the dimension (size) of the index.

Definition at line 279 of file itkImageReverseConstIterator.h.

template<typename TImage>

const IndexType itk::ImageReverseConstIterator< TImage >::GetIndex ( void )

inlineinherited

Get the index. This provides a read only reference to the index. This causes the index to be calculated from pointer arithmetic and is therefore an expensive operation.

See also:: SetIndex

Definition at line 304 of file itkImageReverseConstIterator.h.

Referenced by itk::ImageRegionReverseConstIterator< TImage >::operator--().

template<typename TImage>

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

virtualinherited

Run-time type information (and related methods).

template<typename TImage>

const RegionType& itk::ImageReverseConstIterator< TImage >::GetRegion ( void ) const

inlineinherited

Get the region that this iterator walks. ImageReverseConstIterators know the beginning and the end of the region of the image to iterate over.

Definition at line 315 of file itkImageReverseConstIterator.h.

template<typename TImage>

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

inlineinherited

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

Reimplemented from itk::ImageReverseConstIterator< TImage >.

Definition at line 208 of file itkImageRegionReverseConstIterator.h.

Referenced by itk::ImageRegionReverseConstIterator< TImage >::Begin().

template<typename TImage>

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

inlineinherited

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.

Reimplemented from itk::ImageReverseConstIterator< TImage >.

Definition at line 219 of file itkImageRegionReverseConstIterator.h.

Referenced by itk::ImageRegionReverseConstIterator< TImage >::End().

template<typename TImage>

bool itk::ImageReverseConstIterator< TImage >::IsAtBegin ( void )

inlineinherited

Is the iterator at the beginning of the (reverse) region? "Begin" for a reverse iterator is the last pixel in the region.

Definition at line 367 of file itkImageReverseConstIterator.h.

template<typename TImage>

bool itk::ImageReverseConstIterator< TImage >::IsAtEnd ( void )

inlineinherited

Is the iterator at the end of the (reverse) region? "End" for a reverse iterator is one pixel before the first pixel in the region.

Definition at line 374 of file itkImageReverseConstIterator.h.

template<typename TImage>

bool itk::ImageReverseConstIterator< TImage >::operator!= ( const Self & it ) const

inlineinherited

Comparison operator. Two iterators are the same if they "point to" the same memory location

Definition at line 285 of file itkImageReverseConstIterator.h.

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

template<typename TImage>

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

inlineinherited

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

template<typename TImage>

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

inlineinherited

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.