Orfeo Toolbox  3.16
Public Member Functions | Private Member Functions | Private Attributes
itk::ConstSliceIterator< TPixel, TContainer > Class Template Reference
Iterators

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

#include <itkConstSliceIterator.h>

List of all members.

Public Member Functions

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

Private Member Functions

const TPixel & Loc (unsigned long n) const

Private Attributes

const TContainer * m_ContainerPointer
unsigned long m_Pos
std::slice m_Slice

Detailed Description

template<class TPixel, class TContainer>
class itk::ConstSliceIterator< TPixel, TContainer >

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

ConstSliceIterator allows const 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[] const is supported. Because it uses this interface the iterator is only as efficient as the implementation of a container's operator[] method.

References: Modeled 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 itkConstSliceIterator.h.

Constructor & Destructor Documentation

template<class TPixel , class TContainer >
itk::ConstSliceIterator< TPixel, TContainer >::ConstSliceIterator ( const TContainer *  n,
std::slice  s 
)
inline

Constructor.

Definition at line 52 of file itkConstSliceIterator.h.

Member Function Documentation

template<class TPixel , class TContainer >
ConstSliceIterator itk::ConstSliceIterator< TPixel, TContainer >::Begin ( void  )
inline

Returns a ConstSliceIterator that points to the beginning of the slice.

Definition at line 56 of file itkConstSliceIterator.h.

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

template<class TPixel , class TContainer >
ConstSliceIterator itk::ConstSliceIterator< TPixel, TContainer >::End ( void  )
inline

Returns a ConstSliceIterator that points to one past the end of the slice.

Definition at line 65 of file itkConstSliceIterator.h.

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

template<class TPixel , class TContainer >
const TPixel& itk::ConstSliceIterator< TPixel, TContainer >::Loc ( unsigned long  n) const
inlineprivate

Returns the value located at position n of the slice.

Definition at line 128 of file itkConstSliceIterator.h.

template<class TPixel , class TContainer >
bool itk::ConstSliceIterator< TPixel, TContainer >::operator!= ( const ConstSliceIterator< TPixel, TContainer > &  orig)
inline

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

Definition at line 111 of file itkConstSliceIterator.h.

References itk::operator==().

template<class TPixel , class TContainer >
const TPixel& itk::ConstSliceIterator< TPixel, TContainer >::operator* ( )
inline

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

Definition at line 96 of file itkConstSliceIterator.h.

template<class TPixel , class TContainer >
ConstSliceIterator itk::ConstSliceIterator< TPixel, TContainer >::operator++ ( )
inline

Increments the iterator.

Definition at line 73 of file itkConstSliceIterator.h.

template<class TPixel , class TContainer >
ConstSliceIterator itk::ConstSliceIterator< TPixel, TContainer >::operator++ ( int  )
inline

Increments the iterator.

Definition at line 80 of file itkConstSliceIterator.h.

template<class TPixel , class TContainer >
bool itk::ConstSliceIterator< TPixel, TContainer >::operator< ( const ConstSliceIterator< 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 119 of file itkConstSliceIterator.h.

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

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

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

Definition at line 103 of file itkConstSliceIterator.h.

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

template<class TPixel , class TContainer >
const TPixel& itk::ConstSliceIterator< TPixel, TContainer >::operator[] ( unsigned long  n)
inline

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

Definition at line 89 of file itkConstSliceIterator.h.

Member Data Documentation

template<class TPixel , class TContainer >
const TContainer* itk::ConstSliceIterator< TPixel, TContainer >::m_ContainerPointer
private

Pointer to the container referenced by the slice iterator.

Definition at line 134 of file itkConstSliceIterator.h.

template<class TPixel , class TContainer >
unsigned long itk::ConstSliceIterator< TPixel, TContainer >::m_Pos
private

Current position within the slice.

Definition at line 137 of file itkConstSliceIterator.h.

Referenced by itk::ConstSliceIterator< TPixel, TContainer >::Begin(), itk::ConstSliceIterator< TPixel, TContainer >::End(), itk::ConstSliceIterator< TPixel, TContainer >::operator<(), and itk::ConstSliceIterator< TPixel, TContainer >::operator==().

template<class TPixel , class TContainer >
std::slice itk::ConstSliceIterator< TPixel, TContainer >::m_Slice
private

Slice structure information.

Definition at line 140 of file itkConstSliceIterator.h.

Referenced by itk::ConstSliceIterator< TPixel, TContainer >::operator<(), and itk::ConstSliceIterator< TPixel, TContainer >::operator==().

The documentation for this class was generated from the following file:
Generated at Sun Feb 3 2013 01:25:58 for Orfeo Toolbox with doxygen 1.8.1.1