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

#include <itkImageReverseConstIterator.h>

Inheritance diagram for itk::ImageReverseConstIterator< TImage >:

[legend]List of all members.

---

Detailed Description

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

Multi-dimensional image iterator.

ImageReverseConstIterator is a templated class to represent a multi-dimensional iterator. ImageReverseConstIterator is templated over the dimension of the image and the data type of the image.

ImageReverseConstIterator is a base class for all the reverse image iterators. It provides the basic construction and comparison operations. However, it does not provide mechanisms for moving the iterator. A subclass of ImageReverseConstIterator must be used to move the iterator.

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

ImageReverseConstIterator assumes a particular layout of the image data. In particular, the data is arranged in a 1D array as if it were [][][][slice][row][col] with Index[0] = col, Index[1] = row, Index[2] = slice, etc.

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

	ImageReverseConstIterator (const ImageConstIterator< TImage > &it)
	ImageReverseConstIterator (ImageType *ptr, const RegionType &region)
bool	operator!= (const Self &it) const
Self &	operator= (const ImageConstIterator< TImage > &it)
Self &	operator= (const Self &it)
static unsigned int	GetImageIteratorDimension ()
Public Types
typedef TImage::AccessorFunctorType	AccessorFunctorType
typedef TImage::AccessorType	AccessorType
typedef TImage	ImageType
typedef TImage::IndexType	IndexType
typedef TImage::IndexValueType	IndexValueType
typedef TImage::InternalPixelType	InternalPixelType
typedef TImage::OffsetType	OffsetType
typedef TImage::OffsetValueType	OffsetValueType
typedef TImage::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef TImage::PixelType	PixelType
typedef TImage::RegionType	RegionType
typedef ImageReverseConstIterator	Self
typedef TImage::SizeType	SizeType
typedef TImage::SizeValueType	SizeValueType
Public Member Functions
Self	Begin () const
Self	End () const
const PixelType	Get (void) const
const IndexType	GetIndex ()
const RegionType &	GetRegion () const
void	GoToBegin ()
void	GoToEnd ()
	ImageReverseConstIterator (const Self &it)
bool	IsAtBegin ()
bool	IsAtEnd ()
	itkStaticConstMacro (ImageIteratorDimension, unsigned int, TImage::ImageDimension)
void	Set (const PixelType &value) const
virtual void	SetIndex (const IndexType &ind)
const PixelType &	Value (void)
const PixelType &	Value (void) const
virtual	~ImageReverseConstIterator ()
bool	operator== (const Self &it) const
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

---

Member Typedef Documentation

template<typename TImage>

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

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

Definition at line 135 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef TImage::AccessorType itk::ImageReverseConstIterator< TImage >::AccessorType

Accessor type that convert data between internal and external representations.

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 132 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef TImage itk::ImageReverseConstIterator< TImage >::ImageType

Image typedef support.

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 116 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef TImage::IndexType itk::ImageReverseConstIterator< TImage >::IndexType

Index typedef support.

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 101 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef TImage::IndexValueType itk::ImageReverseConstIterator< TImage >::IndexValueType

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 102 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef TImage::InternalPixelType itk::ImageReverseConstIterator< TImage >::InternalPixelType

Internal Pixel Type

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 125 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef TImage::OffsetType itk::ImageReverseConstIterator< TImage >::OffsetType

Offset typedef support.

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 109 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef TImage::OffsetValueType itk::ImageReverseConstIterator< TImage >::OffsetValueType

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 110 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef TImage::PixelContainer itk::ImageReverseConstIterator< 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 in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 121 of file itkImageReverseConstIterator.h.

template<typename TImage>

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

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 122 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef TImage::PixelType itk::ImageReverseConstIterator< TImage >::PixelType

External Pixel Type

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 128 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef TImage::RegionType itk::ImageReverseConstIterator< TImage >::RegionType

Region typedef support.

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 113 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef ImageReverseConstIterator itk::ImageReverseConstIterator< TImage >::Self

Standard class typedefs.

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 91 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef TImage::SizeType itk::ImageReverseConstIterator< TImage >::SizeType

Size typedef support.

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 105 of file itkImageReverseConstIterator.h.

template<typename TImage>

typedef TImage::SizeValueType itk::ImageReverseConstIterator< TImage >::SizeValueType

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 106 of file itkImageReverseConstIterator.h.

---

Constructor & Destructor Documentation

template<typename TImage>

itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator

(

)

[inline]

Default Constructor. Need to provide a default constructor since we provide a copy constructor.

Definition at line 139 of file itkImageReverseConstIterator.h.

template<typename TImage>

virtual itk::ImageReverseConstIterator< TImage >::~ImageReverseConstIterator

(

)

[inline, virtual]

Default Destructor.

Definition at line 152 of file itkImageReverseConstIterator.h.

template<typename TImage>

itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator

(

const Self &

it

)

[inline]

Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted.

Definition at line 156 of file itkImageReverseConstIterator.h.

References itk::ImageReverseConstIterator< TImage >::m_BeginOffset, itk::ImageReverseConstIterator< TImage >::m_Buffer, itk::ImageReverseConstIterator< TImage >::m_EndOffset, itk::ImageReverseConstIterator< TImage >::m_Image, itk::ImageReverseConstIterator< TImage >::m_Offset, itk::ImageReverseConstIterator< TImage >::m_PixelAccessor, itk::ImageReverseConstIterator< TImage >::m_PixelAccessorFunctor, and itk::ImageReverseConstIterator< TImage >::m_Region.

template<typename TImage>

itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator	(	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 173 of file itkImageReverseConstIterator.h.

template<typename TImage>

itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator

(

const ImageConstIterator< TImage > &

it

)

[inline]

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.

Definition at line 208 of file itkImageReverseConstIterator.h.

References itk::ImageConstIterator< TImage >::GetImage(), itk::ImageConstIterator< TImage >::GetIndex(), and itk::ImageConstIterator< TImage >::GetRegion().

template<typename TImage>

itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator

(

)

[inline]

Default Constructor. Need to provide a default constructor since we provide a copy constructor.

Definition at line 139 of file itkImageReverseConstIterator.h.

---

Member Function Documentation

template<typename TImage>

Self itk::ImageReverseConstIterator< TImage >::Begin

(

)

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

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, and itk::ImageRegionReverseIterator< TImage >.

template<typename TImage>

Self itk::ImageReverseConstIterator< TImage >::End

(

)

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

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >, and itk::ImageRegionReverseIterator< TImage >.

template<typename TImage>

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

(

void

)

const [inline]

Get the pixel value

Definition at line 379 of file itkImageReverseConstIterator.h.

template<typename TImage>

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

(

)

[inline, static]

Get the dimension (size) of the index.

Definition at line 286 of file itkImageReverseConstIterator.h.

template<typename TImage>

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

(

void

)

[inline]

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

template<typename TImage>

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

(

)

const [inline]

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

template<typename TImage>

void itk::ImageReverseConstIterator< 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.

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 408 of file itkImageReverseConstIterator.h.

template<typename TImage>

void itk::ImageReverseConstIterator< 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.

Reimplemented in itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 420 of file itkImageReverseConstIterator.h.

template<typename TImage>

bool itk::ImageReverseConstIterator< TImage >::IsAtBegin

(

void

)

[inline]

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

template<typename TImage>

bool itk::ImageReverseConstIterator< TImage >::IsAtEnd

(

void

)

[inline]

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

template<typename TImage>

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

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.

template<typename TImage>

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

(

const Self &

it

)

const [inline]

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

Definition at line 292 of file itkImageReverseConstIterator.h.

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

template<typename TImage>

Self& itk::ImageReverseConstIterator< TImage >::operator=

(

const ImageConstIterator< TImage > &

it

)

[inline]

operator= is provided to make sure the handle to the image is properly reference counted.

Definition at line 255 of file itkImageReverseConstIterator.h.

References itk::ImageConstIterator< TImage >::GetImage(), itk::ImageConstIterator< TImage >::GetIndex(), and itk::ImageConstIterator< TImage >::GetRegion().

template<typename TImage>

Self& itk::ImageReverseConstIterator< TImage >::operator=

(

const Self &

it

)

[inline]

operator= is provided to make sure the handle to the image is properly reference counted.

Definition at line 238 of file itkImageReverseConstIterator.h.

References itk::ImageReverseConstIterator< TImage >::m_BeginOffset, itk::ImageReverseConstIterator< TImage >::m_Buffer, itk::ImageReverseConstIterator< TImage >::m_EndOffset, itk::ImageReverseConstIterator< TImage >::m_Image, itk::ImageReverseConstIterator< TImage >::m_Offset, itk::ImageReverseConstIterator< TImage >::m_PixelAccessor, and itk::ImageReverseConstIterator< TImage >::m_Region.

template<typename TImage>

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

(

const Self &

it

)

const [inline]

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

Definition at line 302 of file itkImageReverseConstIterator.h.

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

template<typename TImage>

void itk::ImageReverseConstIterator< TImage >::Set

(

const PixelType &

value

)

const [inline]

Set the pixel value

Definition at line 383 of file itkImageReverseConstIterator.h.

template<typename TImage>

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

(

const IndexType &

ind

)

[inline, virtual]

Set the index. No bounds checking is performed.

See also:

GetIndex

Definition at line 369 of file itkImageReverseConstIterator.h.

template<typename TImage>

const PixelType& itk::ImageReverseConstIterator< 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 in itk::ImageRegionReverseIterator< TImage >, and itk::ImageReverseIterator< TImage >.

Definition at line 398 of file itkImageReverseConstIterator.h.

template<typename TImage>

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

(

void

)

const [inline]

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

---

Member Data Documentation

template<typename TImage>

unsigned long itk::ImageReverseConstIterator< TImage >::m_BeginOffset [protected]

Definition at line 444 of file itkImageReverseConstIterator.h.

Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().

template<typename TImage>

const InternalPixelType* itk::ImageReverseConstIterator< TImage >::m_Buffer [protected]

Definition at line 447 of file itkImageReverseConstIterator.h.

Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), itk::ImageReverseConstIterator< TImage >::operator!=(), itk::ImageReverseConstIterator< TImage >::operator=(), and itk::ImageReverseConstIterator< TImage >::operator==().

template<typename TImage>

unsigned long itk::ImageReverseConstIterator< TImage >::m_EndOffset [protected]

Definition at line 445 of file itkImageReverseConstIterator.h.

Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().

template<typename TImage>

ImageType::ConstWeakPointer itk::ImageReverseConstIterator< TImage >::m_Image [protected]

Definition at line 440 of file itkImageReverseConstIterator.h.

Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().

template<typename TImage>

unsigned long itk::ImageReverseConstIterator< TImage >::m_Offset [protected]

Definition at line 443 of file itkImageReverseConstIterator.h.

Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), itk::ImageReverseConstIterator< TImage >::operator!=(), itk::ImageReverseConstIterator< TImage >::operator=(), and itk::ImageReverseConstIterator< TImage >::operator==().

template<typename TImage>

AccessorType itk::ImageReverseConstIterator< TImage >::m_PixelAccessor [protected]

Definition at line 449 of file itkImageReverseConstIterator.h.

Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().

template<typename TImage>

AccessorFunctorType itk::ImageReverseConstIterator< TImage >::m_PixelAccessorFunctor [protected]

Definition at line 450 of file itkImageReverseConstIterator.h.

Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator().

template<typename TImage>

RegionType itk::ImageReverseConstIterator< TImage >::m_Region [protected]

Definition at line 441 of file itkImageReverseConstIterator.h.

Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().

---

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

• itkImageReverseConstIterator.h

---