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

A multi-dimensional iterator templated over image type that walks pixels within a region and is specialized to keep track of its image index location. More...

#include <itkImageRegionIteratorWithIndex.h>

Inheritance diagram for itk::ImageRegionIteratorWithIndex< TImage >:

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

[legend]List of all members.

Public Types
typedef ImageRegionIteratorWithIndex	Self
typedef ImageRegionConstIteratorWithIndex< TImage >	Superclass
typedef Superclass::IndexType	IndexType
typedef Superclass::IndexValueType	IndexValueType
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::OffsetValueType	OffsetValueType
typedef Superclass::RegionType	RegionType
typedef Superclass::ImageType	ImageType
typedef Superclass::PixelContainer	PixelContainer
typedef Superclass::PixelContainerPointer	PixelContainerPointer
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::PixelType	PixelType
typedef Superclass::AccessorType	AccessorType
Public Member Functions
	ImageRegionIteratorWithIndex ()
	ImageRegionIteratorWithIndex (TImage *ptr, const RegionType &region)
	ImageRegionIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)
void	Set (const PixelType &value) const
PixelType &	Value (void)
Protected Member Functions
	ImageRegionIteratorWithIndex (const ImageRegionConstIteratorWithIndex< TImage > &it)
Self &	operator= (const ImageRegionConstIteratorWithIndex< TImage > &it)

---

Detailed Description

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

A multi-dimensional iterator templated over image type that walks pixels within a region and is specialized to keep track of its image index location.

This class is a specialization of ImageRegionConstIteratorWithIndex that adds write-access (the Set() method). Please see ImageRegionConstIteratorWithIndex 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

ImageConstIteratorWithIndex

Definition at line 65 of file itkImageRegionIteratorWithIndex.h.

---

Member Typedef Documentation

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

Accessor type that convert data between internal and external representations. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Definition at line 85 of file itkImageRegionIteratorWithIndex.h.

template<typename TImage> typedef Superclass::ImageType itk::ImageRegionIteratorWithIndex< 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 Image back to itk::Image to that is it not confused with ImageIterator::Image. Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >. Definition at line 80 of file itkImageRegionIteratorWithIndex.h.

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

Types inherited from the Superclass Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >. Definition at line 73 of file itkImageRegionIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Definition at line 74 of file itkImageRegionIteratorWithIndex.h.

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

Internal Pixel Type Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Definition at line 83 of file itkImageRegionIteratorWithIndex.h.

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

Type of the Offset taken from the image Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Definition at line 77 of file itkImageRegionIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Definition at line 78 of file itkImageRegionIteratorWithIndex.h.

template<typename TImage> typedef Superclass::PixelContainer itk::ImageRegionIteratorWithIndex< 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::ImageRegionConstIteratorWithIndex< TImage >. Definition at line 81 of file itkImageRegionIteratorWithIndex.h.

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

Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >. Definition at line 82 of file itkImageRegionIteratorWithIndex.h.

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

External Pixel Type Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Definition at line 84 of file itkImageRegionIteratorWithIndex.h. Referenced by itk::ImageRegionIteratorWithIndex< TImage >::Set(), and itk::ImageRegionIteratorWithIndex< TImage >::Value().

template<typename TImage> typedef Superclass::RegionType itk::ImageRegionIteratorWithIndex< 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::ImageRegionConstIteratorWithIndex< TImage >. Definition at line 79 of file itkImageRegionIteratorWithIndex.h.

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

Standard class typedefs. Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >. Definition at line 69 of file itkImageRegionIteratorWithIndex.h.

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

Size typedef support. Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Definition at line 75 of file itkImageRegionIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >. Definition at line 76 of file itkImageRegionIteratorWithIndex.h.

template<typename TImage> typedef ImageRegionConstIteratorWithIndex<TImage> itk::ImageRegionIteratorWithIndex< TImage >::Superclass

Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >. Definition at line 70 of file itkImageRegionIteratorWithIndex.h.

---

Constructor & Destructor Documentation

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

Default constructor. Needed since we provide a cast constructor.

template<typename TImage> itk::ImageRegionIteratorWithIndex< TImage >::ImageRegionIteratorWithIndex (  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::ImageRegionIteratorWithIndex< TImage >::ImageRegionIteratorWithIndex (  const ImageIteratorWithIndex< TImage > &  it  )

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

template<typename TImage> itk::ImageRegionIteratorWithIndex< TImage >::ImageRegionIteratorWithIndex (  const ImageRegionConstIteratorWithIndex< TImage > &  it  )  [protected]

the construction from a const iterator is declared protected in order to enforce const correctness.

---

Member Function Documentation

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

the construction from a const iterator is declared protected in order to enforce const correctness.

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

Set the pixel value Definition at line 104 of file itkImageRegionIteratorWithIndex.h. References itk::ImageRegionIteratorWithIndex< TImage >::PixelType.

template<typename TImage> PixelType& itk::ImageRegionIteratorWithIndex< 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 110 of file itkImageRegionIteratorWithIndex.h. References itk::ImageRegionIteratorWithIndex< TImage >::PixelType.

---

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

• itkImageRegionIteratorWithIndex.h

---