itk::ImageRegionReverseIterator< TImage > Class Template Reference

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

#include <itkImageRegionReverseIterator.h>

Inheritance diagram for itk::ImageRegionReverseIterator< TImage >:

Collaboration diagram for itk::ImageRegionReverseIterator< TImage >:

List of all members.

Public Types
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 Superclass::PixelContainerPointer	PixelContainerPointer
typedef Superclass::PixelType	PixelType
typedef Superclass::RegionType	RegionType
typedef ImageRegionReverseIterator	Self
typedef Superclass::SizeType	SizeType
typedef ImageRegionReverseConstIterator < TImage >	Superclass
Public Member Functions
Self	Begin (void) const
Self	End (void) const
	ImageRegionReverseIterator (const ImageConstIterator< TImage > &it)
	ImageRegionReverseIterator (ImageType *ptr, const RegionType &region)
	ImageRegionReverseIterator ()
void	Set (const PixelType &value) const
PixelType &	Value (void)
Protected Member Functions
	ImageRegionReverseIterator (const ImageRegionReverseConstIterator< TImage > &it)
Self &	operator= (const ImageRegionReverseConstIterator< TImage > &it)

---

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

---

Member Typedef Documentation

template<typename TImage >

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

Accessor type that convert data between internal and external representations.

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 86 of file itkImageRegionReverseIterator.h.

template<typename TImage >

typedef Superclass::ImageType itk::ImageRegionReverseIterator< 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 81 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Types inherited from the Superclass

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 77 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Internal Pixel Type

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 84 of file itkImageRegionReverseIterator.h.

template<typename TImage >

typedef Superclass::OffsetType itk::ImageRegionReverseIterator< 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 79 of file itkImageRegionReverseIterator.h.

template<typename TImage >

typedef Superclass::PixelContainer itk::ImageRegionReverseIterator< 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 82 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 83 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

External Pixel Type

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 85 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Region typedef support.

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 80 of file itkImageRegionReverseIterator.h.

template<typename TImage >

typedef ImageRegionReverseIterator itk::ImageRegionReverseIterator< TImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 73 of file itkImageRegionReverseIterator.h.

template<typename TImage >

typedef Superclass::SizeType itk::ImageRegionReverseIterator< 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 78 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

Definition at line 74 of file itkImageRegionReverseIterator.h.

---

Constructor & Destructor Documentation

template<typename TImage >

itk::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator

(

)

Default constructor. Needed since we provide a cast constructor.

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.

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.

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.

---

Member Function Documentation

template<typename TImage >

Self itk::ImageRegionReverseIterator< TImage >::Begin

(

void

)

const

Return an iterator for the beginning of the region. "Begin" is defined as the first pixel in the region.

Deprecated:

Use GoToBegin() instead

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

template<typename TImage >

Self itk::ImageRegionReverseIterator< TImage >::End

(

void

)

const

Return an iterator for the end of the region. "End" is defined as one pixel past the last pixel of the region.

Deprecated:

Use GoToEnd() instead

Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.

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.

template<typename TImage >

void itk::ImageRegionReverseIterator< TImage >::Set

(

const PixelType &

value

)

const [inline]

Set the pixel value

Reimplemented from itk::ImageReverseConstIterator< TImage >.

Definition at line 104 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

---

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

• itkImageRegionReverseIterator.h