Orfeo Toolbox  4.2
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
itk::ImageRegionReverseConstIterator< TImage > Class Template Reference

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

#include <itkImageRegionReverseConstIterator.h>

+ Inheritance diagram for itk::ImageRegionReverseConstIterator< TImage >:
+ Collaboration diagram for itk::ImageRegionReverseConstIterator< 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::InternalPixelType 
InternalPixelType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::PixelContainer PixelContainer
 
typedef PixelContainer::Pointer PixelContainerPointer
 
typedef Superclass::PixelType PixelType
 
typedef Superclass::RegionType RegionType
 
typedef
ImageRegionReverseConstIterator 
Self
 
typedef Superclass::SizeType SizeType
 
typedef
ImageReverseConstIterator
< TImage > 
Superclass
 

Public Member Functions

 ImageRegionReverseConstIterator ()
 
 ImageRegionReverseConstIterator (const ImageType *ptr, const RegionType &region)
 
 ImageRegionReverseConstIterator (const ImageConstIterator< TImage > &it)
 
 ImageRegionReverseConstIterator (const ImageReverseConstIterator< TImage > &it)
 
 ImageRegionReverseConstIterator (const ImageRegionIterator< TImage > &it)
 
const PixelType Get (void) const
 
const IndexType GetIndex ()
 
virtual const char * GetNameOfClass () const
 
const RegionTypeGetRegion () const
 
void GoToBegin ()
 
void GoToEnd ()
 
bool IsAtBegin ()
 
bool IsAtEnd ()
 
 itkLegacyMacro (Self Begin(void) const)
 
 itkLegacyMacro (Self End(void) const)
 
 itkLegacyMacro (Self Begin() const)
 
 itkLegacyMacro (Self End() const)
 
bool operator!= (const Self &it) const
 
Selfoperator++ ()
 
Selfoperator-- ()
 
bool operator== (const Self &it) const
 
void Set (const PixelType &value) const
 
void SetIndex (const IndexType &ind)
 
const PixelTypeValue (void) const
 
const PixelTypeValue (void)
 

Static Public Member Functions

static unsigned int GetImageIteratorDimension ()
 

Protected Attributes

SizeValueType m_BeginOffset
 
const InternalPixelTypem_Buffer
 
SizeValueType m_EndOffset
 
ImageType::ConstWeakPointer m_Image
 
SizeValueType m_Offset
 
AccessorType m_PixelAccessor
 
AccessorFunctorType m_PixelAccessorFunctor
 
RegionType m_Region
 
SizeValueType m_SpanBeginOffset
 
SizeValueType m_SpanEndOffset
 

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.GoToBegin();
for (; !it.IsAtEnd(); ++it)
{
std::cout << it.Value() << std::endl;
}
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 103 of file itkImageRegionReverseConstIterator.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 132 of file itkImageReverseConstIterator.h.

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

Accessor type that convert data between internal and external representations.

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

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

Definition at line 118 of file itkImageRegionReverseConstIterator.h.

Internal Pixel Type

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

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

Definition at line 138 of file itkImageRegionReverseConstIterator.h.

template<typename TImage>
typedef PixelContainer::Pointer itk::ImageRegionReverseConstIterator< TImage >::PixelContainerPointer

Definition at line 139 of file itkImageRegionReverseConstIterator.h.

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

External Pixel Type

Definition at line 145 of file itkImageRegionReverseConstIterator.h.

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

Region typedef support.

Definition at line 129 of file itkImageRegionReverseConstIterator.h.

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

Standard class typedefs.

Definition at line 107 of file itkImageRegionReverseConstIterator.h.

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.

Definition at line 122 of file itkImageRegionReverseConstIterator.h.

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

Definition at line 108 of file itkImageRegionReverseConstIterator.h.

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

References itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset.

template<typename TImage>
itk::ImageRegionReverseConstIterator< TImage >::ImageRegionReverseConstIterator ( const ImageType ptr,
const RegionType region 
)
inline
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 177 of file itkImageRegionReverseConstIterator.h.

References itk::ImageReverseConstIterator< TImage >::GetIndex(), itk::ImageReverseConstIterator< TImage >::m_Offset, itk::ImageReverseConstIterator< TImage >::m_Region, itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset.

template<typename TImage>
itk::ImageRegionReverseConstIterator< TImage >::ImageRegionReverseConstIterator ( const ImageReverseConstIterator< TImage > &  it)
inline
template<typename TImage>
itk::ImageRegionReverseConstIterator< TImage >::ImageRegionReverseConstIterator ( const ImageRegionIterator< TImage > &  it)
inline

Member Function Documentation

template<typename TImage>
const PixelType itk::ImageReverseConstIterator< TImage >::Get ( void  ) const
inlineinherited
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.

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

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

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

References itk::ImageReverseConstIterator< TImage >::m_Region.

template<typename TImage>
void itk::ImageRegionReverseConstIterator< TImage >::GoToBegin ( void  )
inline
template<typename TImage>
void itk::ImageRegionReverseConstIterator< TImage >::GoToEnd ( void  )
inline
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 366 of file itkImageReverseConstIterator.h.

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

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

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

template<typename TImage>
itk::ImageRegionReverseConstIterator< TImage >::itkLegacyMacro ( Self 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
template<typename TImage>
itk::ImageRegionReverseConstIterator< TImage >::itkLegacyMacro ( Self 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
template<typename TImage>
itk::ImageReverseConstIterator< TImage >::itkLegacyMacro ( Self Begin()  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
template<typename TImage>
itk::ImageReverseConstIterator< TImage >::itkLegacyMacro ( Self End()  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
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++ ( )
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 261 of file itkImageRegionReverseConstIterator.h.

References itk::ImageRegionReverseConstIterator< TImage >::ImageIteratorDimension, itk::ImageReverseConstIterator< TImage >::m_Image, itk::ImageReverseConstIterator< TImage >::m_Offset, itk::ImageReverseConstIterator< TImage >::m_Region, itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset.

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

References itk::ImageRegionReverseConstIterator< TImage >::ImageIteratorDimension, itk::ImageReverseConstIterator< TImage >::m_Image, itk::ImageReverseConstIterator< TImage >::m_Offset, itk::ImageReverseConstIterator< TImage >::m_Region, itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset.

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 294 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
inlineinherited
template<typename TImage>
void itk::ImageRegionReverseConstIterator< TImage >::SetIndex ( const IndexType ind)
inlinevirtual
template<typename TImage>
const PixelType& itk::ImageReverseConstIterator< TImage >::Value ( void  ) const
inlineinherited

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

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

template<typename TImage>
const PixelType& itk::ImageReverseConstIterator< TImage >::Value ( void  )
inlineinherited

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

Definition at line 337 of file itkImageReverseConstIterator.h.

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

Member Data Documentation

template<typename TImage>
SizeValueType itk::ImageReverseConstIterator< TImage >::m_BeginOffset
protectedinherited
template<typename TImage>
const InternalPixelType* itk::ImageReverseConstIterator< TImage >::m_Buffer
protectedinherited
template<typename TImage>
SizeValueType itk::ImageReverseConstIterator< TImage >::m_EndOffset
protectedinherited
template<typename TImage>
ImageType::ConstWeakPointer itk::ImageReverseConstIterator< TImage >::m_Image
protectedinherited
template<typename TImage>
SizeValueType itk::ImageReverseConstIterator< TImage >::m_Offset
protectedinherited
template<typename TImage>
AccessorType itk::ImageReverseConstIterator< TImage >::m_PixelAccessor
protectedinherited
template<typename TImage>
AccessorFunctorType itk::ImageReverseConstIterator< TImage >::m_PixelAccessorFunctor
protectedinherited
template<typename TImage>
RegionType itk::ImageReverseConstIterator< TImage >::m_Region
protectedinherited
template<typename TImage>
SizeValueType itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset
protected
template<typename TImage>
SizeValueType itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset
protected

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

Generated at Sat Aug 30 2014 17:21:47 for Orfeo Toolbox with doxygen 1.8.3.1