#include <itkVectorImageRegionIterator.h>

Inheritance diagram for itk::VectorImageRegionIterator< TImage >:

Collaboration diagram for itk::VectorImageRegionIterator< TImage >:

Detailed Description

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

A multi-dimensional iterator templated over image type.

See also: itkVectorImageRegionIteratorWithIndexTest.cxx

Definition at line 34 of file itkVectorImageRegionIterator.h.

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 VariableLengthVector< InternalPixelType >	PixelVectorType

typedef Superclass::RegionType	RegionType

typedef VectorImageRegionIterator	Self

typedef Superclass::SizeType	SizeType

typedef ImageRegionIterator< TImage >	Superclass

Public Member Functions
void	GetVector (PixelVectorType &vec, const int offIndex=0) const

Self &	operator= (const Self &it)

void	SetRegion (const RegionType &regionInput)

void	SetVector (const PixelVectorType &value, const int offIndex=0) const

	typedef (itk::Concept::SameType< ImageType, VectorImage< InternalPixelType, ImageIteratorDimension > >) SameTypeCheck

	typedef (itk::Concept::SameType< PixelType, PixelVectorType >) SameTypeCheck2

	VectorImageRegionIterator ()

	VectorImageRegionIterator (const Self &it)

	VectorImageRegionIterator (TImage *ptr, const RegionType &region, int vectorAxis=-1)

	~VectorImageRegionIterator ()

Static Public Attributes
static const unsigned int	ImageIteratorDimension = TImage::ImageDimension

Protected Member Functions
Self &	operator= (const ImageRegionIterator< TImage > &it)

	VectorImageRegionIterator (const ImageRegionIterator< TImage > &it)

Protected Attributes
int	m_VectorAxis

int	m_VectorSize

OffsetValueType	m_VectorStride

Member Typedef Documentation

template<typename TImage >

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

Definition at line 61 of file itkVectorImageRegionIterator.h.

template<typename TImage >

typedef Superclass::ImageType itk::VectorImageRegionIterator< TImage >::ImageType

Definition at line 56 of file itkVectorImageRegionIterator.h.

template<typename TImage >

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

Inherit types from the superclass

Definition at line 52 of file itkVectorImageRegionIterator.h.

template<typename TImage >

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

Definition at line 59 of file itkVectorImageRegionIterator.h.

template<typename TImage >

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

Definition at line 54 of file itkVectorImageRegionIterator.h.

template<typename TImage >

typedef Superclass::PixelContainer itk::VectorImageRegionIterator< TImage >::PixelContainer

Definition at line 57 of file itkVectorImageRegionIterator.h.

template<typename TImage >

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

Definition at line 58 of file itkVectorImageRegionIterator.h.

template<typename TImage >

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

Definition at line 60 of file itkVectorImageRegionIterator.h.

template<typename TImage >

typedef VariableLengthVector< InternalPixelType > itk::VectorImageRegionIterator< TImage >::PixelVectorType

Definition at line 63 of file itkVectorImageRegionIterator.h.

template<typename TImage >

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

Definition at line 55 of file itkVectorImageRegionIterator.h.

template<typename TImage >

typedef VectorImageRegionIterator itk::VectorImageRegionIterator< TImage >::Self

Standard class typedefs.

Definition at line 38 of file itkVectorImageRegionIterator.h.

template<typename TImage >

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

Definition at line 53 of file itkVectorImageRegionIterator.h.

template<typename TImage >

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

Define the superclass

Definition at line 48 of file itkVectorImageRegionIterator.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::VectorImageRegionIterator< TImage >::VectorImageRegionIterator ( )

inline

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

Definition at line 75 of file itkVectorImageRegionIterator.h.

References itk::VectorImageRegionIterator< TImage >::ImageIteratorDimension, itk::VectorImageRegionIterator< TImage >::m_VectorAxis, itk::VectorImageRegionIterator< TImage >::m_VectorSize, and itk::VectorImageRegionIterator< TImage >::m_VectorStride.

Referenced by itk::VectorImageRegionIterator< TImage >::GetVector(), and itk::VectorImageRegionIterator< Image< TPixel, VImageDimension > >::GetVector().

Here is the caller graph for this function:

template<typename TImage >

itk::VectorImageRegionIterator< TImage >::~VectorImageRegionIterator ( )

inline

Default Destructor

Definition at line 83 of file itkVectorImageRegionIterator.h.

template<typename TImage >

itk::VectorImageRegionIterator< TImage >::VectorImageRegionIterator ( const Self & it )

inline

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

Definition at line 87 of file itkVectorImageRegionIterator.h.

References itk::VectorImageRegionIterator< TImage >::m_VectorAxis, itk::VectorImageRegionIterator< TImage >::m_VectorSize, and itk::VectorImageRegionIterator< TImage >::m_VectorStride.

template<typename TImage >

itk::VectorImageRegionIterator< TImage >::VectorImageRegionIterator	(	TImage *	ptr,
		const RegionType &	region,
		int	vectorAxis = `-1`
	)

inline

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

Definition at line 96 of file itkVectorImageRegionIterator.h.

References itk::VectorImageRegionIterator< TImage >::ImageIteratorDimension, itk::VectorImageRegionIterator< TImage >::m_VectorAxis, itk::VectorImageRegionIterator< TImage >::m_VectorSize, itk::VectorImageRegionIterator< TImage >::m_VectorStride, and itk::VectorImageRegionIterator< TImage >::SetRegion().

Here is the call graph for this function:

template<typename TImage >

itk::VectorImageRegionIterator< TImage >::VectorImageRegionIterator ( const ImageRegionIterator< TImage > & it )

protected

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

Member Function Documentation

template<typename TImage >

void itk::VectorImageRegionIterator< TImage >::GetVector	(	PixelVectorType &	vec,
		const int	offIndex = `0`
	)		const

inline

Get the pixel value

Definition at line 207 of file itkVectorImageRegionIterator.h.

References itk::VectorImageRegionIterator< TImage >::ImageIteratorDimension, itk::VectorImageRegionIterator< TImage >::m_VectorAxis, itk::VectorImageRegionIterator< TImage >::m_VectorSize, itk::VectorImageRegionIterator< TImage >::m_VectorStride, itk::VectorImageRegionIterator< TImage >::operator=(), and itk::VectorImageRegionIterator< TImage >::VectorImageRegionIterator().

Here is the call graph for this function:

template<typename TImage >

Self& itk::VectorImageRegionIterator< TImage >::operator= ( const Self & it )

inline

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

Definition at line 125 of file itkVectorImageRegionIterator.h.

References itk::VectorImageRegionIterator< TImage >::m_VectorAxis, itk::VectorImageRegionIterator< TImage >::m_VectorSize, and itk::VectorImageRegionIterator< TImage >::m_VectorStride.

Referenced by itk::VectorImageRegionIterator< TImage >::GetVector(), and itk::VectorImageRegionIterator< Image< TPixel, VImageDimension > >::GetVector().

Here is the caller graph for this function:

template<typename TImage >

Self& itk::VectorImageRegionIterator< TImage >::operator= ( const ImageRegionIterator< TImage > & it )

protected

template<typename TImage >

void itk::VectorImageRegionIterator< TImage >::SetRegion ( const RegionType & regionInput )

inline

Set the region of the image to iterate over.

Definition at line 134 of file itkVectorImageRegionIterator.h.

References itk::VectorImageRegionIterator< TImage >::ImageIteratorDimension, and itk::VectorImageRegionIterator< TImage >::m_VectorAxis.

Referenced by itk::VectorImageRegionIterator< TImage >::VectorImageRegionIterator(), and itk::VectorImageRegionIterator< Image< TPixel, VImageDimension > >::VectorImageRegionIterator().

Here is the caller graph for this function:

template<typename TImage >

void itk::VectorImageRegionIterator< TImage >::SetVector	(	const PixelVectorType &	value,
		const int	offIndex = `0`
	)		const

inline

Set the pixel value

Definition at line 186 of file itkVectorImageRegionIterator.h.

References itk::VectorImageRegionIterator< TImage >::ImageIteratorDimension, itk::VectorImageRegionIterator< TImage >::m_VectorAxis, itk::VectorImageRegionIterator< TImage >::m_VectorSize, and itk::VectorImageRegionIterator< TImage >::m_VectorStride.

template<typename TImage >

itk::VectorImageRegionIterator< TImage >::typedef ( itk::Concept::SameType< ImageType, VectorImage< InternalPixelType, ImageIteratorDimension > > )

This class requires SameTypeCheck in the form of ( itk::Concept::SameType< ImageType, VectorImage<InternalPixelType, ImageIteratorDimension> > )

template<typename TImage >

itk::VectorImageRegionIterator< TImage >::typedef ( itk::Concept::SameType< PixelType, PixelVectorType > )

This class requires SameTypeCheck2 in the form of ( itk::Concept::SameType< PixelType, PixelVectorType> )

Member Data Documentation

template<typename TImage >

const unsigned int itk::VectorImageRegionIterator< 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.

Definition at line 45 of file itkVectorImageRegionIterator.h.

Referenced by itk::VectorImageRegionIterator< TImage >::GetVector(), itk::VectorImageRegionIterator< TImage >::SetRegion(), itk::VectorImageRegionIterator< TImage >::SetVector(), itk::VectorImageRegionIterator< TImage >::VectorImageRegionIterator(), and itk::VectorImageRegionIterator< Image< TPixel, VImageDimension > >::VectorImageRegionIterator().

template<typename TImage >

int itk::VectorImageRegionIterator< TImage >::m_VectorAxis

protected

Definition at line 240 of file itkVectorImageRegionIterator.h.