itk::VectorImage< TPixel, VImageDimension > Class Template Reference

#include <itkVectorImage.h>

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

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

[legend]List of all members.

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

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 TPixel	InternalPixelType
typedef InternalPixelType	IOPixelType
typedef VectorImageNeighborhoodAccessorFunctor< Self >	NeighborhoodAccessorFunctorType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::OffsetValueType	OffsetValueType
typedef ImportImageContainer< unsigned long, 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 TPixel	ValueType
typedef unsigned int	VectorLengthType
Public Member Functions
void	Allocate ()
void	FillBuffer (const PixelType &value)
const InternalPixelType *	GetBufferPointer () const
Return a pointer to the beginning of the buffer This is used by *the image iterator class *InternalPixelType *	GetBufferPointer ()
virtual const char *	GetNameOfClass () const
const NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor () const
NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor ()
Get Set the number of components each pixel ie the VectorLength *virtual unsigned int	GetNumberOfComponentsPerPixel () const
PixelType	GetPixel (const IndexType &index)
const PixelType	GetPixel (const IndexType &index) const
const AccessorType	GetPixelAccessor (void) const
AccessorType	GetPixelAccessor (void)
const PixelContainer *	GetPixelContainer () const
PixelContainer *	GetPixelContainer ()
virtual const VectorLengthType &	GetVectorLength ()
virtual void	Graft (const DataObject *data)
virtual void	Initialize ()
	itkStaticConstMacro (ImageDimension, unsigned int, VImageDimension)
const TPixel &	operator[] (const IndexType &index) const
TPixel &	operator[] (const IndexType &index)
Get a physical	point (in the space which *the origin and spacing infomation comes from)*from a continuous index(in the index space)*\sa Transform */template< class TCoordRep > void TransformContinuousIndexToPhysicalPoint(const ContinuousIndex< TCoordRep
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	SetNumberOfComponentsPerPixel (unsigned int n)
void	SetPixel (const IndexType &index, const PixelType &value)
void	SetPixelContainer (PixelContainer *container)
void	SetRegions (SizeType size)
Convenience methods to set the *BufferedRegion and RequestedRegion Allocate must still be called *void	SetRegions (RegionType region)
Set Get macros for the length of each vector in the vector image *virtual void	SetVectorLength (VectorLengthType _arg)
template<class TCoordRep>
bool	TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TCoordRep, VImageDimension > &index) const
template<class TCoordRep>
bool	TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
virtual	~VectorImage ()
Static Public Member Functions
static Pointer	New ()
Public Attributes
Get Set the number of components each pixel	has
Get a physical VImageDimension &	index
Convenience methods to set the	LargestPossibleRegion

---

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 118 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 114 of file itkVectorImage.h.

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

Definition at line 87 of file itkVectorImage.h.

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

Definition at line 88 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. Definition at line 143 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. Definition at line 134 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 105 of file itkVectorImage.h.

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

Definition at line 110 of file itkVectorImage.h.

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

Tyepdef for the functor used to access a neighborhood of pixel pointers. Definition at line 122 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. Definition at line 137 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) Definition at line 161 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. Definition at line 131 of file itkVectorImage.h.

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

Definition at line 158 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 157 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 94 of file itkVectorImage.h.

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

Definition at line 86 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). Definition at line 154 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. Definition at line 146 of file itkVectorImage.h.

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

Standard class typedefs Definition at line 84 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. Definition at line 140 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. Definition at line 150 of file itkVectorImage.h.

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

Definition at line 85 of file itkVectorImage.h.

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

Typedef alias for PixelType Definition at line 108 of file itkVectorImage.h.

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

Definition at line 163 of file itkVectorImage.h.

---

Constructor & Destructor Documentation

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

Definition at line 389 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().

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]

Definition at line 251 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> Return a pointer to the beginning of the buffer This is used by* the image iterator class* InternalPixelType* itk::VectorImage< TPixel, VImageDimension >::GetBufferPointer (   )  [inline]

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

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

Return the NeighborhoodAccessor functor Definition at line 292 of file itkVectorImage.h.

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

Return the NeighborhoodAccessor functor Definition at line 288 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> Get Set the number of components each pixel ie the VectorLength* virtual unsigned int itk::VectorImage< TPixel, VImageDimension >::GetNumberOfComponentsPerPixel (   )  const [virtual]

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 226 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 215 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 284 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 280 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 260 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 256 of file itkVectorImage.h.

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

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.

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.

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

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.

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

Method for creation through the object factory.

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

Access a pixel. This version can only be an rvalue. For efficiency, this function does not check that the image has actually been allocated yet. Definition at line 244 of file itkVectorImage.h.

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

Access a pixel. This version can be an lvalue. For efficiency, this function does not check that the image has actually been allocated yet. Definition at line 237 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> Get a physical itk::VectorImage< TPixel, VImageDimension >::point (  in the space which *the origin and spacing infomation comes  from  )  const

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

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

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 201 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 (  SizeType  size  )  [inline]

Definition at line 180 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> Convenience methods to set the * BufferedRegion and RequestedRegion Allocate must still be called* void itk::VectorImage< TPixel, VImageDimension >::SetRegions (  RegionType  region  )  [inline]

Definition at line 172 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> Set Get macros for the length of each vector in the vector image* virtual void itk::VectorImage< TPixel, VImageDimension >::SetVectorLength (  VectorLengthType  _arg  )  [virtual]

template<class TPixel, unsigned int VImageDimension = 3> template<class TCoordRep> bool itk::VectorImage< TPixel, VImageDimension >::TransformPhysicalPointToContinuousIndex (  const Point< TCoordRep, VImageDimension > &  point, ContinuousIndex< TCoordRep, VImageDimension > &  index )  const [inline]

Get the continuous index from a physical point. Returns true if the resulting index is within the image, false otherwise. See also: Transform Definition at line 311 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> template<class TCoordRep> bool itk::VectorImage< TPixel, VImageDimension >::TransformPhysicalPointToIndex (  const Point< TCoordRep, VImageDimension > &  point, IndexType &  index )  const [inline]

Get the index (discrete) from a physical point. Floating point index results are truncated to integers. Returns true if the resulting index is within the image, false otherwise See also: Transform Definition at line 333 of file itkVectorImage.h.

---

Member Data Documentation

template<class TPixel, unsigned int VImageDimension = 3> Get Set the number of components each pixel itk::VectorImage< TPixel, VImageDimension >::has

Definition at line 298 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> Get a physical VImageDimension& itk::VectorImage< TPixel, VImageDimension >::index

Definition at line 358 of file itkVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 3> Convenience methods to set the itk::VectorImage< TPixel, VImageDimension >::LargestPossibleRegion

Definition at line 169 of file itkVectorImage.h.

---

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

• itkVectorImage.h

---