itk::ImageLinearIteratorWithIndex< TImage > Class Template Reference

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

#include <itkImageLinearIteratorWithIndex.h>

Inheritance diagram for itk::ImageLinearIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageLinearIteratorWithIndex< TImage >:

List of all members.

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

---

Detailed Description

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

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

This iterator is a subclass of itk::ImageLinearConstIteratorWithIndex that adds write-access functionality. Please see itk::ImageLinearConstIteratorWithIndex 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

Examples:

ImageLinearIteratorWithIndex.cxx, and itkVectorImageTest.cxx.

Definition at line 67 of file itkImageLinearIteratorWithIndex.h.

---

Member Typedef Documentation

template<typename TImage>

typedef Superclass::AccessorType itk::ImageLinearIteratorWithIndex< TImage >::AccessorType

Accessor type that converts data between internal and external representations.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 84 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::ImageType itk::ImageLinearIteratorWithIndex< 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::ImageLinearConstIteratorWithIndex< TImage >.

Definition at line 79 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::IndexType itk::ImageLinearIteratorWithIndex< TImage >::IndexType

Types inherited from the Superclass

Reimplemented from itk::ImageLinearConstIteratorWithIndex< TImage >.

Definition at line 75 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::InternalPixelType itk::ImageLinearIteratorWithIndex< TImage >::InternalPixelType

Internal Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 82 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::OffsetType itk::ImageLinearIteratorWithIndex< TImage >::OffsetType

Type of the Offset taken from the image

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 77 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::PixelContainer itk::ImageLinearIteratorWithIndex< 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::ImageLinearConstIteratorWithIndex< TImage >.

Definition at line 80 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::PixelContainerPointer itk::ImageLinearIteratorWithIndex< TImage >::PixelContainerPointer

Reimplemented from itk::ImageLinearConstIteratorWithIndex< TImage >.

Definition at line 81 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::PixelType itk::ImageLinearIteratorWithIndex< TImage >::PixelType

External Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 83 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::RegionType itk::ImageLinearIteratorWithIndex< 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::ImageLinearConstIteratorWithIndex< TImage >.

Definition at line 78 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>

typedef ImageLinearIteratorWithIndex itk::ImageLinearIteratorWithIndex< TImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageLinearConstIteratorWithIndex< TImage >.

Definition at line 71 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>

typedef Superclass::SizeType itk::ImageLinearIteratorWithIndex< TImage >::SizeType

Size typedef support.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 76 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>

typedef ImageLinearConstIteratorWithIndex< TImage > itk::ImageLinearIteratorWithIndex< TImage >::Superclass

Reimplemented from itk::ImageLinearConstIteratorWithIndex< TImage >.

Definition at line 72 of file itkImageLinearIteratorWithIndex.h.

---

Constructor & Destructor Documentation

template<typename TImage>

itk::ImageLinearIteratorWithIndex< TImage >::ImageLinearIteratorWithIndex

(

)

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>

itk::ImageLinearIteratorWithIndex< TImage >::ImageLinearIteratorWithIndex	(	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::ImageLinearIteratorWithIndex< TImage >::ImageLinearIteratorWithIndex

(

const ImageIteratorWithIndex< TImage > &

it

)

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

template<typename TImage>

itk::ImageLinearIteratorWithIndex< TImage >::ImageLinearIteratorWithIndex

(

const ImageLinearConstIteratorWithIndex< 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::ImageLinearIteratorWithIndex< TImage >::operator=

(

const ImageLinearConstIteratorWithIndex< TImage > &

it

)

[protected]

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

template<typename TImage>

void itk::ImageLinearIteratorWithIndex< TImage >::Set

(

const PixelType &

value

)

const [inline]

Set the pixel value

Definition at line 102 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>

PixelType& itk::ImageLinearIteratorWithIndex< 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 108 of file itkImageLinearIteratorWithIndex.h.

---

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

• itkImageLinearIteratorWithIndex.h