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 Attributes | Protected Attributes

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

A multi-dimensional iterator templated over image type. More...

#include <itkImageIterator.h>

Inheritance diagram for itk::ImageIterator< TImage >:
Inheritance graph
[legend]
Collaboration diagram for itk::ImageIterator< TImage >:
Collaboration graph
[legend]

List of all members.

Public Types

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

Public Member Functions

Self Begin (void) const
Self End (void) const
PixelType Get (void) const
ImageTypeGetImage () const
const IndexType GetIndex () const
const RegionTypeGetRegion () const
void GoToBegin ()
void GoToEnd ()
 ImageIterator (TImage *ptr, const RegionType &region)
 ImageIterator ()
 ImageIterator (const Self &it)
bool IsAtBegin (void) const
bool IsAtEnd (void) const
Selfoperator= (const Self &it)
void Set (const PixelType &value) const
virtual void SetIndex (const IndexType &ind)
const PixelTypeValue (void) const
PixelTypeValue (void)
 ~ImageIterator ()

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

Static Public Attributes

static const unsigned int ImageIteratorDimension = TImage::ImageDimension

Protected Member Functions

 ImageIterator (const ImageConstIterator< TImage > &it)
Selfoperator= (const ImageConstIterator< TImage > &it)

Protected Attributes

unsigned long m_BeginOffset
const InternalPixelTypem_Buffer
unsigned long m_EndOffset
TImage::ConstWeakPointer m_Image
unsigned long m_Offset
AccessorType m_PixelAccessor
AccessorFunctorType m_PixelAccessorFunctor
RegionType m_Region



bool operator!= (const Self &it) const
static unsigned int GetImageIteratorDimension ()

Detailed Description

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

A multi-dimensional iterator templated over image type.

This is a base class of ImageConstIterator that adds write-access functionality. Please see ImageConstIterator for more information.

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

Definition at line 63 of file itkImageIterator.h.


Member Typedef Documentation

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

Definition at line 131 of file itkImageConstIterator.h.

template<typename TImage>
typedef Superclass::AccessorType itk::ImageIterator< TImage >::AccessorType

Accessor type that convert data between internal and external representations.

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 93 of file itkImageIterator.h.

template<typename TImage>
typedef Superclass::ImageType itk::ImageIterator< TImage >::ImageType

Image typedef support.

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 88 of file itkImageIterator.h.

template<typename TImage>
typedef Superclass::IndexType itk::ImageIterator< TImage >::IndexType

Inherit types from the superclass

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 81 of file itkImageIterator.h.

template<typename TImage>
typedef Superclass::IndexValueType itk::ImageIterator< TImage >::IndexValueType

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 82 of file itkImageIterator.h.

template<typename TImage>
typedef Superclass::InternalPixelType itk::ImageIterator< TImage >::InternalPixelType

Internal Pixel Type

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 91 of file itkImageIterator.h.

template<typename TImage>
typedef Superclass::OffsetType itk::ImageIterator< TImage >::OffsetType

Offset typedef support.

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 85 of file itkImageIterator.h.

template<typename TImage>
typedef Superclass::OffsetValueType itk::ImageIterator< TImage >::OffsetValueType

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 86 of file itkImageIterator.h.

template<typename TImage>
typedef Superclass::PixelContainer itk::ImageIterator< 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::ImageConstIterator< TImage >.

Definition at line 89 of file itkImageIterator.h.

template<typename TImage>
typedef Superclass::PixelContainerPointer itk::ImageIterator< TImage >::PixelContainerPointer

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 90 of file itkImageIterator.h.

template<typename TImage>
typedef Superclass::PixelType itk::ImageIterator< TImage >::PixelType

External Pixel Type

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 92 of file itkImageIterator.h.

template<typename TImage>
typedef Superclass::RegionType itk::ImageIterator< TImage >::RegionType

Region typedef support.

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 87 of file itkImageIterator.h.

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

Standard class typedefs.

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 68 of file itkImageIterator.h.

template<typename TImage>
typedef Superclass::SizeType itk::ImageIterator< TImage >::SizeType

Size typedef support.

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 83 of file itkImageIterator.h.

template<typename TImage>
typedef Superclass::SizeValueType itk::ImageIterator< TImage >::SizeValueType

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 84 of file itkImageIterator.h.

template<typename TImage>
typedef ImageConstIterator<TImage> itk::ImageIterator< TImage >::Superclass

Define the superclass

Definition at line 78 of file itkImageIterator.h.


Constructor & Destructor Documentation

template<typename TImage>
itk::ImageIterator< TImage >::ImageIterator (  ) 

Default Constructor. Need to provide a default constructor since we provide a copy constructor.

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

Default Destructor

Definition at line 101 of file itkImageIterator.h.

template<typename TImage>
itk::ImageIterator< TImage >::ImageIterator ( const Self it  ) 

Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted.

template<typename TImage>
itk::ImageIterator< TImage >::ImageIterator ( TImage *  ptr,
const RegionType region 
)

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

template<typename TImage>
itk::ImageIterator< TImage >::ImageIterator ( const ImageConstIterator< TImage > &  it  )  [protected]

This constructor is declared protected in order to enforce const-correctness


Member Function Documentation

template<typename TImage>
Self itk::ImageIterator< TImage >::Begin ( void   )  const

Return an iterator for the beginning of the region. "Begin" is defined as the first pixel in the region.

Deprecated:
Use GoToBegin() instead

Reimplemented from itk::ImageConstIterator< TImage >.

template<typename TImage>
Self itk::ImageIterator< TImage >::End ( void   )  const

Return an iterator for the end of the region. "End" is defined as one pixel past the last pixel of the region.

Deprecated:
Use GoToEnd() instead

Reimplemented from itk::ImageConstIterator< TImage >.

template<typename TImage>
PixelType itk::ImageConstIterator< TImage >::Get ( void   )  const [inline, inherited]

Get the pixel value

Definition at line 326 of file itkImageConstIterator.h.

template<typename TImage>
ImageType* itk::ImageIterator< TImage >::GetImage (  )  const [inline]

Get the image that this iterator walks.

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 146 of file itkImageIterator.h.

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

Get the dimension (size) of the index.

Definition at line 237 of file itkImageConstIterator.h.

template<typename TImage>
const IndexType itk::ImageConstIterator< TImage >::GetIndex ( void   )  const [inline, inherited]

Get the index. This provides a read only reference to the index. This causes the index to be calculated from pointer arithmetic and is therefore an expensive operation.

See also:
SetIndex

Definition at line 308 of file itkImageConstIterator.h.

Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), itk::ImageRegionReverseConstIterator< TImage >::operator--(), and itk::ImageReverseConstIterator< TImage >::operator=().

template<typename TImage>
const RegionType& itk::ImageConstIterator< TImage >::GetRegion (  )  const [inline, inherited]

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

Definition at line 318 of file itkImageConstIterator.h.

Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().

template<typename TImage>
void itk::ImageConstIterator< TImage >::GoToBegin ( void   )  [inline, inherited]

Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region.

Reimplemented in itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionConstIterator< ImageType >.

Definition at line 343 of file itkImageConstIterator.h.

template<typename TImage>
void itk::ImageConstIterator< TImage >::GoToEnd (  )  [inline, inherited]

Move an iterator to the end of the region. "End" is defined as one pixel past the last pixel of the region.

Reimplemented in itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionConstIterator< ImageType >.

Definition at line 356 of file itkImageConstIterator.h.

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

Is the iterator at the beginning of the region? "Begin" is defined as the first pixel in the region.

Definition at line 363 of file itkImageConstIterator.h.

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

Is the iterator at the end of the region? "End" is defined as one pixel past the last pixel of the region.

Definition at line 370 of file itkImageConstIterator.h.

template<typename TImage>
bool itk::ImageConstIterator< 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 243 of file itkImageConstIterator.h.

template<typename TImage>
bool itk::ImageConstIterator< 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 274 of file itkImageConstIterator.h.

template<typename TImage>
bool itk::ImageConstIterator< 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 263 of file itkImageConstIterator.h.

template<typename TImage>
Self& itk::ImageIterator< TImage >::operator= ( const Self it  ) 

operator= is provided to make sure the handle to the image is properly reference counted.

Reimplemented from itk::ImageConstIterator< TImage >.

template<typename TImage>
Self& itk::ImageIterator< TImage >::operator= ( const ImageConstIterator< TImage > &  it  )  [protected]

This constructor is declared protected in order to enforce const-correctness

template<typename TImage>
bool itk::ImageConstIterator< 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 253 of file itkImageConstIterator.h.

template<typename TImage>
bool itk::ImageConstIterator< 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 296 of file itkImageConstIterator.h.

template<typename TImage>
bool itk::ImageConstIterator< 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 285 of file itkImageConstIterator.h.

template<typename TImage>
void itk::ImageIterator< TImage >::Set ( const PixelType value  )  const [inline]

Set the pixel value

Definition at line 117 of file itkImageIterator.h.

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

Set the index. No bounds checking is performed.

See also:
GetIndex

Reimplemented in itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionConstIterator< ImageType >.

Definition at line 313 of file itkImageConstIterator.h.

template<typename TImage>
const PixelType& itk::ImageConstIterator< 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 332 of file itkImageConstIterator.h.

template<typename TImage>
PixelType& itk::ImageIterator< TImage >::Value ( void   )  [inline]

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

Definition at line 128 of file itkImageIterator.h.


Member Data Documentation

template<typename TImage>
const unsigned int itk::ImageIterator< TImage >::ImageIteratorDimension = TImage::ImageDimension [static]

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 from itk::ImageConstIterator< TImage >.

Definition at line 75 of file itkImageIterator.h.

template<typename TImage>
unsigned long itk::ImageConstIterator< TImage >::m_BeginOffset [protected, inherited]
template<typename TImage>
const InternalPixelType* itk::ImageConstIterator< TImage >::m_Buffer [protected, inherited]
template<typename TImage>
unsigned long itk::ImageConstIterator< TImage >::m_EndOffset [protected, inherited]
template<typename TImage>
TImage::ConstWeakPointer itk::ImageConstIterator< TImage >::m_Image [protected, inherited]
template<typename TImage>
unsigned long itk::ImageConstIterator< TImage >::m_Offset [protected, inherited]
template<typename TImage>
AccessorType itk::ImageConstIterator< TImage >::m_PixelAccessor [protected, inherited]
template<typename TImage>
AccessorFunctorType itk::ImageConstIterator< TImage >::m_PixelAccessorFunctor [protected, inherited]
template<typename TImage>
RegionType itk::ImageConstIterator< TImage >::m_Region [protected, inherited]

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

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