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

A multi-dimensional image iterator that visits image pixels within a region in a "scan-line" order. More...

#include <itkImageLinearConstIteratorWithIndex.h>

Inheritance diagram for itk::ImageLinearConstIteratorWithIndex< TImage >:

[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 Member Functions
	ImageLinearConstIteratorWithIndex ()
	ImageLinearConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
	ImageLinearConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
void	NextLine (void)
void	PreviousLine (void)
void	GoToBeginOfLine (void)
void	GoToReverseBeginOfLine (void)
void	GoToEndOfLine (void)
bool	IsAtEndOfLine (void)
bool	IsAtReverseEndOfLine (void)
void	SetDirection (unsigned int direction)
Self &	operator++ ()
Self &	operator-- ()

---

Detailed Description

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

A multi-dimensional image iterator that visits image pixels within a region in a "scan-line" order.

ImageLinearConstIteratorWithIndex is templated over image type and is constrained to walk within a specified image region. It is designed for line-by-line processing of images. This iterator walks a linear path along a selected image direction that is parallel to one of the coordinate axes of the image. The iterator conceptually breaks the image into a set of parallel lines that span the selected image dimension.

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();
  } 

Examples/Iterators/ImageLinearIteratorWithIndex.cxx

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 102 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 >. Definition at line 125 of file itkImageLinearConstIteratorWithIndex.h.

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 >. Definition at line 113 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 >. Definition at line 130 of file itkImageLinearConstIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Reimplemented in itk::ImageLinearIteratorWithIndex< TImage >. Definition at line 131 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 >. Definition at line 119 of file itkImageLinearConstIteratorWithIndex.h.

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

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

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

Reimplemented in itk::ImageLinearIteratorWithIndex< TImage >. Definition at line 107 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 134 of file itkImageLinearConstIteratorWithIndex.h.

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

Constructor establishes an iterator to walk a particular image and a particular region of that image.

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 146 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: GoToReverseBeginOfLine operator++ operator-- NextLine IsAtEndOfLine

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 IsAtEndOfLine

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

Go to the beginning pixel of the current line. See also: GoToBeginOfLine operator++ operator-- NextLine IsAtEndOfLine

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

Test if the index is at the end of line

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

Test if the index is at the begin of line

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

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

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

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

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

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-- IsAtEndOfLine 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

---