itk::VectorImage< TPixel, VImageDimension > Class Template Reference
[Image Representation Objects]

Templated n-dimensional vector image class. More...

#include <itkVectorImage.h>

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

[legend]Collaboration diagram for itk::VectorImage< TPixel, VImageDimension >:

[legend]List of all members.

Public Types
typedef VectorImage	Self
typedef ImageBase< VImageDimension >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef Array< TPixel >	PixelType
typedef TPixel	InternalPixelType
typedef TPixel	ValueType
typedef DefaultVectorPixelAccessor< InternalPixelType >	AccessorType
typedef DefaultVectorPixelAccessorFunctor< Self >	AccessorFunctorType
typedef ImportImageContainer< unsigned long, InternalPixelType >	PixelContainer
typedef Superclass::IndexType	IndexType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::SizeType	SizeType
typedef Superclass::DirectionType	DirectionType
typedef Superclass::RegionType	RegionType
typedef Superclass::SpacingType	SpacingType
typedef Superclass::PointType	PointType
typedef PixelContainer::Pointer	PixelContainerPointer
typedef PixelContainer::ConstPointer	PixelContainerConstPointer
typedef Superclass::OffsetValueType	OffsetValueType
typedef unsigned int	VectorLengthType
Public Member Functions
virtual const char *	GetNameOfClass () const
void	Allocate ()
virtual void	Initialize ()
void	FillBuffer (const PixelType &value)
void	SetPixel (const IndexType &index, const PixelType &value)
const PixelType	GetPixel (const IndexType &index) const
PixelType	GetPixel (const IndexType &index)
PixelContainer *	GetPixelContainer ()
const PixelContainer *	GetPixelContainer () const
void	SetPixelContainer (PixelContainer *container)
virtual void	Graft (const ImageBase< VImageDimension > *data)
AccessorType	GetPixelAccessor (void)
const AccessorType	GetPixelAccessor (void) const
InternalPixelType *	GetBufferPointer ()
const InternalPixelType *	GetBufferPointer () const
virtual void	SetVectorLength (VectorLengthType _arg)
virtual const VectorLengthType &	GetVectorLength ()
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	VectorImage ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~VectorImage ()

---

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< double, 3 > is the same as a Image< Array< double >, 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 Array 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 Array< double > when queried, with the data internally pointing to the buffer. (the container does not manage the memory). Similarly SetPixel calls can be made with Array< double >.

The API of this class is similar to Image.

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

Testing/Code/Common/itkVectorImageTest.cxx

Definition at line 74 of file itkVectorImage.h.

---

Member Typedef Documentation

template<class TPixel, unsigned int VImageDimension = 3> typedef DefaultVectorPixelAccessorFunctor< Self > itk::VectorImage< TPixel, VImageDimension >::AccessorFunctorType

Functor to provide a common API between DefaultPixelAccessor and DefaultVectorPixelAccessor Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 111 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> typedef DefaultVectorPixelAccessor< InternalPixelType > itk::VectorImage< TPixel, VImageDimension >::AccessorType

Accessor type that convert data between internal and external representations. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 107 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> typedef SmartPointer<const Self> itk::VectorImage< TPixel, VImageDimension >::ConstPointer

Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 82 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> typedef WeakPointer<const Self> itk::VectorImage< TPixel, VImageDimension >::ConstWeakPointer

Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 83 of file itkVectorImage.h.

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

Direction typedef support. A matrix of direction cosines. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 126 of file itkVectorImage.h.

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

Index typedef support. An index is used to access pixel values. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 117 of file itkVectorImage.h.

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

This is the actual pixel type contained in the buffer. Each vector pixel is composed of 'm_VectorLength' contiguous InternalPixelType. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 100 of file itkVectorImage.h.

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

Offset typedef support. An offset is used to access pixel values. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 120 of file itkVectorImage.h.

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

Offset typedef (relative position between indices) Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 144 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> typedef ImportImageContainer<unsigned long, InternalPixelType> itk::VectorImage< TPixel, VImageDimension >::PixelContainer

Container used to store pixels in the image. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 114 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> typedef PixelContainer::ConstPointer itk::VectorImage< TPixel, VImageDimension >::PixelContainerConstPointer

Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 141 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> typedef PixelContainer::Pointer itk::VectorImage< TPixel, VImageDimension >::PixelContainerPointer

A pointer to the pixel container. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 140 of file itkVectorImage.h.

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

Pixel typedef support. Used to declare pixel type in filters or other operations. This is not the actual pixel type contained in the buffer, ie m_Buffer. The image exhibits an external API of an Array< T > and internally stores its data as type T. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 89 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> typedef SmartPointer<Self> itk::VectorImage< TPixel, VImageDimension >::Pointer

Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 81 of file itkVectorImage.h.

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

Origin typedef support. The origin is the geometric coordinates of the index (0,0). Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 137 of file itkVectorImage.h.

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

Region typedef support. A region is used to specify a subset of an image. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 129 of file itkVectorImage.h.

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

Standard class typedefs Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 79 of file itkVectorImage.h.

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

Size typedef support. A size is used to define region bounds. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 123 of file itkVectorImage.h.

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

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 133 of file itkVectorImage.h.

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

Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 80 of file itkVectorImage.h.

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

Typedef alias for PixelType Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 103 of file itkVectorImage.h.

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

Definition at line 146 of file itkVectorImage.h.

---

Constructor & Destructor Documentation

template<class TPixel, unsigned int VImageDimension = 3> itk::VectorImage< TPixel, VImageDimension >::VectorImage (   )  [protected]

template<class TPixel, unsigned int VImageDimension = 3> virtual itk::VectorImage< TPixel, VImageDimension >::~VectorImage (   )  [inline, protected, virtual]

Definition at line 240 of file itkVectorImage.h.

---

Member Function Documentation

template<class TPixel, unsigned int VImageDimension = 3> void itk::VectorImage< TPixel, VImageDimension >::Allocate (   )

Allocate the image memory. The size of the image must already be set, e.g. by calling SetRegions(). Reimplemented from itk::Image< Array< TPixel >, VImageDimension >.

template<class TPixel, unsigned int VImageDimension = 3> void itk::VectorImage< TPixel, VImageDimension >::FillBuffer (  const PixelType &  value  )

Fill the image buffer with a value. Be sure to call Allocate() first.

template<class TPixel, unsigned int VImageDimension = 3> const InternalPixelType* itk::VectorImage< TPixel, VImageDimension >::GetBufferPointer (   )  const [inline]

Return a pointer to the beginning of the buffer. This is used by the image iterator class. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 195 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> InternalPixelType* itk::VectorImage< TPixel, VImageDimension >::GetBufferPointer (   )  [inline]

Return a pointer to the beginning of the buffer. This is used by the image iterator class. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 193 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> virtual const char* itk::VectorImage< TPixel, VImageDimension >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Image< Array< TPixel >, VImageDimension >.

template<class TPixel, unsigned int VImageDimension = 3> PixelType itk::VectorImage< TPixel, VImageDimension >::GetPixel (  const IndexType &  index  )  [inline]

Get a reference to a pixel (e.g. for editing). For efficiency, this function does not check that the image has actually been allocated yet. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 184 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> const PixelType itk::VectorImage< TPixel, VImageDimension >::GetPixel (  const IndexType &  index  )  const [inline]

Get a pixel (read only version). For efficiency, this function does not check that the image has actually been allocated yet. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 173 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> const AccessorType itk::VectorImage< TPixel, VImageDimension >::GetPixelAccessor (  void   )  const [inline]

Return the Pixel Accesor object Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 228 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> AccessorType itk::VectorImage< TPixel, VImageDimension >::GetPixelAccessor (  void   )  [inline]

Return the Pixel Accessor object Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 224 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> const PixelContainer* itk::VectorImage< TPixel, VImageDimension >::GetPixelContainer (   )  const [inline]

Return a pointer to the container. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 204 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> PixelContainer* itk::VectorImage< TPixel, VImageDimension >::GetPixelContainer (   )  [inline]

Return a pointer to the container. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >. Definition at line 200 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> virtual const VectorLengthType& itk::VectorImage< TPixel, VImageDimension >::GetVectorLength (   )  [virtual]

Set/Get macros for the length of each vector in the vector image

template<class TPixel, unsigned int VImageDimension = 3> virtual void itk::VectorImage< TPixel, VImageDimension >::Graft (  const ImageBase< VImageDimension > *  data  )  [virtual]

Graft the data and information from one image to another. This is a convenience method to setup a second image with all the meta information of another image and use the same pixel container. Note that this method is different than just using two SmartPointers to the same image since separate DataObjects are still maintained. This method is similar to ImageSource::GraftOutput(). The implementation in ImageBase simply calls CopyInformation() and copies the region ivars. The implementation here refers to the superclass' implementation and then copies over the pixel container. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >.

template<class TPixel, unsigned int VImageDimension = 3> virtual void itk::VectorImage< TPixel, VImageDimension >::Initialize (   )  [virtual]

Restore the data object to its initial state. This means releasing memory. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >.

template<class TPixel, unsigned int VImageDimension = 3> static Pointer itk::VectorImage< TPixel, VImageDimension >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >.

template<class TPixel, unsigned int VImageDimension = 3> void itk::VectorImage< TPixel, VImageDimension >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Compute the index of the pixel at a specified offset from the beginning of the buffered region. Bounds checking is not performed. Thus, the computed index could be outside the BufferedRegion. To ensure a valid index, the parameter "offset" should be between 0 and the number of pixels in the BufferedRegion (the latter can be found using ImageRegion::GetNumberOfPixels()). Reimplemented from itk::Image< Array< TPixel >, VImageDimension >.

template<class TPixel, unsigned int VImageDimension = 3> void itk::VectorImage< TPixel, VImageDimension >::SetPixel (  const IndexType &  index, const PixelType &  value )  [inline]

Definition at line 160 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> void itk::VectorImage< TPixel, VImageDimension >::SetPixelContainer (  PixelContainer *  container  )

Set the container to use. Note that this does not cause the DataObject to be modified. Reimplemented from itk::Image< Array< TPixel >, VImageDimension >.

template<class TPixel, unsigned int VImageDimension = 3> virtual void itk::VectorImage< TPixel, VImageDimension >::SetVectorLength (  VectorLengthType  _arg  )  [virtual]

Set/Get macros for the length of each vector in the vector image

---

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

• itkVectorImage.h

---