Statismo  0.10.1
 All Classes Namespaces Functions Typedefs
Public Types | Public Member Functions | Static Public Member Functions | List of all members
statismo::PCAModelBuilder< T > Class Template Reference

Creates StatisticalModel using Principal Component Analysis. More...

#include <PCAModelBuilder.h>

Inheritance diagram for statismo::PCAModelBuilder< T >:
Inheritance graph

Public Types

typedef ModelBuilder< T > Superclass
 
typedef Superclass::DataManagerType DataManagerType
 
typedef
Superclass::StatisticalModelType 
StatisticalModelType
 
typedef
DataManagerType::DataItemListType 
DataItemListType
 
- Public Types inherited from statismo::ModelBuilder< T >
typedef Representer< T > RepresenterType
 
typedef StatisticalModel< T > StatisticalModelType
 
typedef DataManager< T > DataManagerType
 
typedef
DataManagerType::DataItemListType 
DataItemListType
 

Public Member Functions

void Delete ()
 
virtual ~PCAModelBuilder ()
 
StatisticalModelTypeBuildNewModel (const DataItemListType &samples, double noiseVariance, bool computeScores=true) const
 

Static Public Member Functions

static PCAModelBuilderCreate ()
 

Additional Inherited Members

- Static Public Attributes inherited from statismo::ModelBuilder< T >
static const double TOLERANCE = 1e-5
 
- Protected Member Functions inherited from statismo::ModelBuilder< T >
MatrixType ComputeScores (const MatrixType &X, const StatisticalModelType *model) const
 
ModelInfo CollectModelInfo () const
 

Detailed Description

template<typename T>
class statismo::PCAModelBuilder< T >

Creates StatisticalModel using Principal Component Analysis.

This class implements the classical PCA based approach to Statistical Models.

Constructor & Destructor Documentation

template<typename T >
virtual statismo::PCAModelBuilder< T >::~PCAModelBuilder ( )
inlinevirtual

The desctructor

Member Function Documentation

template<typename T >
PCAModelBuilder< T >::StatisticalModelType * statismo::PCAModelBuilder< T >::BuildNewModel ( const DataItemListType &  samples,
double  noiseVariance,
bool  computeScores = true 
) const

Build a new model from the training data provided in the dataManager.

Parameters
samplesA sampleSet holding the data
noiseVarianceThe variance of N(0, noiseVariance) distributed noise on the points. If this parameter is set to 0, we have a standard PCA model. For values > 0 we have a PPCA model.
computeScoresDetermines whether the scores (the pca coefficients of the examples) are computed and stored as model info (computing the scores may take a long time for large models).
Returns
A new Statistical model
Warning
The method allocates a new Statistical Model object, that needs to be deleted by the user.
template<typename T >
static PCAModelBuilder* statismo::PCAModelBuilder< T >::Create ( )
inlinestatic

Factory method to create a new PCAModelBuilder

template<typename T >
void statismo::PCAModelBuilder< T >::Delete ( )
inline

Destroy the object. The same effect can be achieved by deleting the object in the usual way using the c++ delete keyword.


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