itk::ConstSliceIterator< TPixel, TContainer > Class Template Reference
[Iterators]

#include <itkConstSliceIterator.h>

Collaboration diagram for itk::ConstSliceIterator< TPixel, TContainer >:

[legend]List of all members.

---

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.

Public Member Functions
ConstSliceIterator	Begin ()
	ConstSliceIterator (const TContainer *n, std::slice s)
Returns a ConstSliceIterator that points to one past the end *of the slice *ConstSliceIterator	End ()
const TPixel &	operator * ()
bool	operator!= (const ConstSliceIterator &orig)
ConstSliceIterator	operator++ (int)
ConstSliceIterator	operator++ ()
bool	operator< (const ConstSliceIterator &orig)
bool	operator== (const ConstSliceIterator &orig)
const TPixel &	operator[] (unsigned long n)

---

Constructor & Destructor Documentation

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

Constructor. Definition at line 53 of file itkConstSliceIterator.h.

---

Member Function Documentation

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

Returns a ConstSliceIterator that points to the beginning of the slice. Definition at line 57 of file itkConstSliceIterator.h. References itk::ConstSliceIterator< TPixel, TContainer >::m_Pos.

template<class TPixel, class TContainer> Returns a ConstSliceIterator that points to one past the end* of the slice* ConstSliceIterator itk::ConstSliceIterator< TPixel, TContainer >::End (   )  [inline]

Definition at line 66 of file itkConstSliceIterator.h. References itk::ConstSliceIterator< TPixel, TContainer >::m_Pos.

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 98 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 113 of file itkConstSliceIterator.h. References itk::operator==().

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

Increments the iterator. Definition at line 82 of file itkConstSliceIterator.h.

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

Increments the iterator. Definition at line 75 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 121 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 105 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 91 of file itkConstSliceIterator.h.

---

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

• itkConstSliceIterator.h

---