itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage > Class Template Reference
[Operators]

Decomposes an image into directions along basis components. More...

#include <itkImagePCADecompositionCalculator.h>

Inheritance diagram for itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >:

[legend]Collaboration diagram for itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >:

[legend]List of all members.

Public Types
typedef ImagePCADecompositionCalculator	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef TBasisImage	BasisImageType
typedef TInputImage::Pointer	InputImagePointer
typedef TBasisImage::Pointer	BasisImagePointer
typedef TInputImage::ConstPointer	InputImageConstPointer
typedef TBasisImage::ConstPointer	BasisImageConstPointer
typedef TBasisImage::PixelType	BasisPixelType
typedef std::vector< BasisImagePointer >	BasisImagePointerVector
typedef vnl_matrix< BasisPixelType >	BasisMatrixType
typedef vnl_vector< BasisPixelType >	BasisVectorType
typedef ImagePCAShapeModelEstimator< TInputImage, TBasisImage >::Pointer	ModelPointerType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (BasisImageDimension, unsigned int, TBasisImage::ImageDimension)
void	SetBasisFromModel (ModelPointerType model)
void	Compute (void)
virtual BasisVectorType	GetProjection ()
virtual void	SetImage (const InputImageType *_arg)
virtual const InputImageType *	GetImage ()
virtual void	SetMeanImage (const BasisImageType *_arg)
virtual const BasisImageType *	GetMeanImage ()
void	SetBasisImages (const BasisImagePointerVector &)
BasisImagePointerVector	GetBasisImages ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ImagePCADecompositionCalculator ()
virtual	~ImagePCADecompositionCalculator ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	CalculateBasisMatrix (void)
void	CalculateRecenteredImageAsVector (void)

---

Detailed Description

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>>
class itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >

Decomposes an image into directions along basis components.

This calculator computes the projection of an image into a subspace specified by some basis set of images, and, optionally, a mean image (e.g a translation to a new origin). Typically, this basis/mean image will be the mean and principal components of an image data set, as calculated by an ImagePCAShapeModelEstimator. The output of the calculator is a vnl_vector containing the coefficients along each dimension of the provided basis set. To use this calculator, set the basis images with the SetBasisImage method, and optionally set the mean image with the SetMeanImage method. In the PCA case, the zeroth output of the ImagePCAShapeModelEstimator is the mean image and subsequent outputs are the basis images. SetBasisFromModel is a convenience method to set all of this information from a given ImagePCAShapeModelEstimator instance.

This class is templated over the input image type and the type of images used to describe the basis.

Warning:

This method assumes that the input image consists of scalar pixel types.

All images (input, basis, and mean) must be the same size.

Author:

Zachary Pincus

Definition at line 60 of file itkImagePCADecompositionCalculator.h.

---

Member Typedef Documentation

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef TBasisImage::ConstPointer itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisImageConstPointer

Definition at line 85 of file itkImagePCADecompositionCalculator.h. Referenced by itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::~ImagePCADecompositionCalculator().

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef TBasisImage::Pointer itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisImagePointer

Definition at line 81 of file itkImagePCADecompositionCalculator.h.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef std::vector< BasisImagePointer > itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisImagePointerVector

Vector of basis image pointers. Definition at line 100 of file itkImagePCADecompositionCalculator.h. Referenced by itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::~ImagePCADecompositionCalculator().

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef TBasisImage itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisImageType

Definition at line 77 of file itkImagePCADecompositionCalculator.h.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef vnl_matrix<BasisPixelType> itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisMatrixType

Type definitions for internal vectors and matrices Definition at line 103 of file itkImagePCADecompositionCalculator.h. Referenced by itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::~ImagePCADecompositionCalculator().

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef TBasisImage::PixelType itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisPixelType

Basis image pixel type: this is also the type of the optput vector Definition at line 88 of file itkImagePCADecompositionCalculator.h.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef vnl_vector<BasisPixelType> itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisVectorType

Definition at line 104 of file itkImagePCADecompositionCalculator.h. Referenced by itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::GetBasisImages(), and itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::~ImagePCADecompositionCalculator().

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef SmartPointer<const Self> itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::ConstPointer

Reimplemented from itk::Object. Definition at line 67 of file itkImagePCADecompositionCalculator.h.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef TInputImage::ConstPointer itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::InputImageConstPointer

Const Pointer type for the image. Definition at line 84 of file itkImagePCADecompositionCalculator.h. Referenced by itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::~ImagePCADecompositionCalculator().

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef TInputImage::Pointer itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::InputImagePointer

Pointer types for the image. Definition at line 80 of file itkImagePCADecompositionCalculator.h.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef TInputImage itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::InputImageType

Type definitions for the input images. Definition at line 76 of file itkImagePCADecompositionCalculator.h.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef ImagePCAShapeModelEstimator<TInputImage, TBasisImage>::Pointer itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::ModelPointerType

Type definition of a compatible ImagePCAShapeModelEstimator Definition at line 123 of file itkImagePCADecompositionCalculator.h. Referenced by itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::GetBasisImages().

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef SmartPointer<Self> itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::Pointer

Reimplemented from itk::Object. Definition at line 66 of file itkImagePCADecompositionCalculator.h. Referenced by itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::GetBasisImages().

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef ImagePCADecompositionCalculator itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 64 of file itkImagePCADecompositionCalculator.h. Referenced by itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::~ImagePCADecompositionCalculator().

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef Object itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::Superclass

Reimplemented from itk::Object. Definition at line 65 of file itkImagePCADecompositionCalculator.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::ImagePCADecompositionCalculator (   )  [protected]

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::~ImagePCADecompositionCalculator (   )  [inline, protected, virtual]

Definition at line 137 of file itkImagePCADecompositionCalculator.h. References itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisImageConstPointer, itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisImagePointerVector, itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisMatrixType, itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisVectorType, itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::InputImageConstPointer, and itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::Self.

---

Member Function Documentation

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::CalculateBasisMatrix (  void   )  [protected]

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::CalculateRecenteredImageAsVector (  void   )  [protected]

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::Compute (  void   )

Compute the PCA decomposition of the input image.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> BasisImagePointerVector itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::GetBasisImages (   )  [inline]

Set and get the basis images. Definition at line 118 of file itkImagePCADecompositionCalculator.h. References itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisVectorType, itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::ModelPointerType, and itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::Pointer.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual const InputImageType* itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::GetImage (   )  [virtual]

Set and get the input image.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual const BasisImageType* itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::GetMeanImage (   )  [virtual]

Set and get the mean image.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual const char* itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual BasisVectorType itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::GetProjection (   )  [virtual]

Return the projection of the image.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::itkStaticConstMacro (  BasisImageDimension  , unsigned  int, TBasisImage::ImageDimension  )

Basis Image dimension

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::itkStaticConstMacro (  InputImageDimension  , unsigned  int, TInputImage::ImageDimension  )

Input Image dimension

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> Pointer itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::Object.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::SetBasisFromModel (  ModelPointerType  model  )

Set the basis images from a ImagePCAShapeModelEstimator

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::SetBasisImages (  const BasisImagePointerVector &   )

Set and get the basis images.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::SetImage (  const InputImageType *  _arg  )  [virtual]

Set and get the input image.

template<class TInputImage, class TBasisImage = Image<double, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::SetMeanImage (  const BasisImageType *  _arg  )  [virtual]

Set and get the mean image.

---

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

• itkImagePCADecompositionCalculator.h

---