itk::ImageReverseIterator< TImage > Class Template Reference
[Image Iterators]

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

#include <itkImageReverseIterator.h>

Inheritance diagram for itk::ImageReverseIterator< TImage >:

[legend]

Collaboration diagram for itk::ImageReverseIterator< TImage >:

[legend]

List of all members.

Public Types
enum
typedef TImage::AccessorFunctorType	AccessorFunctorType
typedef Superclass::AccessorType	AccessorType
Public Member Functions
Self	Begin (void) const
Self	End (void) const
virtual const char *	GetNameOfClass () const
void	GoToBegin ()
void	GoToEnd ()
	ImageReverseIterator (const ImageIteratorWithIndex< TImage > &it)
	ImageReverseIterator (ImageType *ptr, const RegionType &region)
	ImageReverseIterator ()
	itkStaticConstMacro (ImageIteratorDimension, unsigned int, TImage::ImageDimension)
Self &	operator++ ()
Self &	operator-- ()
void	Set (const PixelType &value) const
PixelType &	Value (void)
void	SetIndex (const IndexType &ind)
Protected Member Functions
	ImageReverseIterator (const ImageRegionReverseConstIterator< TImage > &it)
Self &	operator= (const ImageRegionReverseConstIterator< TImage > &it)
Protected Attributes
unsigned long	m_SpanBeginOffset
unsigned long	m_SpanEndOffset
const PixelType	Get (void) const
const IndexType	GetIndex ()
const RegionType &	GetRegion () const
bool	IsAtBegin ()
bool	IsAtEnd ()
bool	operator!= (const Self &it) const
bool	operator== (const Self &it) const
void	Set (const PixelType &value) const
virtual void	SetIndex (const IndexType &ind)
const PixelType &	Value (void) const
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
static unsigned int	GetImageIteratorDimension ()

---

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

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

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.

Definition at line 113 of file itkImageRegionReverseConstIterator.h.

---

Constructor & Destructor Documentation

template<typename TImage >

itk::ImageReverseIterator< TImage >::ImageReverseIterator

(

)

Default constructor. Needed since we provide a cast constructor.

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.

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.

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

Self 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 >.

Self 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 >.

const PixelType itk::ImageReverseConstIterator< TImage >::Get

(

void

)

const [inline, inherited]

Get the pixel value

Definition at line 323 of file itkImageReverseConstIterator.h.

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

(

)

[inline, static, inherited]

Get the dimension (size) of the index.

Definition at line 283 of file itkImageReverseConstIterator.h.

const IndexType itk::ImageReverseConstIterator< TImage >::GetIndex

(

void

)

[inline, inherited]

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 308 of file itkImageReverseConstIterator.h.

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

(

)

const [virtual, inherited]

Run-time type information (and related methods).

const RegionType& itk::ImageReverseConstIterator< TImage >::GetRegion

(

)

const [inline, inherited]

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 319 of file itkImageReverseConstIterator.h.

void itk::ImageRegionReverseConstIterator< TImage >::GoToBegin

(

void

)

[inline, inherited]

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

void itk::ImageRegionReverseConstIterator< TImage >::GoToEnd

(

void

)

[inline, inherited]

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

bool itk::ImageReverseConstIterator< TImage >::IsAtBegin

(

void

)

[inline, inherited]

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 371 of file itkImageReverseConstIterator.h.

bool itk::ImageReverseConstIterator< TImage >::IsAtEnd

(

void

)

[inline, inherited]

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 378 of file itkImageReverseConstIterator.h.

itk::ImageReverseConstIterator< TImage >::itkStaticConstMacro	(	ImageIteratorDimension	,
		unsigned	int,
		TImage ::ImageDimension
	)			[inherited]

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.

bool itk::ImageReverseConstIterator< TImage >::operator!=

(

const Self &

it

)

const [inline, inherited]

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

Definition at line 289 of file itkImageReverseConstIterator.h.

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

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

(

)

[inline, inherited]

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

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

(

)

[inline, inherited]

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

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

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.

bool itk::ImageReverseConstIterator< TImage >::operator==

(

const Self &

it

)

const [inline, inherited]

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

Definition at line 298 of file itkImageReverseConstIterator.h.

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

void itk::ImageReverseConstIterator< TImage >::Set

(

const PixelType &

value

)

const [inline, inherited]

Set the pixel value

Definition at line 327 of file itkImageReverseConstIterator.h.

template<typename TImage >

void itk::ImageReverseIterator< TImage >::Set

(

const PixelType &

value

)

const [inline]

Set the pixel value

Definition at line 102 of file itkImageReverseIterator.h.

virtual void itk::ImageReverseConstIterator< TImage >::SetIndex

(

const IndexType &

ind

)

[inline, virtual, inherited]

Set the index. No bounds checking is performed.

See also:

GetIndex

Definition at line 313 of file itkImageReverseConstIterator.h.

void itk::ImageRegionReverseConstIterator< TImage >::SetIndex

(

const IndexType &

ind

)

[inline, inherited]

Set the index. No bounds checking is performed. This is overridden from the parent because we have an extra ivar.

See also:

GetIndex

Definition at line 248 of file itkImageRegionReverseConstIterator.h.

const PixelType& itk::ImageReverseConstIterator< TImage >::Value

(

void

)

const [inline, inherited]

Return a const reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.

Definition at line 336 of file itkImageReverseConstIterator.h.

template<typename TImage >

PixelType& itk::ImageReverseIterator< TImage >::Value

(

void

)

[inline]

Return a reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.

Reimplemented from itk::ImageReverseConstIterator< TImage >.

Definition at line 108 of file itkImageReverseIterator.h.

---

Member Data Documentation

unsigned long itk::ImageReverseConstIterator< TImage >::m_BeginOffset [protected, 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

Definition at line 388 of file itkImageReverseConstIterator.h.

const InternalPixelType* itk::ImageReverseConstIterator< TImage >::m_Buffer [protected, 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

Definition at line 391 of file itkImageReverseConstIterator.h.

unsigned long itk::ImageReverseConstIterator< TImage >::m_EndOffset [protected, 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

Definition at line 389 of file itkImageReverseConstIterator.h.

ImageType::ConstWeakPointer itk::ImageReverseConstIterator< TImage >::m_Image [protected, 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

Definition at line 384 of file itkImageReverseConstIterator.h.

unsigned long itk::ImageReverseConstIterator< TImage >::m_Offset [protected, 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

Definition at line 387 of file itkImageReverseConstIterator.h.

AccessorType itk::ImageReverseConstIterator< TImage >::m_PixelAccessor [protected, 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

Definition at line 393 of file itkImageReverseConstIterator.h.

AccessorFunctorType itk::ImageReverseConstIterator< TImage >::m_PixelAccessorFunctor [protected, 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

Definition at line 394 of file itkImageReverseConstIterator.h.

RegionType itk::ImageReverseConstIterator< TImage >::m_Region [protected, 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

Definition at line 385 of file itkImageReverseConstIterator.h.

unsigned long itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset [protected, inherited]

Definition at line 375 of file itkImageRegionReverseConstIterator.h.

unsigned long itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset [protected, inherited]

Definition at line 376 of file itkImageRegionReverseConstIterator.h.

---

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

• itkImageReverseIterator.h