A multi-dimensional iterator templated over image type that walks a region of pixels. More...

#include <itkImageRegionIterator.h>

Inheritance diagram for itk::ImageRegionIterator< TImage >:

Collaboration diagram for itk::ImageRegionIterator< TImage >:

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 ImageRegionIterator	Self
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef ImageRegionConstIterator < TImage >	Superclass
Public Member Functions
Self	Begin (void) const
Self	End (void) const
PixelType	Get (void) const
const ImageType *	GetImage () const
const IndexType	GetIndex () const
virtual const char *	GetNameOfClass () const
const RegionType &	GetRegion () const
void	GoToBegin ()
void	GoToEnd ()
	ImageRegionIterator (ImageType *ptr, const RegionType &region)
	ImageRegionIterator (const ImageIterator< TImage > &it)
	ImageRegionIterator ()
bool	IsAtBegin (void) const
bool	IsAtEnd (void) const
void	Set (const PixelType &value) const
PixelType &	Value (void)
const PixelType &	Value (void) const


void	SetIndex (const IndexType &ind)


Self &	operator++ ()


Self &	operator-- ()


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 = Superclass::ImageIteratorDimension
Protected Member Functions


	ImageRegionIterator (const ImageRegionConstIterator< TImage > &it)
Self &	operator= (const ImageRegionConstIterator< TImage > &it)
Protected Attributes
unsigned long	m_BeginOffset
const InternalPixelType *	m_Buffer
unsigned long	m_EndOffset
TImage::ConstWeakPointer	m_Image
unsigned long	m_Offset
AccessorType	m_PixelAccessor
AccessorFunctorType	m_PixelAccessorFunctor
RegionType	m_Region
unsigned long	m_SpanBeginOffset
unsigned long	m_SpanEndOffset

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

Detailed Description

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

A multi-dimensional iterator templated over image type that walks a region of pixels.

The itk::ImageRegionIterator is optimized for iteration speed and is the first choice for iterative, pixel-wise operations on an image. ImageRegionIterator is the least specialized of the ITK image iterator classes. ImageRegionIterator is templated over the image type, and is constrained to walk only within the specified region and along a line parallel to one of the coordinate axes, "wrapping" to the next line as it reaches the boundary of the image. To walk the entire image, specify the region to be image->GetRequestedRegion().

Most of the functionality is inherited from the ImageRegionConstIterator. The current class only adds write access to image pixels.

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.

Examples:: Iterators/ImageRegionIterator.cxx, and Testing/Code/Common/itkVectorImageTest.cxx.

Definition at line 72 of file itkImageRegionIterator.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::ImageRegionIterator< TImage >::AccessorType

Accessor type that convert data between internal and external representations.

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 92 of file itkImageRegionIterator.h.

template<typename TImage>

typedef Superclass::ImageType itk::ImageRegionIterator< 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.

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 87 of file itkImageRegionIterator.h.

template<typename TImage>

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

Types inherited from the Superclass

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 80 of file itkImageRegionIterator.h.

template<typename TImage>

typedef Superclass::IndexValueType itk::ImageRegionIterator< TImage >::IndexValueType

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 81 of file itkImageRegionIterator.h.

template<typename TImage>

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

Internal Pixel Type

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 90 of file itkImageRegionIterator.h.

template<typename TImage>

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

Offset typedef support.

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 84 of file itkImageRegionIterator.h.

template<typename TImage>

typedef Superclass::OffsetValueType itk::ImageRegionIterator< TImage >::OffsetValueType

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 85 of file itkImageRegionIterator.h.

template<typename TImage>

typedef Superclass::PixelContainer itk::ImageRegionIterator< 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::ImageRegionConstIterator< TImage >.

Definition at line 88 of file itkImageRegionIterator.h.

template<typename TImage>

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

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 89 of file itkImageRegionIterator.h.

template<typename TImage>

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

External Pixel Type

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 91 of file itkImageRegionIterator.h.

template<typename TImage>

typedef Superclass::RegionType itk::ImageRegionIterator< TImage >::RegionType

Region typedef support.

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 86 of file itkImageRegionIterator.h.

template<typename TImage>

typedef ImageRegionIterator itk::ImageRegionIterator< TImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 76 of file itkImageRegionIterator.h.

template<typename TImage>

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

Size 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.

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 82 of file itkImageRegionIterator.h.

template<typename TImage>

typedef Superclass::SizeValueType itk::ImageRegionIterator< TImage >::SizeValueType

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 83 of file itkImageRegionIterator.h.

template<typename TImage>

typedef ImageRegionConstIterator<TImage> itk::ImageRegionIterator< TImage >::Superclass

Reimplemented from itk::ImageRegionConstIterator< TImage >.

Definition at line 77 of file itkImageRegionIterator.h.

Constructor & Destructor Documentation

template<typename TImage>

itk::ImageRegionIterator< TImage >::ImageRegionIterator ( )

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>

itk::ImageRegionIterator< TImage >::ImageRegionIterator	(	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::ImageRegionIterator< TImage >::ImageRegionIterator ( const ImageIterator< TImage > & it )

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

template<typename TImage>

itk::ImageRegionIterator< TImage >::ImageRegionIterator ( const ImageRegionConstIterator< 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::ImageRegionIterator< 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::ImageRegionConstIterator< TImage >.

template<typename TImage>

Self itk::ImageRegionIterator< 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::ImageRegionConstIterator< 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>

const ImageType* itk::ImageConstIterator< TImage >::GetImage ( ) const [inline, inherited]

Get the image that this iterator walks.

Reimplemented in itk::ImageIterator< TImage >.

Definition at line 322 of file itkImageConstIterator.h.

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

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>

virtual const char* itk::ImageRegionConstIterator< TImage >::GetNameOfClass ( ) const [virtual, inherited]

Run-time type information (and related methods).

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

Definition at line 210 of file itkImageRegionConstIterator.h.

template<typename TImage>

void itk::ImageRegionConstIterator< TImage >::GoToEnd ( void ) [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 from itk::ImageConstIterator< TImage >.

Definition at line 221 of file itkImageRegionConstIterator.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>

Self& itk::ImageRegionConstIterator< TImage >::operator++ ( ) [inline, inherited]

Increment (prefix) the fastest moving dimension of the iterator's index. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the end of the row of the region to the beginning of the next row of the region) up until the iterator tries to moves past the last pixel of the region. Here, the iterator will be set to be one pixel past the end of the region.

See also:: operator++(int)

Definition at line 261 of file itkImageRegionConstIterator.h.

template<typename TImage>

Self& itk::ImageRegionConstIterator< TImage >::operator-- ( ) [inline, inherited]

Decrement (prefix) the fastest moving dimension of the iterator's index. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the beginning of the row of the region to the end of the next row of the region) up until the iterator tries to moves past the first pixel of the region. Here, the iterator will be set to be one pixel past the beginning of the region.

See also:: operator--(int)

Definition at line 278 of file itkImageRegionConstIterator.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::ImageRegionIterator< TImage >::operator= ( const ImageRegionConstIterator< TImage > & it ) [protected]

the construction from a const iterator 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::ImageRegionIterator< TImage >::Set ( const PixelType & value ) const [inline]

Set the pixel value

Definition at line 111 of file itkImageRegionIterator.h.

template<typename TImage>

void itk::ImageRegionConstIterator< TImage >::SetIndex ( const IndexType & ind ) [inline, virtual, inherited]

Set the index. No bounds checking is performed. This is overridden from the parent because we have an extra ivar.

See also:: GetIndex

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 244 of file itkImageRegionConstIterator.h.

template<typename TImage>

PixelType& itk::ImageRegionIterator< 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 120 of file itkImageRegionIterator.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.

Member Data Documentation

template<typename TImage>

const unsigned int itk::ImageRegionConstIterator< TImage >::ImageIteratorDimension = Superclass::ImageIteratorDimension [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 from itk::ImageConstIterator< TImage >.

Definition at line 120 of file itkImageRegionConstIterator.h.

template<typename TImage>

unsigned long itk::ImageConstIterator< TImage >::m_BeginOffset [protected, inherited]

Definition at line 381 of file itkImageConstIterator.h.

Referenced by itk::ImageConstIterator< ImageType >::ImageConstIterator(), and itk::ImageConstIterator< ImageType >::operator=().

template<typename TImage>

const InternalPixelType* itk::ImageConstIterator< TImage >::m_Buffer [protected, inherited]

Definition at line 384 of file itkImageConstIterator.h.

Referenced by itk::ImageConstIterator< ImageType >::ImageConstIterator(), itk::ImageConstIterator< ImageType >::operator!=(), itk::ImageConstIterator< ImageType >::operator<(), itk::ImageConstIterator< ImageType >::operator<=(), itk::ImageConstIterator< ImageType >::operator=(), itk::ImageConstIterator< ImageType >::operator==(), itk::ImageConstIterator< ImageType >::operator>(), and itk::ImageConstIterator< ImageType >::operator>=().