#include <itkImagePCADecompositionCalculator.h>

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 59 of file itkImagePCADecompositionCalculator.h.

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

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

Public Types
using	BasisImageConstPointer = typename TBasisImage::ConstPointer

using	BasisImagePointer = typename TBasisImage::Pointer

using	BasisImagePointerVector = std::vector< BasisImagePointer >

using	BasisImageType = TBasisImage

using	BasisMatrixType = vnl_matrix< BasisPixelType >

using	BasisPixelType = typename TBasisImage::PixelType

using	BasisVectorType = vnl_vector< BasisPixelType >

using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename TInputImage::ConstPointer

using	InputImagePointer = typename TInputImage::Pointer

using	InputImageType = TInputImage

using	ModelPointerType = typename ImagePCAShapeModelEstimator< TInputImage, TBasisImage >::Pointer

using	Pointer = SmartPointer< Self >

using	Self = ImagePCADecompositionCalculator

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
void	Compute ()

BasisImagePointerVector	GetBasisImages ()

const char *	GetNameOfClass () const override

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 *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

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

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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 val)

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

static Pointer	New ()

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

static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

Protected Member Functions
void	CalculateBasisMatrix ()

void	CalculateRecenteredImageAsVector ()

	ImagePCADecompositionCalculator ()

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

	~ImagePCADecompositionCalculator () override=default

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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

	LightObject ()

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

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

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

virtual	~LightObject ()

Private Types
using	BasisSizeType = typename BasisImageType::SizeType

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
std::atomic< int >	m_ReferenceCount {}