Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes

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 >:
Inheritance graph
[legend]
Collaboration diagram for itk::ImageLinearConstIteratorWithIndex< TImage >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef TImage::AccessorFunctorType AccessorFunctorType
typedef TImage::AccessorType AccessorType
typedef TImage ImageType
typedef TImage::IndexType IndexType
typedef IndexType::IndexValueType IndexValueType
typedef TImage::InternalPixelType InternalPixelType
typedef TImage::OffsetType OffsetType
typedef OffsetType::OffsetValueType OffsetValueType
typedef TImage::PixelContainer PixelContainer
typedef PixelContainer::Pointer PixelContainerPointer
typedef TImage::PixelType PixelType
typedef TImage::RegionType RegionType
typedef
ImageLinearConstIteratorWithIndex 
Self
typedef TImage::SizeType SizeType
typedef SizeType::SizeValueType SizeValueType
typedef
ImageConstIteratorWithIndex
< TImage > 
Superclass

Public Member Functions

Self Begin (void) const
Self End (void) const
PixelType Get (void) const
const IndexTypeGetIndex () const
const RegionTypeGetRegion () const
void GoToBegin (void)
void GoToBeginOfLine (void)
void GoToEndOfLine (void)
void GoToReverseBegin (void)
void GoToReverseBeginOfLine (void)
 ImageLinearConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
 ImageLinearConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
 ImageLinearConstIteratorWithIndex ()
bool IsAtEnd (void) const
bool IsAtEndOfLine (void)
bool IsAtReverseEnd (void) const
bool IsAtReverseEndOfLine (void)
void NextLine (void)
bool operator!= (const Self &it) const
bool operator< (const Self &it) const
bool operator<= (const Self &it) const
bool operator== (const Self &it) const
bool operator> (const Self &it) const
bool operator>= (const Self &it) const
void PreviousLine (void)
bool Remaining ()
const PixelTypeValue (void) const

void SetDirection (unsigned int direction)

Selfoperator++ ()

Selfoperator-- ()

void SetIndex (const IndexType &ind)

Static Public Member Functions

static unsigned int GetImageDimension ()

Static Public Attributes

static const unsigned int ImageDimension = TImage::ImageDimension

Protected Attributes

const InternalPixelTypem_Begin
IndexType m_BeginIndex
const InternalPixelTypem_End
IndexType m_EndIndex
TImage::ConstWeakPointer m_Image
unsigned long m_OffsetTable [ImageDimension+1]
AccessorType m_PixelAccessor
AccessorFunctorType m_PixelAccessorFunctor
const InternalPixelTypem_Position
IndexType m_PositionIndex
RegionType m_Region
bool m_Remaining

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:

Examples/Iterators/ImageLinearIteratorWithIndex.cxx, and Testing/Code/Common/itkVectorImageTest.cxx.

Definition at line 102 of file itkImageLinearConstIteratorWithIndex.h.


Member Typedef Documentation

template<typename TImage>
typedef TImage::AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::AccessorFunctorType [inherited]

Definition at line 132 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
typedef TImage::AccessorType itk::ImageConstIteratorWithIndex< TImage >::AccessorType [inherited]
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 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 >, and itk::ImageLinearIteratorWithIndex< TImageType >.

Definition at line 113 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
typedef IndexType::IndexValueType itk::ImageConstIteratorWithIndex< TImage >::IndexValueType [inherited]
template<typename TImage>
typedef TImage::InternalPixelType itk::ImageConstIteratorWithIndex< TImage >::InternalPixelType [inherited]
template<typename TImage>
typedef TImage::OffsetType itk::ImageConstIteratorWithIndex< TImage >::OffsetType [inherited]
template<typename TImage>
typedef OffsetType::OffsetValueType itk::ImageConstIteratorWithIndex< TImage >::OffsetValueType [inherited]
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 130 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
typedef TImage::PixelType itk::ImageConstIteratorWithIndex< TImage >::PixelType [inherited]
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 119 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
typedef TImage::SizeType itk::ImageConstIteratorWithIndex< TImage >::SizeType [inherited]
template<typename TImage>
typedef SizeType::SizeValueType itk::ImageConstIteratorWithIndex< TImage >::SizeValueType [inherited]
template<typename TImage>
typedef ImageConstIteratorWithIndex<TImage> itk::ImageLinearConstIteratorWithIndex< TImage >::Superclass

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>
Self itk::ImageConstIteratorWithIndex< TImage >::Begin ( void   )  const [inherited]

Move an iterator to the beginning of the region.

Deprecated:
Use GoToBegin() instead
template<typename TImage>
Self itk::ImageConstIteratorWithIndex< TImage >::End ( void   )  const [inherited]

Move an iterator to the End of the region.

Deprecated:
Use GoToReverseBegin() instead
template<typename TImage>
PixelType itk::ImageConstIteratorWithIndex< TImage >::Get ( void   )  const [inline, inherited]

Get the pixel value

Definition at line 237 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
static unsigned int itk::ImageConstIteratorWithIndex< TImage >::GetImageDimension (  )  [inline, static, inherited]

Get the dimension (size) of the index.

Definition at line 156 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
const IndexType& itk::ImageConstIteratorWithIndex< TImage >::GetIndex ( void   )  const [inline, inherited]
template<typename TImage>
const RegionType& itk::ImageConstIteratorWithIndex< TImage >::GetRegion (  )  const [inline, inherited]

Get the region that this iterator walks. ImageIterators know the beginning and the end of the region of the image to iterate over.

Definition at line 224 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
void itk::ImageConstIteratorWithIndex< TImage >::GoToBegin ( void   )  [inherited]
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::ImageConstIteratorWithIndex< TImage >::GoToReverseBegin ( void   )  [inherited]

Move an iterator to the End of the region.

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::ImageConstIteratorWithIndex< TImage >::IsAtEnd ( void   )  const [inline, inherited]
template<typename TImage>
bool itk::ImageLinearConstIteratorWithIndex< TImage >::IsAtEndOfLine ( void   )  [inline]

Test if the index is at the end of line

Definition at line 170 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::IsAtReverseEnd ( void   )  const [inline, inherited]

Is the iterator at the beginning of the region?

Definition at line 261 of file itkImageConstIteratorWithIndex.h.

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

Test if the index is at the begin of line

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

References HardConnectedComponentImageFilter::ImageDimension.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::operator!= ( const Self it  )  const [inline, inherited]

Comparison operator. Two iterators are the same if they "point to" the same memory location

Definition at line 162 of file itkImageConstIteratorWithIndex.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 195 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 205 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::operator< ( const Self it  )  const [inline, inherited]

Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.

Definition at line 190 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::operator<= ( const Self it  )  const [inline, inherited]

Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.

Definition at line 180 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::operator== ( const Self it  )  const [inline, inherited]

Comparison operator. Two iterators are the same if they "point to" the same memory location

Definition at line 171 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::operator> ( const Self it  )  const [inline, inherited]

Comparison operator. An iterator is "greater than" another if it "points to" a higher location.

Definition at line 210 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::operator>= ( const Self it  )  const [inline, inherited]

Comparison operator. An iterator is "greater than" another if it "points to" a higher location.

Definition at line 200 of file itkImageConstIteratorWithIndex.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 266 of file itkImageLinearConstIteratorWithIndex.h.

References HardConnectedComponentImageFilter::ImageDimension.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::Remaining (  )  [inline, inherited]

Are there data remainning in the region ?

Definition at line 273 of file itkImageConstIteratorWithIndex.h.

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

Set the direction of movement

Definition at line 182 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
void itk::ImageConstIteratorWithIndex< TImage >::SetIndex ( const IndexType ind  )  [inline, inherited]

Set the index. No bounds checking is performed.

See also:
GetIndex

Definition at line 229 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
const PixelType& itk::ImageConstIteratorWithIndex< TImage >::Value ( void   )  const [inline, inherited]

Return a const reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.

Definition at line 243 of file itkImageConstIteratorWithIndex.h.


Member Data Documentation

template<typename TImage>
const unsigned int itk::ImageConstIteratorWithIndex< TImage >::ImageDimension = TImage::ImageDimension [static, inherited]

Dimension of the image the iterator walks. This constant is needed so functions that are templated over image iterator type (as opposed to being templated over pixel type and dimension) can have compile time access to the dimension of the image that the iterator walks.

Reimplemented in itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.

Definition at line 101 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_Begin [protected, inherited]

Definition at line 292 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
IndexType itk::ImageConstIteratorWithIndex< TImage >::m_BeginIndex [protected, inherited]

Definition at line 282 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_End [protected, inherited]

Definition at line 293 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
IndexType itk::ImageConstIteratorWithIndex< TImage >::m_EndIndex [protected, inherited]

Definition at line 283 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
TImage::ConstWeakPointer itk::ImageConstIteratorWithIndex< TImage >::m_Image [protected, inherited]

Definition at line 279 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
unsigned long itk::ImageConstIteratorWithIndex< TImage >::m_OffsetTable[ImageDimension+1] [protected, inherited]

Definition at line 289 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
AccessorType itk::ImageConstIteratorWithIndex< TImage >::m_PixelAccessor [protected, inherited]

Definition at line 297 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::m_PixelAccessorFunctor [protected, inherited]

Definition at line 298 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_Position [protected, inherited]
template<typename TImage>
IndexType itk::ImageConstIteratorWithIndex< TImage >::m_PositionIndex [protected, inherited]

Definition at line 281 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
RegionType itk::ImageConstIteratorWithIndex< TImage >::m_Region [protected, inherited]

Definition at line 287 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::m_Remaining [protected, inherited]

Definition at line 295 of file itkImageConstIteratorWithIndex.h.


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

Generated at Mon Jul 12 2010 23:11:41 for ITK by doxygen 1.7.1 written by Dimitri van Heesch, © 1997-2000