#include <itkVectorImageRegionIteratorWithIndex.h>

Inheritance diagram for itk::VectorImageRegionIteratorWithIndex< TImage >:

Collaboration diagram for itk::VectorImageRegionIteratorWithIndex< TImage >:

Detailed Description

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

A multi-dimensional iterator templated over image type. It provides the same interfaces for both itk::Image<T, N+1> and itk::VectorImage<T, N>

Author: Jian Cheng

If image4d is a itk::Image<double,4> or itk::VectorImage<double,3> object, and k is 0,1,2,3 axis, then the iterator could loop over axises except k-axis, and obtain a vector a long k-axis

itk::VectorImageRegionIteratorWithIndex<NDImageType> it(image4d, image4d->GetLargestPossibleRegion(),k);
int sizeVec = itk::GetVectorImageVectorSize(image4d); // number of components in t-axis
itk::VariableLengthVector<double> vec; // vector along k-axis
for (it.GoToBegin(); !it.IsAtEnd(); ++it) 
  {
  // i means the coordinate in the last axis (t-axis)
  for ( int i = 0; i < (k==3?1:sizeVec); ++i ) 
    {
    index = it.GetIndex();
    it.GetVector(vec, i);
    // do somthing for vec ...
    it.SetVector(vec, i);
    }
  }

See also: itkVectorImageRegionIteratorWithIndexTest.cxx

Definition at line 63 of file itkVectorImageRegionIteratorWithIndex.h.

Public Types
typedef Superclass::AccessorType	AccessorType

typedef Superclass::ImageType	ImageType

typedef Superclass::IndexType	IndexType

typedef Superclass::InternalPixelType	InternalPixelType

typedef ImageRegion< TImage::ImageDimension+1 >	NDImageRegionType

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 VectorImageRegionIteratorWithIndex	Self

typedef Superclass::SizeType	SizeType

typedef ImageRegionIteratorWithIndex< TImage >	Superclass

typedef ImageRegion< TImage::ImageDimension >	VectorImageRegionType

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

Self &	operator= (const Self &it)

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

	VectorImageRegionIteratorWithIndex ()

	VectorImageRegionIteratorWithIndex (const Self &it)

	VectorImageRegionIteratorWithIndex (TImage *ptr, const RegionType &regionInput, int vectorAxis=-1)

	~VectorImageRegionIteratorWithIndex ()

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

Protected Member Functions
void	Initialize (TImage *ptr, const RegionType &regionInput, int vectorAxis=-1)

Self &	operator= (const ImageRegionIteratorWithIndex< TImage > &it)

	VectorImageRegionIteratorWithIndex (const ImageRegionIteratorWithIndex< TImage > &it)

Protected Attributes
const InternalPixelType *	m_BeginBuffer

int	m_VectorAxis

int	m_VectorSize

OffsetValueType	m_VectorStride

Member Typedef Documentation

template<typename TImage>

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

Definition at line 90 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 85 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

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

Inherit types from the superclass

Definition at line 81 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 88 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

typedef ImageRegion<TImage::ImageDimension+1> itk::VectorImageRegionIteratorWithIndex< TImage >::NDImageRegionType

Definition at line 92 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 83 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 86 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 87 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 89 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 95 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 84 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

typedef VectorImageRegionIteratorWithIndex itk::VectorImageRegionIteratorWithIndex< TImage >::Self

Standard class typedefs.

Definition at line 67 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

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

Definition at line 82 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

typedef ImageRegionIteratorWithIndex< TImage > itk::VectorImageRegionIteratorWithIndex< TImage >::Superclass

Define the superclass

Definition at line 77 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

typedef ImageRegion<TImage::ImageDimension> itk::VectorImageRegionIteratorWithIndex< TImage >::VectorImageRegionType

Definition at line 93 of file itkVectorImageRegionIteratorWithIndex.h.

Constructor & Destructor Documentation

template<typename TImage>

itk::VectorImageRegionIteratorWithIndex< TImage >::VectorImageRegionIteratorWithIndex ( )

inline

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

Definition at line 107 of file itkVectorImageRegionIteratorWithIndex.h.

References itk::VectorImageRegionIteratorWithIndex< TImage >::ImageIteratorDimension, ITK_NULLPTR, itk::VectorImageRegionIteratorWithIndex< TImage >::m_BeginBuffer, itk::VectorImageRegionIteratorWithIndex< TImage >::m_VectorAxis, itk::VectorImageRegionIteratorWithIndex< TImage >::m_VectorSize, and itk::VectorImageRegionIteratorWithIndex< TImage >::m_VectorStride.

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

Here is the caller graph for this function:

template<typename TImage>

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

inline

Default Destructor

Definition at line 116 of file itkVectorImageRegionIteratorWithIndex.h.

template<typename TImage>

itk::VectorImageRegionIteratorWithIndex< TImage >::VectorImageRegionIteratorWithIndex ( 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 120 of file itkVectorImageRegionIteratorWithIndex.h.

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

template<typename TImage>

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

inline

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

Definition at line 130 of file itkVectorImageRegionIteratorWithIndex.h.

References itk::VectorImageRegionIteratorWithIndex< TImage >::Initialize().

Here is the call graph for this function:

template<typename TImage>

itk::VectorImageRegionIteratorWithIndex< TImage >::VectorImageRegionIteratorWithIndex ( const ImageRegionIteratorWithIndex< TImage > & it )

protected

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

Member Function Documentation

template<typename TImage>

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

inline

Get the pixel value. offindex is the coordinate in t-axis, it is only used when m_VectorAxis!=ImageIteratorDimension.

Definition at line 175 of file itkVectorImageRegionIteratorWithIndex.h.

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

Referenced by PrintImage(), itk::MultiVariableFunctorVectorImageFilter< TInputImage, TOutputImage, TFunction, TMaskImage >::ThreadedGenerateData(), itk::FunctorFromStringImageFilter< TInputImage, TOutputImage, TMaskImage >::ThreadedGenerateData(), and itk::UnaryFunctorVectorImageFilter< TInputImage, TOutputImage, TFunction, TMaskImage >::ThreadedGenerateData().

Here is the caller graph for this function:

template<typename TImage>

void itk::VectorImageRegionIteratorWithIndex< TImage >::Initialize	(	TImage *	ptr,
		const RegionType &	regionInput,
		int	vectorAxis = `-1`
	)

inlineprotected

Definition at line 199 of file itkVectorImageRegionIteratorWithIndex.h.

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

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename TImage>

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

inline

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

Definition at line 144 of file itkVectorImageRegionIteratorWithIndex.h.

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

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

Here is the caller graph for this function:

template<typename TImage>

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

protected

template<typename TImage>

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

inline

Set the pixel value. offindex is the coordinate in t-axis, it is only used when m_VectorAxis!=ImageIteratorDimension.

Definition at line 155 of file itkVectorImageRegionIteratorWithIndex.h.

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

Referenced by BinaryOPImage(), itk::MultiVariableFunctorVectorImageFilter< TInputImage, TOutputImage, TFunction, TMaskImage >::ThreadedGenerateData(), itk::FunctorFromStringImageFilter< TInputImage, TOutputImage, TMaskImage >::ThreadedGenerateData(), and itk::UnaryFunctorVectorImageFilter< TInputImage, TOutputImage, TFunction, TMaskImage >::ThreadedGenerateData().

Here is the caller graph for this function:

template<typename TImage>

itk::VectorImageRegionIteratorWithIndex< 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::VectorImageRegionIteratorWithIndex< 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::VectorImageRegionIteratorWithIndex< 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 74 of file itkVectorImageRegionIteratorWithIndex.h.