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

Multi-dimensional image iterator. More...

#include <itkImageReverseConstIterator.h>

+ Inheritance diagram for itk::ImageReverseConstIterator< TImage >:

Public Types

typedef TImage::AccessorFunctorType AccessorFunctorType
 
typedef TImage::AccessorType AccessorType
 
typedef TImage ImageType
 
typedef TImage::IndexType IndexType
 
typedef TImage::InternalPixelType InternalPixelType
 
typedef TImage::OffsetType OffsetType
 
typedef TImage::PixelContainer PixelContainer
 
typedef PixelContainer::Pointer PixelContainerPointer
 
typedef TImage::PixelType PixelType
 
typedef TImage::RegionType RegionType
 
typedef ImageReverseConstIterator Self
 
typedef TImage::SizeType SizeType
 

Public Member Functions

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

Static Public Member Functions

static unsigned int GetImageIteratorDimension ()
 

Static Public Attributes

static const unsigned int ImageIteratorDimension = TImage::ImageDimension
 

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
 

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.

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

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

Accessor type that convert data between internal and external representations.

Definition at line 129 of file itkImageReverseConstIterator.h.

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

Image typedef support.

Definition at line 113 of file itkImageReverseConstIterator.h.

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

Index typedef support.

Definition at line 101 of file itkImageReverseConstIterator.h.

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

Internal Pixel Type

Definition at line 122 of file itkImageReverseConstIterator.h.

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

Offset typedef support.

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

Definition at line 118 of file itkImageReverseConstIterator.h.

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

Definition at line 119 of file itkImageReverseConstIterator.h.

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

External Pixel Type

Definition at line 125 of file itkImageReverseConstIterator.h.

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

Region typedef support.

Definition at line 110 of file itkImageReverseConstIterator.h.

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

Standard class typedefs.

Definition at line 91 of file itkImageReverseConstIterator.h.

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

Size typedef support.

Definition at line 104 of file itkImageReverseConstIterator.h.

Constructor & Destructor Documentation

template<typename TImage>
itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator ( )
inline
template<typename TImage>
virtual itk::ImageReverseConstIterator< TImage >::~ImageReverseConstIterator ( )
inlinevirtual

Default Destructor.

Definition at line 146 of file itkImageReverseConstIterator.h.

template<typename TImage>
itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator ( const Self it)
inline
template<typename TImage>
itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator ( const ImageType ptr,
const RegionType region 
)
inline
template<typename TImage>
itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator ( const ImageConstIterator< TImage > &  it)
inline

Member Function Documentation

template<typename TImage>
const PixelType itk::ImageReverseConstIterator< TImage >::Get ( void  ) const
inline
template<typename TImage>
static unsigned int itk::ImageReverseConstIterator< TImage >::GetImageIteratorDimension ( )
inlinestatic

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

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

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.

Definition at line 347 of file itkImageReverseConstIterator.h.

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

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

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.

Definition at line 359 of file itkImageReverseConstIterator.h.

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

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

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

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

template<typename TImage>
itk::ImageReverseConstIterator< TImage >::itkLegacyMacro ( Self 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
template<typename TImage>
itk::ImageReverseConstIterator< TImage >::itkLegacyMacro ( Self 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
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 285 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 Self it)
inline
template<typename TImage>
Self& itk::ImageReverseConstIterator< TImage >::operator= ( const ImageConstIterator< TImage > &  it)
inline
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 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
inline
template<typename TImage>
virtual void itk::ImageReverseConstIterator< TImage >::SetIndex ( const IndexType ind)
inlinevirtual
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 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  )
inline

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>
const unsigned int itk::ImageReverseConstIterator< TImage >::ImageIteratorDimension = TImage::ImageDimension
static

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.

Definition at line 98 of file itkImageReverseConstIterator.h.

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

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

Generated at Sat Mar 8 2014 17:12:08 for Orfeo Toolbox with doxygen 1.8.3.1