#include <itkImagePCADecompositionCalculator.h>

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

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

Detailed Description

template<typename TInputImage, typename TBasisImage = Image< double, 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.

Public Types
typedef TBasisImage::ConstPointer	BasisImageConstPointer

typedef TBasisImage::Pointer	BasisImagePointer

typedef std::vector < BasisImagePointer >	BasisImagePointerVector

typedef TBasisImage	BasisImageType

typedef vnl_matrix < BasisPixelType >	BasisMatrixType

typedef TBasisImage::PixelType	BasisPixelType

typedef vnl_vector < BasisPixelType >	BasisVectorType

typedef SmartPointer< const Self >	ConstPointer

typedef TInputImage::ConstPointer	InputImageConstPointer

typedef TInputImage::Pointer	InputImagePointer

typedef TInputImage	InputImageType

typedef ImagePCAShapeModelEstimator < TInputImage, TBasisImage > ::Pointer	ModelPointerType

typedef SmartPointer< Self >	Pointer

typedef ImagePCADecompositionCalculator	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
void	Compute ()

virtual ::itk::LightObject::Pointer	CreateAnother () const

BasisImagePointerVector	GetBasisImages ()

virtual const char *	GetNameOfClass () const

virtual BasisVectorType	GetProjection () const

void	SetBasisFromModel (ModelPointerType model)

void	SetBasisImages (const BasisImagePointerVector &)


virtual void	SetImage (const InputImageType *_arg)

virtual const InputImageType *	GetImage () const


virtual void	SetMeanImage (const BasisImageType *_arg)

virtual const BasisImageType *	GetMeanImage () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static const unsigned int	BasisImageDimension = TBasisImage::ImageDimension

static const unsigned int	InputImageDimension = TInputImage::ImageDimension

Protected Member Functions
void	CalculateBasisMatrix ()

void	CalculateRecenteredImageAsVector ()

	ImagePCADecompositionCalculator ()

virtual void	PrintSelf (std::ostream &os, Indent indent) const override

virtual	~ImagePCADecompositionCalculator ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Types
typedef BasisImageType::SizeType	BasisSizeType

Private Member Functions
	ImagePCADecompositionCalculator (const Self &)

void	operator= (const Self &)

Private Attributes
BasisImagePointerVector	m_BasisImages

BasisMatrixType	m_BasisMatrix

bool	m_BasisMatrixCalculated

InputImageConstPointer	m_Image

BasisVectorType	m_ImageAsVector

BasisImageConstPointer	m_MeanImage

SizeValueType	m_NumPixels

BasisVectorType	m_Projection

BasisSizeType	m_Size

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount