itk::ImageLinearConstIteratorWithIndex< TImage > Class Template Reference

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

Collaboration diagram for itk::ImageLinearConstIteratorWithIndex< TImage >:

List of all members.

Public Types
typedef TImage	ImageType
typedef TImage::IndexType	IndexType
typedef TImage::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef TImage::RegionType	RegionType
typedef ImageLinearConstIteratorWithIndex	Self
typedef ImageConstIteratorWithIndex < TImage >	Superclass
Public Member Functions
unsigned int	GetDirection ()
void	GoToBeginOfLine (void)
void	GoToEndOfLine (void)
void	GoToReverseBeginOfLine (void)
	ImageLinearConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
	ImageLinearConstIteratorWithIndex ()
	ImageLinearConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
bool	IsAtEndOfLine (void)
bool	IsAtReverseEndOfLine (void)
void	NextLine (void)
void	PreviousLine (void)
void	SetDirection (unsigned int direction)
Self &	operator++ ()
Self &	operator-- ()
Private Attributes
unsigned int	m_Direction
OffsetValueType	m_Jump

---

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:

ImageLinearIteratorWithIndex.cxx, and itkVectorImageTest.cxx.

Definition at line 103 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 so that it is not confused with ImageIterator::Index.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageLinearIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >.

Definition at line 126 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 so that it is not confused with ImageIterator::Index.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageLinearIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >.

Definition at line 114 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 131 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 132 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 it is not confused with ImageIterator::Index.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ImageLinearIteratorWithIndex< TImage >, and itk::ImageLinearIteratorWithIndex< TImageType >.

Definition at line 120 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 >, and itk::ImageLinearIteratorWithIndex< TImageType >.

Definition at line 107 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 108 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 135 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 147 of file itkImageLinearConstIteratorWithIndex.h.

---

Member Function Documentation

template<typename TImage>

unsigned int itk::ImageLinearConstIteratorWithIndex< TImage >::GetDirection

(

)

[inline]

get the direction of movement

Definition at line 196 of file itkImageLinearConstIteratorWithIndex.h.

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

Definition at line 171 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>

bool itk::ImageLinearConstIteratorWithIndex< TImage >::IsAtReverseEndOfLine

(

void

)

[inline]

Test if the index is at the begin of line

Definition at line 177 of file itkImageLinearConstIteratorWithIndex.h.

template<class TImage >

void itk::ImageLinearConstIteratorWithIndex< TImage >::NextLine

(

void

)

[inline]

Go to the next line.

See also:

operator++

operator--

IsAtEndOfLine

PreviousLine

End

Definition at line 233 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>

Self& itk::ImageLinearConstIteratorWithIndex< TImage >::operator++

(

)

[inline]

Increment (prefix) the selected dimension. No bounds checking is performed.

See also:

GetIndex

operator--

Definition at line 203 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>

Self& itk::ImageLinearConstIteratorWithIndex< TImage >::operator--

(

)

[inline]

Decrement (prefix) the selected dimension. No bounds checking is performed.

See also:

GetIndex

operator++

Definition at line 213 of file itkImageLinearConstIteratorWithIndex.h.

template<class TImage >

void itk::ImageLinearConstIteratorWithIndex< TImage >::PreviousLine

(

void

)

[inline]

Go to the previous line.

See also:

operator++

operator--

IsAtEndOfLine

NextLine

End

Definition at line 271 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>

void itk::ImageLinearConstIteratorWithIndex< TImage >::SetDirection

(

unsigned int

direction

)

[inline]

Set the direction of movement

Examples:

itkVectorImageTest.cxx.

Definition at line 183 of file itkImageLinearConstIteratorWithIndex.h.

---

Member Data Documentation

template<typename TImage>

unsigned int itk::ImageLinearConstIteratorWithIndex< TImage >::m_Direction [private]

Definition at line 223 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>

OffsetValueType itk::ImageLinearConstIteratorWithIndex< TImage >::m_Jump [private]

Definition at line 222 of file itkImageLinearConstIteratorWithIndex.h.

---

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

• itkImageLinearConstIteratorWithIndex.h