Statismo  0.10.1
 All Classes Namespaces Functions Typedefs
Public Types | Public Member Functions | List of all members
statismo::ModelInfo Class Reference

stores meta information about the model, such as e.g. the name (uri) of the datasets used to build the models, or specific parameters of the modelBuilders. More...

#include <ModelInfo.h>

Public Types

typedef std::vector< BuilderInfoBuilderInfoList
 

Public Member Functions

 ModelInfo ()
 create an new, empty model info object
 
 ModelInfo (const MatrixType &scores, const BuilderInfoList &builderInfos)
 
 ModelInfo (const MatrixType &scores)
 
virtual ~ModelInfo ()
 destructor
 
ModelInfooperator= (const ModelInfo &rhs)
 
 ModelInfo (const ModelInfo &orig)
 
BuilderInfoList GetBuilderInfoList () const
 
const MatrixType & GetScoresMatrix () const
 
virtual void Save (const H5::CommonFG &publicFg) const
 
virtual void Load (const H5::CommonFG &publicFg)
 

Detailed Description

stores meta information about the model, such as e.g. the name (uri) of the datasets used to build the models, or specific parameters of the modelBuilders.

The ModelInfo object stores the scores and a list of BuilderInfo objects. Each BuilderInfo contains the information (datasets, parameters) that were used to build the model. If n model builders had been used in succession to create a model, there will be a list of n builder objects.

Constructor & Destructor Documentation

statismo::ModelInfo::ModelInfo ( const MatrixType &  scores,
const BuilderInfoList &  builderInfos 
)

Creates a new ModelInfo object with the given information

Parameters
scoresA matrix holding the scores
builderInfosA list of BuilderInfo objects
statismo::ModelInfo::ModelInfo ( const MatrixType &  scores)

Create a ModelInfo object without specifying any BuilderInfos

Parameters
scoresA matrix holding the scores

Member Function Documentation

ModelInfo::BuilderInfoList statismo::ModelInfo::GetBuilderInfoList ( ) const

Returns a list with BuilderInfos

const MatrixType & statismo::ModelInfo::GetScoresMatrix ( ) const

Returns the scores matrix. That is, a matrix where the i-th column corresponds to the coefficients of the i-th dataset in the model

void statismo::ModelInfo::Load ( const H5::CommonFG &  publicFg)
virtual

Loads the model info from the given group in the HDF5 file.

void statismo::ModelInfo::Save ( const H5::CommonFG &  publicFg) const
virtual

Saves the model info to the given group in the HDF5 file


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