Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

#include <itkImageRegionReverseConstIterator.h>

Inheritance diagram for itk::ImageRegionReverseConstIterator< TImage >:

Inheritance graph
[legend]
Collaboration diagram for itk::ImageRegionReverseConstIterator< TImage >:

Collaboration graph
[legend]

List of all members.


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 = it.Begin();
      for (; !it.IsAtEnd(); ++it)
         {
         *it += 100.0;
         }

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

unsigned long m_BeginOffset
const InternalPixelTypem_Buffer
unsigned long m_EndOffset
ImageType::ConstWeakPointer m_Image
unsigned long m_Offset
AccessorType m_PixelAccessor
AccessorFunctorType m_PixelAccessorFunctor
RegionType m_Region
const PixelType Get (void) const
const IndexType GetIndex ()
const RegionTypeGetRegion () 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 PixelTypeValue (void)
const PixelTypeValue (void) const
static unsigned int GetImageIteratorDimension ()

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 PixelContainer::Pointer PixelContainerPointer
typedef Superclass::PixelType PixelType
typedef Superclass::RegionType RegionType
typedef
ImageRegionReverseConstIterator 
Self
typedef Superclass::SizeType SizeType
typedef Superclass::SizeValueType SizeValueType
typedef
ImageReverseConstIterator
< TImage > 
Superclass

Public Member Functions

Self Begin (void) const
Self End (void) const
virtual const char * GetNameOfClass () const
void GoToBegin ()
void GoToEnd ()
 ImageRegionReverseConstIterator ()
 itkStaticConstMacro (ImageIteratorDimension, unsigned int, TImage::ImageDimension)
Selfoperator++ ()
Selfoperator-- ()
 ImageRegionReverseConstIterator (const ImageRegionIterator< TImage > &it)
 ImageRegionReverseConstIterator (const ImageReverseConstIterator< TImage > &it)
 ImageRegionReverseConstIterator (const ImageConstIterator< TImage > &it)
 ImageRegionReverseConstIterator (ImageType *ptr, const RegionType &region)
void SetIndex (const IndexType &ind)

Protected Attributes

unsigned long m_SpanBeginOffset
unsigned long m_SpanEndOffset

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::ImageRegionReverseConstIterator< TImage >::AccessorType

Accessor type that convert data between internal and external representations.

Reimplemented from itk::ImageReverseConstIterator< TImage >.

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

Definition at line 151 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.

Reimplemented from itk::ImageReverseConstIterator< TImage >.

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

Definition at line 135 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.

Reimplemented from itk::ImageReverseConstIterator< TImage >.

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

Definition at line 117 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.

Reimplemented from itk::ImageReverseConstIterator< TImage >.

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

Definition at line 127 of file itkImageRegionReverseConstIterator.h.

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::ImageReverseConstIterator< TImage >.

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

Definition at line 140 of file itkImageRegionReverseConstIterator.h.

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

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

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

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.

Reimplemented from itk::ImageReverseConstIterator< TImage >.

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

Definition at line 122 of file itkImageRegionReverseConstIterator.h.

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


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

template<typename TImage>
itk::ImageRegionReverseConstIterator< TImage >::ImageRegionReverseConstIterator ( 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 165 of file itkImageRegionReverseConstIterator.h.

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

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

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


Member Function Documentation

template<typename TImage>
Self itk::ImageRegionReverseConstIterator< TImage >::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

Reimplemented from itk::ImageReverseConstIterator< TImage >.

Reimplemented in itk::ImageRegionReverseIterator< TImage >.

template<typename TImage>
Self itk::ImageRegionReverseConstIterator< TImage >::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

Reimplemented from itk::ImageReverseConstIterator< TImage >.

Reimplemented in itk::ImageRegionReverseIterator< TImage >.

template<typename TImage>
const PixelType itk::ImageReverseConstIterator< TImage >::Get ( void   )  const [inline, inherited]

Get the pixel value

Definition at line 323 of file itkImageReverseConstIterator.h.

template<typename TImage>
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.

template<typename TImage>
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.

template<typename TImage>
virtual const char* itk::ImageRegionReverseConstIterator< TImage >::GetNameOfClass (  )  const [virtual]

Run-time type information (and related methods).

template<typename TImage>
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.

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.

Reimplemented from itk::ImageReverseConstIterator< TImage >.

Definition at line 213 of file itkImageRegionReverseConstIterator.h.

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.

Reimplemented from itk::ImageReverseConstIterator< TImage >.

Definition at line 224 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>
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.

template<typename TImage>
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.

template<typename TImage>
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.

template<typename TImage>
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.

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

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.

See also:
operator--(int)

Definition at line 324 of file itkImageRegionReverseConstIterator.h.

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

template<typename TImage>
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.

template<typename TImage>
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>
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.

template<typename TImage>
void itk::ImageRegionReverseConstIterator< TImage >::SetIndex ( const IndexType ind  )  [inline]

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.

template<typename TImage>
const PixelType& itk::ImageReverseConstIterator< TImage >::Value ( void   )  [inline, inherited]

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

template<typename TImage>
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.


Member Data Documentation

template<typename TImage>
unsigned long itk::ImageReverseConstIterator< TImage >::m_BeginOffset [protected, inherited]

template<typename TImage>
const InternalPixelType* itk::ImageReverseConstIterator< TImage >::m_Buffer [protected, inherited]

template<typename TImage>
unsigned long itk::ImageReverseConstIterator< TImage >::m_EndOffset [protected, inherited]

template<typename TImage>
ImageType::ConstWeakPointer itk::ImageReverseConstIterator< TImage >::m_Image [protected, inherited]

template<typename TImage>
unsigned long itk::ImageReverseConstIterator< TImage >::m_Offset [protected, inherited]

template<typename TImage>
AccessorType itk::ImageReverseConstIterator< TImage >::m_PixelAccessor [protected, inherited]

template<typename TImage>
AccessorFunctorType itk::ImageReverseConstIterator< TImage >::m_PixelAccessorFunctor [protected, inherited]

template<typename TImage>
RegionType itk::ImageReverseConstIterator< TImage >::m_Region [protected, inherited]

template<typename TImage>
unsigned long itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset [protected]

Definition at line 375 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>
unsigned long itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset [protected]

Definition at line 376 of file itkImageRegionReverseConstIterator.h.


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

Generated at Thu May 28 15:05:19 2009 for ITK by doxygen 1.5.5 written by Dimitri van Heesch, © 1997-2000