VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkMultiCorrelativeStatistics Class Reference

A class for multivariate linear correlation. More...

#include <vtkMultiCorrelativeStatistics.h>

Inheritance diagram for vtkMultiCorrelativeStatistics:
[legend]
Collaboration diagram for vtkMultiCorrelativeStatistics:
[legend]

Public Types

typedef vtkStatisticsAlgorithm Superclass
 
- Public Types inherited from vtkStatisticsAlgorithm
typedef vtkTableAlgorithm Superclass
 
enum  InputPorts { INPUT_DATA = 0, LEARN_PARAMETERS = 1, INPUT_MODEL = 2 }
 
enum  OutputIndices { OUTPUT_DATA = 0, OUTPUT_MODEL = 1, ASSESSMENT = 2, OUTPUT_TEST = 2 }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkMultiCorrelativeStatisticsNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Aggregate (vtkDataObjectCollection *, vtkMultiBlockDataSet *)
 
- Public Member Functions inherited from vtkStatisticsAlgorithm
vtkStatisticsAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetColumnStatus (const char *namCol, int status)
 
virtual void ResetAllColumnStates ()
 
virtual int RequestSelectedColumns ()
 
virtual void ResetRequests ()
 
virtual vtkIdType GetNumberOfRequests ()
 
virtual vtkIdType GetNumberOfColumnsForRequest (vtkIdType request)
 
void AddColumn (const char *namCol)
 
void AddColumnPair (const char *namColX, const char *namColY)
 
virtual void SetLearnOptionParameterConnection (vtkAlgorithmOutput *params)
 
virtual void SetLearnOptionParameters (vtkDataObject *params)
 
virtual void SetInputModelConnection (vtkAlgorithmOutput *model)
 
virtual void SetInputModel (vtkDataObject *model)
 
virtual void SetLearnOption (bool)
 
virtual bool GetLearnOption ()
 
virtual void SetDeriveOption (bool)
 
virtual bool GetDeriveOption ()
 
virtual void SetAssessOption (bool)
 
virtual bool GetAssessOption ()
 
virtual void SetTestOption (bool)
 
virtual bool GetTestOption ()
 
virtual void SetNumberOfPrimaryTables (vtkIdType)
 
virtual vtkIdType GetNumberOfPrimaryTables ()
 
virtual void SetAssessNames (vtkStringArray *)
 
virtual vtkStringArray * GetAssessNames ()
 
virtual const char * GetColumnForRequest (vtkIdType r, vtkIdType c)
 
virtual int GetColumnForRequest (vtkIdType r, vtkIdType c, vtkStdString &columnName)
 
virtual bool SetParameter (const char *parameter, int index, vtkVariant value)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static
vtkMultiCorrelativeStatistics
SafeDownCast (vtkObjectBase *o)
 
static
vtkMultiCorrelativeStatistics
New ()
 
- Static Public Member Functions inherited from vtkStatisticsAlgorithm
static int IsTypeOf (const char *type)
 
static vtkStatisticsAlgorithmSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkMultiCorrelativeStatistics ()
 
 ~vtkMultiCorrelativeStatistics ()
 
virtual void Derive (vtkMultiBlockDataSet *)
 
virtual void Learn (vtkTable *, vtkTable *, vtkMultiBlockDataSet *)
 
virtual void Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)
 
virtual void Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)
 
virtual void SelectAssessFunctor (vtkTable *inData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)
 
- Protected Member Functions inherited from vtkStatisticsAlgorithm
 vtkStatisticsAlgorithm ()
 
 ~vtkStatisticsAlgorithm ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *, int)
 

Additional Inherited Members

- Protected Attributes inherited from vtkStatisticsAlgorithm
int NumberOfPrimaryTables
 
bool LearnOption
 
bool DeriveOption
 
bool AssessOption
 
bool TestOption
 
vtkStringArray * AssessNames
 
vtkStatisticsAlgorithmPrivateInternals
 

Detailed Description

A class for multivariate linear correlation.

Given a selection of sets of columns of interest, this class provides the following functionalities, depending on the operation in which it is executed: Learn: calculates means, unbiased variance and covariance estimators of column pairs coefficient. More precisely, Learn calculates the averages and centered variance/covariance sums; if finalize is set to true (default), the final statistics are calculated. The output metadata on port OUTPUT_MODEL is a multiblock dataset containing at a minimum one vtkTable holding the raw sums in a sparse matrix style. If finalize is true, then one additional vtkTable will be present for each requested set of column correlations. These additional tables contain column averages, the upper triangular portion of the covariance matrix (in the upper right hand portion of the table) and the Cholesky decomposition of the covariance matrix (in the lower portion of the table beneath the covariance triangle). The leftmost column will be a vector of column averages. The last entry in the column averages vector is the number of samples. As an example, consider a request for a 3-column correlation with columns named ColA, ColB, and ColC. The resulting table will look like this:

     Column  |Mean     |ColA     |ColB     |ColC
     --------+---------+---------+---------+---------
     ColA    |avg(A)   |cov(A,A) |cov(A,B) |cov(A,C)
     ColB    |avg(B)   |chol(1,1)|cov(B,B) |cov(B,C)
     ColC    |avg(C)   |chol(2,1)|chol(2,2)|cov(C,C)
     Cholesky|length(A)|chol(3,1)|chol(3,2)|chol(3,3)
  

Assess: given a set of results matrices as specified above in input port INPUT_MODEL and tabular data on input port INPUT_DATA that contains column names matching those of the tables on input port INPUT_MODEL, the assess mode computes the relative deviation of each observation in port INPUT_DATA's table according to the linear correlations implied by each table in port INPUT_MODEL.

Thanks:
Thanks to Philippe Pebay, Jackson Mayo, and David Thompson of Sandia National Laboratories for implementing this class. Updated by Philippe Pebay, Kitware SAS 2012
Tests:
vtkMultiCorrelativeStatistics (Tests)

Definition at line 75 of file vtkMultiCorrelativeStatistics.h.

Member Typedef Documentation

Definition at line 78 of file vtkMultiCorrelativeStatistics.h.

Constructor & Destructor Documentation

vtkMultiCorrelativeStatistics::vtkMultiCorrelativeStatistics ( )
protected
vtkMultiCorrelativeStatistics::~vtkMultiCorrelativeStatistics ( )
protected

Member Function Documentation

static int vtkMultiCorrelativeStatistics::IsTypeOf ( const char *  type)
static
virtual int vtkMultiCorrelativeStatistics::IsA ( const char *  type)
virtual
static vtkMultiCorrelativeStatistics* vtkMultiCorrelativeStatistics::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkMultiCorrelativeStatistics::NewInstanceInternal ( ) const
protectedvirtual
vtkMultiCorrelativeStatistics* vtkMultiCorrelativeStatistics::NewInstance ( ) const
virtual void vtkMultiCorrelativeStatistics::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual
static vtkMultiCorrelativeStatistics* vtkMultiCorrelativeStatistics::New ( )
static
virtual void vtkMultiCorrelativeStatistics::Aggregate ( vtkDataObjectCollection *  ,
vtkMultiBlockDataSet *   
)
virtual

Given a collection of models, calculate aggregate model

Implements vtkStatisticsAlgorithm.

virtual void vtkMultiCorrelativeStatistics::Learn ( vtkTable *  ,
vtkTable *  ,
vtkMultiBlockDataSet *   
)
protectedvirtual

Execute the calculations required by the Learn option.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.

virtual void vtkMultiCorrelativeStatistics::Derive ( vtkMultiBlockDataSet *  )
protectedvirtual

Execute the calculations required by the Derive option.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPCAStatistics.

virtual void vtkMultiCorrelativeStatistics::Assess ( vtkTable *  ,
vtkMultiBlockDataSet *  ,
vtkTable *   
)
protectedvirtual

Execute the calculations required by the Assess option.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPCAStatistics.

virtual void vtkMultiCorrelativeStatistics::Test ( vtkTable *  ,
vtkMultiBlockDataSet *  ,
vtkTable *   
)
inlineprotectedvirtual

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPCAStatistics, and vtkPPCAStatistics.

Definition at line 111 of file vtkMultiCorrelativeStatistics.h.

virtual void vtkMultiCorrelativeStatistics::SelectAssessFunctor ( vtkTable *  inData,
vtkDataObject *  inMeta,
vtkStringArray *  rowNames,
AssessFunctor *&  dfunc 
)
protectedvirtual

Provide the appropriate assessment functor.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPCAStatistics.


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