ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::VectorImage< TPixel, VImageDimension > Class Template Reference

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

#include <itkVectorImage.h>

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

List of all members.

Public Types

typedef
DefaultVectorPixelAccessorFunctor
< Self
AccessorFunctorType
typedef
DefaultVectorPixelAccessor
< InternalPixelType
AccessorType
typedef SmartPointer< const SelfConstPointer
typedef WeakPointer< const SelfConstWeakPointer
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< SelfPointer
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
PixelType GetPixel (const IndexType &index)
const PixelType GetPixel (const IndexType &index) const
AccessorType GetPixelAccessor (void)
const AccessorType GetPixelAccessor (void) const
PixelContainerGetPixelContainer ()
const PixelContainerGetPixelContainer () 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)
InternalPixelTypeGetBufferPointer ()
const InternalPixelTypeGetBufferPointer () const
virtual void SetVectorLength (VectorLengthType _arg)
virtual const VectorLengthTypeGetVectorLength ()

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< double, 3 > is the same as a Image< VariableLengthVector< 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 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< 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 VariableLengthVector< double >.

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.


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

Definition at line 121 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.

Definition at line 117 of file itkVectorImage.h.

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

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 90 of file itkVectorImage.h.

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

Definition at line 91 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::ImageBase< VImageDimension >.

Definition at line 148 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::ImageBase< VImageDimension >.

Definition at line 135 of file itkVectorImage.h.

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

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 136 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.

Definition at line 108 of file itkVectorImage.h.

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

Definition at line 113 of file itkVectorImage.h.

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

Typedef for the functor used to access a neighborhood of pixel pointers.

Definition at line 126 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::ImageBase< VImageDimension >.

Definition at line 139 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::ImageBase< VImageDimension >.

Definition at line 167 of file itkVectorImage.h.

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

Container used to store pixels in the image.

Definition at line 145 of file itkVectorImage.h.

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

Definition at line 164 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.

Definition at line 163 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3>
typedef VariableLengthVector< 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 VariableLengthVector< T > and internally stores its data as type T.

Definition at line 97 of file itkVectorImage.h.

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

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 89 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::ImageBase< VImageDimension >.

Definition at line 160 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::ImageBase< VImageDimension >.

Definition at line 152 of file itkVectorImage.h.

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

Standard class typedefs

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 87 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::ImageBase< VImageDimension >.

Definition at line 142 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::ImageBase< VImageDimension >.

Definition at line 156 of file itkVectorImage.h.

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

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 88 of file itkVectorImage.h.

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

Typedef alias for PixelType

Definition at line 111 of file itkVectorImage.h.

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

Definition at line 169 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 323 of file itkVectorImage.h.

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

Member Function Documentation

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

Allocate the image memory. The size of the image must already be set, e.g. by calling SetRegions().

Reimplemented from itk::ImageBase< VImageDimension >.

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

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::ImageBase< 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>
InternalPixelType* itk::VectorImage< TPixel, VImageDimension >::GetBufferPointer ( ) [inline]

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

Definition at line 259 of file itkVectorImage.h.

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.

Definition at line 263 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::ImageBase< VImageDimension >.

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

Return the NeighborhoodAccessor functor

Definition at line 298 of file itkVectorImage.h.

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

Return the NeighborhoodAccessor functor

Definition at line 304 of file itkVectorImage.h.

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

Get/Set the number of components each pixel has, ie the VectorLength

Reimplemented from itk::ImageBase< 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.

Definition at line 235 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. Note that the method returns a pixel on the stack.

Definition at line 223 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

Definition at line 295 of file itkVectorImage.h.

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

Return the Pixel Accessor object

Definition at line 292 of file itkVectorImage.h.

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

Return a pointer to the container.

Definition at line 270 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.

Definition at line 273 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 DataObject 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::ImageBase< 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::ImageBase< 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::ImageBase< VImageDimension >.

template<class TPixel, unsigned int VImageDimension = 3>
void itk::VectorImage< TPixel, VImageDimension >::operator= ( const Self ) [private]

Reimplemented from itk::ImageBase< VImageDimension >.

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

Access a pixel. This version cannot be an lvalue because the pixel is converted on the fly to a VariableLengthVector.

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 248 of file itkVectorImage.h.

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

Access a pixel. This version can only be an rvalue because the pixel is converted on the fly to a VariableLengthVector.

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 255 of file itkVectorImage.h.

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

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Reimplemented from itk::ImageBase< VImageDimension >.

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

Reimplemented from itk::ImageBase< VImageDimension >.

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

Set a pixel value.

Allocate() needs to have been called first -- for efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 208 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.

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

Convenience methods to set the LargestPossibleRegion, BufferedRegion and RequestedRegion. Allocate must still be called.

Definition at line 178 of file itkVectorImage.h.

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

Definition at line 186 of file itkVectorImage.h.

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


Member Data Documentation

template<class TPixel, unsigned int VImageDimension = 3>
const unsigned int itk::VectorImage< TPixel, VImageDimension >::ImageDimension = VImageDimension [static]

Dimension of the image. This constant is used by functions that are templated over image type (as opposed to being templated over pixel type and dimension) when they need compile time access to the dimension of the image.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 132 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3>
PixelContainerPointer itk::VectorImage< TPixel, VImageDimension >::m_Buffer [private]

Memory for the current buffer.

Definition at line 332 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3>
VectorLengthType itk::VectorImage< TPixel, VImageDimension >::m_VectorLength [private]

Length of the "vector pixel"

Definition at line 329 of file itkVectorImage.h.


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