#include <itkVectorImage.h>

Inheritance diagram for itk::VectorImage< TPixel, VImageDimension >:

Collaboration diagram for itk::VectorImage< TPixel, VImageDimension >:

Classes
struct	Rebind
	A structure which enable changing any image class' pixel type to another. More...
Public Types
typedef DefaultVectorPixelAccessorFunctor < Self >	AccessorFunctorType
typedef DefaultVectorPixelAccessor < InternalPixelType >	AccessorType
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef Superclass::DirectionType	DirectionType
typedef Superclass::IndexType	IndexType
typedef Superclass::IndexValueType	IndexValueType
typedef TPixel	InternalPixelType
typedef InternalPixelType	IOPixelType
typedef VectorImageNeighborhoodAccessorFunctor < Self >	NeighborhoodAccessorFunctorType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::OffsetValueType	OffsetValueType
typedef ImportImageContainer < SizeValueType, InternalPixelType >	PixelContainer
typedef PixelContainer::ConstPointer	PixelContainerConstPointer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef VariableLengthVector < TPixel >	PixelType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef Superclass::RegionType	RegionType
typedef VectorImage	Self
typedef Superclass::SizeType	SizeType
typedef Superclass::SpacingType	SpacingType
typedef ImageBase < VImageDimension >	Superclass
typedef PixelType	ValueType
typedef unsigned int	VectorLengthType
Public Member Functions
void	Allocate ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	FillBuffer (const PixelType &value)
virtual const char *	GetNameOfClass () const
NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor ()
const NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor () const
virtual unsigned int	GetNumberOfComponentsPerPixel () const
const PixelType	GetPixel (const IndexType &index) const
PixelType	GetPixel (const IndexType &index)
AccessorType	GetPixelAccessor (void)
const AccessorType	GetPixelAccessor (void) const
PixelContainer *	GetPixelContainer ()
const PixelContainer *	GetPixelContainer () const
virtual void	Graft (const DataObject *data)
virtual void	Initialize ()
PixelType	operator[] (const IndexType &index)
PixelType	operator[] (const IndexType &index) const
virtual void	SetNumberOfComponentsPerPixel (unsigned int n)
void	SetPixel (const IndexType &index, const PixelType &value)
void	SetPixelContainer (PixelContainer *container)
void	SetRegions (SizeType size)

void	SetRegions (RegionType region)

InternalPixelType *	GetBufferPointer ()
const InternalPixelType *	GetBufferPointer () const

virtual void	SetVectorLength (VectorLengthType _arg)
virtual const VectorLengthType &	GetVectorLength ()
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	ImageDimension = VImageDimension
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	VectorImage ()
virtual	~VectorImage ()
Private Member Functions
void	operator= (const Self &)
	VectorImage (const Self &)
Private Attributes
PixelContainerPointer	m_Buffer
VectorLengthType	m_VectorLength

Detailed Description

template<class TPixel, unsigned int VImageDimension = 3>
class itk::VectorImage< TPixel, VImageDimension >

Templated n-dimensional vector image class.

This class differs from Image in that it is intended to represent multiple images. Each pixel represents k measurements, each of datatype TPixel. The memory organization of the resulting image is as follows: ... Pi0 Pi1 Pi2 Pi3 P(i+1)0 P(i+1)1 P(i+1)2 P(i+1)3 P(i+2)0 ... where Pi0 represents the 0th measurement of the pixel at index i.

Conceptually, a VectorImage< TPixel, 3 > is the same as a Image< VariableLengthVector< TPixel >, 3 >. The difference lies in the memory organization. The latter results in a fragmented organization with each location in the Image holding a pointer to an VariableLengthVector holding the actual pixel. The former stores the k pixels instead of a pointer reference, which apart from avoiding fragmentation of memory also avoids storing a 8 bytes of pointer reference for each pixel. The parameter k can be set using SetVectorLength.

The API of the class is such that it returns a pixeltype VariableLengthVector< TPixel > when queried, with the data internally pointing to the buffer. (the container does not manage the memory). Similarly SetPixel calls can be made with VariableLengthVector< TPixel >.

The API of this class is similar to Image.

Caveats:: When using Iterators on this image, you cannot use the it.Value(). You must use Set/Get() methods instead.

Note:: This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149.

See also:: DefaultVectorPixelAccessor; DefaultVectorPixelAccessorFunctor; VectorImageToImagePixelAccessor; VectorImageToImageAdaptor; Image; ImportImageContainer

Examples:: Examples/Filtering/DiffusionTensor3DReconstructionImageFilter.cxx, and itkVectorImageTest.cxx.

Definition at line 82 of file itkVectorImage.h.