itk::ImageLinearConstIteratorWithIndex< TImage > Class Template Reference
[Image Iterators]

Multi-dimensional image iterator which only walks a region. More...

#include <itkImageLinearConstIteratorWithIndex.h>

Inheritance diagram for itk::ImageLinearConstIteratorWithIndex:

[legend]Collaboration diagram for itk::ImageLinearConstIteratorWithIndex< TImage >:

[legend]List of all members.

Public Types
typedef ImageLinearConstIteratorWithIndex	Self
typedef ImageConstIteratorWithIndex< TImage >	Superclass
typedef TImage::IndexType	IndexType
typedef TImage::RegionType	RegionType
typedef TImage	ImageType
typedef TImage::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
Public Methods
	ImageLinearConstIteratorWithIndex ()
	ImageLinearConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
	ImageLinearConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
void	NextLine (void)
void	PreviousLine (void)
void	GoToBeginOfLine (void)
void	GoToEndOfLine (void)
bool	IsAtEndOfLine (void)
bool	IsAtBeginOfLine (void)
void	SetDirection (unsigned int direction)
Self &	operator++ ()
Self &	operator-- ()

---

Detailed Description

template<typename TImage>
class itk::ImageLinearConstIteratorWithIndex< TImage >

Multi-dimensional image iterator which only walks a region.

ImageLinearConstIteratorWithIndex is a templated class to represent a multi-dimensional iterator. ImageLinearConstIteratorWithIndex is templated over the image type ImageLinearConstIteratorWithIndex is constrained to walk only within the specified region.

ImageLinearConstIteratorWithIndex 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, ImageLinearConstIteratorWithIndex holds a reference to the image over which it is traversing.

ImageLinearConstIteratorWithIndex 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. operator++ iterates across a preselected direction constraining the movement to within a region of image. The user can verify when the iterator reaches the boundary of the region along this direction, by calling the IsAtEndOfLine() method. Then it is possible to pass to the next line starting at the first pixel in the row that is part of the region by calling the NextLine() method.

This is the typical use of this iterator in a loop:

 ImageLinearConstIteratorWithIndex<ImageType> it( image, image->GetRequestedRegion() );
 
 it.SetDirection(2);
 it.GoToBegin();
 while( !it.IsAtEnd() )
 {
   while( !it.IsAtEndOfLine() )
   {
      value = it.Get();  // it.Set() doesn't exist in the Const Iterator
      ++it;
   }
   it.NextLine();
  } 

\example Common/itkImageLinearIteratorTest.cxx

Definition at line 79 of file itkImageLinearConstIteratorWithIndex.h.

---

Member Typedef Documentation

template<typename TImage> typedef TImage itk::ImageLinearConstIteratorWithIndex< 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. Note that we have to rescope Index back to itk::Index to that is it not confused with ImageIterator::Index. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageLinearIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >. Definition at line 102 of file itkImageLinearConstIteratorWithIndex.h. Referenced by itk::ImageLinearConstIteratorWithIndex< TImageType >::ImageLinearConstIteratorWithIndex().

template<typename TImage> typedef TImage::IndexType itk::ImageLinearConstIteratorWithIndex< 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. Note that we have to rescope Index back to itk::Index to that is it not confused with ImageIterator::Index. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageLinearIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >. Definition at line 90 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage> typedef TImage::PixelContainer itk::ImageLinearConstIteratorWithIndex< 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. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageLinearIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >. Definition at line 107 of file itkImageLinearConstIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageLinearIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >. Definition at line 108 of file itkImageLinearConstIteratorWithIndex.h.

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

Region 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. Note that we have to rescope Region back to itk::ImageRegion so that is it not confused with ImageIterator::Index. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageLinearIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >. Definition at line 96 of file itkImageLinearConstIteratorWithIndex.h. Referenced by itk::ImageLinearConstIteratorWithIndex< TImageType >::ImageLinearConstIteratorWithIndex().

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

Standard class typedefs. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageLinearIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >. Definition at line 83 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage> typedef ImageConstIteratorWithIndex<TImage> itk::ImageLinearConstIteratorWithIndex< TImage >::Superclass

Reimplemented in itk::ImageLinearIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >. Definition at line 84 of file itkImageLinearConstIteratorWithIndex.h.

---

Constructor & Destructor Documentation

template<typename TImage> itk::ImageLinearConstIteratorWithIndex< TImage >::ImageLinearConstIteratorWithIndex (    )  [inline]

Default constructor. Needed since we provide a cast constructor. Definition at line 111 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage> itk::ImageLinearConstIteratorWithIndex< TImage >::ImageLinearConstIteratorWithIndex (  const ImageType *    ptr, const RegionType &    region )  [inline]

Constructor establishes an iterator to walk a particular image and a particular region of that image. Definition at line 115 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage> itk::ImageLinearConstIteratorWithIndex< TImage >::ImageLinearConstIteratorWithIndex (  const ImageConstIteratorWithIndex< TImage > &    it )  [inline]

Constructor that can be used to cast from an ImageIterator to an ImageLinearConstIteratorWithIndex. Many routines return an ImageIterator but for a particular task, you may want an ImageLinearConstIteratorWithIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageLinearConstIteratorWithIndex. Definition at line 125 of file itkImageLinearConstIteratorWithIndex.h.

---

Member Function Documentation

template<typename TImage> void itk::ImageLinearConstIteratorWithIndex< TImage >::GoToBeginOfLine (  void    )

Go to the beginning pixel of the current line. See also: GoToEndOfLine , operator++ , operator-- , NextLine , EndOfLine

template<typename TImage> void itk::ImageLinearConstIteratorWithIndex< TImage >::GoToEndOfLine (  void    )

Go to the past end pixel of the current line. See also: GoToBeginOfLine , operator++ , operator-- , NextLine , EndOfLine

template<typename TImage> bool itk::ImageLinearConstIteratorWithIndex< TImage >::IsAtBeginOfLine (  void    )  [inline]

Test if the index is at the begin of line

template<typename TImage> bool itk::ImageLinearConstIteratorWithIndex< TImage >::IsAtEndOfLine (  void    )  [inline]

Test if the index is at the end of line

template<typename TImage> void itk::ImageLinearConstIteratorWithIndex< TImage >::NextLine (  void    )  [inline]

Go to the next line. See also: operator++ , operator-- , EndOfLine , PreviousLine , End

template<typename TImage> Self& itk::ImageLinearConstIteratorWithIndex< TImage >::operator++ (    )

Increment (prefix) the selected dimension. No bounds checking is performed. See also: GetIndex , operator--

template<typename TImage> Self& itk::ImageLinearConstIteratorWithIndex< TImage >::operator-- (    )

Decrement (prefix) the selected dimension. No bounds checking is performed. See also: GetIndex , operator++

template<typename TImage> void itk::ImageLinearConstIteratorWithIndex< TImage >::PreviousLine (  void    )  [inline]

Go to the previous line. See also: operator++ , operator-- , EndOfLine , NextLine , End

template<typename TImage> void itk::ImageLinearConstIteratorWithIndex< TImage >::SetDirection (  unsigned int    direction )  [inline]

Set the direction of movement

---

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

• itkImageLinearConstIteratorWithIndex.h

---