Orfeo Toolbox  4.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
itk::SliceIterator< TPixel, TContainer > Class Template Reference

A flexible iterator for itk containers(i.e. itk::Neighborhood) that support pixel access through operator[]. More...

#include <itkSliceIterator.h>

Public Member Functions

 SliceIterator (TContainer *n, std::slice s)
 
SliceIterator Begin ()
 
SliceIterator End ()
 
bool operator!= (const SliceIterator &orig)
 
TPixel & operator* ()
 
SliceIterator operator++ ()
 
SliceIterator operator++ (int)
 
bool operator< (const SliceIterator &orig)
 
bool operator== (const SliceIterator &orig)
 
TPixel & operator[] (OffsetValueType n)
 

Private Member Functions

TPixel & Loc (OffsetValueType n) const
 

Private Attributes

TContainer * m_ContainerPointer
 
OffsetValueType m_Pos
 
std::slice m_Slice
 

Detailed Description

template<typename TPixel, typename TContainer>
class itk::SliceIterator< TPixel, TContainer >

A flexible iterator for itk containers(i.e. itk::Neighborhood) that support pixel access through operator[].

SliceIterator allows iteration along a std::slice through the container. A slice is a construct that defines a starting position, stride length (distance between adjacent elements), and a length.

Any container with operator[] is supported. Because it uses this interface the iterator is only as efficient as the implementation of a container's operator[] method.

References: Modelled after a slice iterator proposed by Bjarne Stroustrup in C++ Programming Language, Third Edition. Bjarne Stroustrup. Addison Wesley, Reading, MA. 1997.

Definition at line 48 of file itkSliceIterator.h.

Constructor & Destructor Documentation

template<typename TPixel , typename TContainer >
itk::SliceIterator< TPixel, TContainer >::SliceIterator ( TContainer *  n,
std::slice  s 
)
inline

Constructor.

Definition at line 52 of file itkSliceIterator.h.

Member Function Documentation

template<typename TPixel , typename TContainer >
SliceIterator itk::SliceIterator< TPixel, TContainer >::Begin ( void  )
inline
template<typename TPixel , typename TContainer >
SliceIterator itk::SliceIterator< TPixel, TContainer >::End ( void  )
inline
template<typename TPixel , typename TContainer >
TPixel& itk::SliceIterator< TPixel, TContainer >::Loc ( OffsetValueType  n) const
inlineprivate
template<typename TPixel , typename TContainer >
bool itk::SliceIterator< TPixel, TContainer >::operator!= ( const SliceIterator< TPixel, TContainer > &  orig)
inline

Returns the logical inverse of the boolean == of two slice iterators.

Definition at line 109 of file itkSliceIterator.h.

References itk::SliceIterator< TPixel, TContainer >::operator==().

template<typename TPixel , typename TContainer >
TPixel& itk::SliceIterator< TPixel, TContainer >::operator* ( )
inline

Dereferences the iterator, returning the value that it points to.

Definition at line 96 of file itkSliceIterator.h.

References itk::SliceIterator< TPixel, TContainer >::Loc(), and itk::SliceIterator< TPixel, TContainer >::m_Pos.

template<typename TPixel , typename TContainer >
SliceIterator itk::SliceIterator< TPixel, TContainer >::operator++ ( )
inline

Increments the iterator.

Definition at line 74 of file itkSliceIterator.h.

References itk::SliceIterator< TPixel, TContainer >::m_Pos.

template<typename TPixel , typename TContainer >
SliceIterator itk::SliceIterator< TPixel, TContainer >::operator++ ( int  )
inline

Increments the iterator.

Definition at line 81 of file itkSliceIterator.h.

References itk::SliceIterator< TPixel, TContainer >::m_Pos.

template<typename TPixel , typename TContainer >
bool itk::SliceIterator< TPixel, TContainer >::operator< ( const SliceIterator< TPixel, TContainer > &  orig)
inline

Returns the boolean < of two slice iterator positions. Result is only true if the slice iterators have the same stride and start location.

Definition at line 117 of file itkSliceIterator.h.

References itk::SliceIterator< TPixel, TContainer >::m_Pos, and itk::SliceIterator< TPixel, TContainer >::m_Slice.

template<typename TPixel , typename TContainer >
bool itk::SliceIterator< TPixel, TContainer >::operator== ( const SliceIterator< TPixel, TContainer > &  orig)
inline

Returns the logical && of the boolean == of two slice iterator positions, stride, and start locations.

Definition at line 101 of file itkSliceIterator.h.

References itk::SliceIterator< TPixel, TContainer >::m_Pos, and itk::SliceIterator< TPixel, TContainer >::m_Slice.

Referenced by itk::SliceIterator< TPixel, TContainer >::operator!=().

template<typename TPixel , typename TContainer >
TPixel& itk::SliceIterator< TPixel, TContainer >::operator[] ( OffsetValueType  n)
inline

Returns the element at position n of the slice. Sets the iterator to point to position n.

Definition at line 91 of file itkSliceIterator.h.

References itk::SliceIterator< TPixel, TContainer >::Loc(), and itk::SliceIterator< TPixel, TContainer >::m_Pos.

Member Data Documentation

template<typename TPixel , typename TContainer >
TContainer* itk::SliceIterator< TPixel, TContainer >::m_ContainerPointer
private

Pointer to the container referenced by the slice iterator.

Definition at line 135 of file itkSliceIterator.h.

Referenced by itk::SliceIterator< TPixel, TContainer >::Loc().

template<typename TPixel , typename TContainer >
OffsetValueType itk::SliceIterator< TPixel, TContainer >::m_Pos
private
template<typename TPixel , typename TContainer >
std::slice itk::SliceIterator< TPixel, TContainer >::m_Slice
private

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

Generated at Sat Mar 8 2014 17:45:36 for Orfeo Toolbox with doxygen 1.8.3.1