ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Types | Private Attributes | List of all members
itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage > Class Template Reference

#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

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 ()
 
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 InputImageTypeGetImage () const
 
virtual void SetMeanImage (const BasisImageType *_arg)
 
virtual const BasisImageTypeGetMeanImage () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexceptoverride
 
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
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 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
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~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 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
 

Member Typedef Documentation

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisImageConstPointer = typename TBasisImage::ConstPointer

Definition at line 87 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisImagePointer = typename TBasisImage::Pointer

Definition at line 83 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisImagePointerVector = std::vector< BasisImagePointer >

Vector of basis image pointers.

Definition at line 99 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisImageType = TBasisImage

Definition at line 79 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisMatrixType = vnl_matrix< BasisPixelType >

Type definitions for internal vectors and matrices

Definition at line 102 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisPixelType = typename TBasisImage::PixelType

Basis image pixel type: this is also the type of the optput vector

Definition at line 90 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisSizeType = typename BasisImageType::SizeType
private

Definition at line 143 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisVectorType = vnl_vector< BasisPixelType >

Definition at line 103 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::ConstPointer = SmartPointer< const Self >

Definition at line 69 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::InputImageConstPointer = typename TInputImage::ConstPointer

Const Pointer type for the image.

Definition at line 86 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::InputImagePointer = typename TInputImage::Pointer

Pointer types for the image.

Definition at line 82 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::InputImageType = TInputImage

Type definitions for the input images.

Definition at line 78 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::ModelPointerType = typename ImagePCAShapeModelEstimator< TInputImage, TBasisImage >::Pointer

Type definition of a compatible ImagePCAShapeModelEstimator

Definition at line 122 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::Pointer = SmartPointer< Self >

Definition at line 68 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::Self = ImagePCADecompositionCalculator

Standard class type aliases.

Definition at line 66 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
using itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::Superclass = Object

Definition at line 67 of file itkImagePCADecompositionCalculator.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::ImagePCADecompositionCalculator ( )
protected
template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::~ImagePCADecompositionCalculator ( )
overrideprotecteddefault

Member Function Documentation

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::CalculateBasisMatrix ( )
protected
template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::CalculateRecenteredImageAsVector ( )
protected
template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::Compute ( )

Compute the PCA decomposition of the input image.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
virtual::itk::LightObject::Pointer itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::CreateAnother ( ) 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::Object.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
BasisImagePointerVector itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::GetBasisImages ( )
inline

Definition at line 118 of file itkImagePCADecompositionCalculator.h.

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

Set and get the input image.

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

Set and get the mean image.

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
virtual BasisVectorType itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::GetProjection ( ) const
virtual

Return the projection of the image.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
static Pointer itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::SetBasisFromModel ( ModelPointerType  model)

Set the basis images from a ImagePCAShapeModelEstimator

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

Set and get the basis images.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
virtual void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::SetImage ( const InputImageType _arg)
virtual

Set and get the input image.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
virtual void itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::SetMeanImage ( const BasisImageType _arg)
virtual

Set and get the mean image.

Member Data Documentation

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
constexpr unsigned int itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::BasisImageDimension = TBasisImage::ImageDimension
static

Basis Image dimension

Definition at line 96 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
constexpr unsigned int itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::InputImageDimension = TInputImage::ImageDimension
static

Input Image dimension

Definition at line 93 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
BasisImagePointerVector itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::m_BasisImages
private

Definition at line 147 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
BasisMatrixType itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::m_BasisMatrix
private

Definition at line 151 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
bool itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::m_BasisMatrixCalculated
private

Definition at line 152 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
InputImageConstPointer itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::m_Image
private

Definition at line 150 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
BasisVectorType itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::m_ImageAsVector
private

Definition at line 146 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
BasisImageConstPointer itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::m_MeanImage
private

Definition at line 148 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
SizeValueType itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::m_NumPixels
private

Definition at line 153 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
BasisVectorType itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::m_Projection
private

Definition at line 145 of file itkImagePCADecompositionCalculator.h.

template<typename TInputImage , typename TBasisImage = Image< double, TInputImage::ImageDimension >>
BasisSizeType itk::ImagePCADecompositionCalculator< TInputImage, TBasisImage >::m_Size
private

Definition at line 149 of file itkImagePCADecompositionCalculator.h.


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