vtkMultiCorrelativeStatistics Class Reference
#include <vtkMultiCorrelativeStatistics.h>
Detailed Description
A class for linear correlation.
Given a selection of sets of columns of interest, this class provides the following functionalities, depending on the execution mode it is executed in: Learn: calculates means, unbiased variance and covariance estimators of column pairs coefficient. More precisely, ExecuteLearn 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 1 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 1 and tabular data on input port 0 that contains column names matching those of the tables on input port 1, the assess mode computes the relative deviation of each observation in port 0's table according to the linear correlations implied by each table in port 1.
- Thanks:
- Thanks to Philippe Pebay, Jackson Mayo, and David Thompson of Sandia National Laboratories for implementing this class.
Definition at line 70 of file vtkMultiCorrelativeStatistics.h.
Public Types | |
| typedef vtkStatisticsAlgorithm | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkMultiCorrelativeStatistics * | SafeDownCast (vtkObject *o) |
| static vtkMultiCorrelativeStatistics * | New () |
Protected Member Functions | |
| vtkMultiCorrelativeStatistics () | |
| ~vtkMultiCorrelativeStatistics () | |
| virtual void | ExecuteDerive (vtkDataObject *) |
| virtual void | ExecuteAssess (vtkTable *, vtkDataObject *, vtkTable *, vtkDataObject *) |
| virtual int | FillInputPortInformation (int port, vtkInformation *info) |
| virtual int | FillOutputPortInformation (int port, vtkInformation *info) |
| virtual void | ExecuteLearn (vtkTable *inData, vtkDataObject *outMeta) |
| virtual void | SelectAssessFunctor (vtkTable *inData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc) |
Member Typedef Documentation
Reimplemented from vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics, vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.
Definition at line 73 of file vtkMultiCorrelativeStatistics.h.
Constructor & Destructor Documentation
| vtkMultiCorrelativeStatistics::vtkMultiCorrelativeStatistics | ( | ) | [protected] |
| vtkMultiCorrelativeStatistics::~vtkMultiCorrelativeStatistics | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkMultiCorrelativeStatistics::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics, vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.
| static int vtkMultiCorrelativeStatistics::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics, vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.
| virtual int vtkMultiCorrelativeStatistics::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics, vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.
| static vtkMultiCorrelativeStatistics* vtkMultiCorrelativeStatistics::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics, vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.
| virtual void vtkMultiCorrelativeStatistics::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
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 vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics, vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.
| static vtkMultiCorrelativeStatistics* vtkMultiCorrelativeStatistics::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkTableAlgorithm.
Reimplemented in vtkPCAStatistics, vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.
| virtual int vtkMultiCorrelativeStatistics::FillInputPortInformation | ( | int | port, | |
| vtkInformation * | info | |||
| ) | [protected, virtual] |
This algorithm accepts and returns a multiblock dataset containing several tables for its Learn input/output (port 1) instead of a single vtkTable. We override FillInputPortInformation/FillOutputPortInformation to indicate this.
Reimplemented from vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics.
| virtual int vtkMultiCorrelativeStatistics::FillOutputPortInformation | ( | int | port, | |
| vtkInformation * | info | |||
| ) | [protected, virtual] |
This algorithm accepts and returns a multiblock dataset containing several tables for its Learn input/output (port 1) instead of a single vtkTable. We override FillInputPortInformation/FillOutputPortInformation to indicate this.
Reimplemented from vtkStatisticsAlgorithm.
| virtual void vtkMultiCorrelativeStatistics::ExecuteDerive | ( | vtkDataObject * | ) | [protected, virtual] |
Execute the calculations required by the Derive option.
Implements vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics.
| virtual void vtkMultiCorrelativeStatistics::ExecuteAssess | ( | vtkTable * | , | |
| vtkDataObject * | , | |||
| vtkTable * | , | |||
| vtkDataObject * | ||||
| ) | [protected, virtual] |
Execute the calculations required by the Derive option.
Implements vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics.
| virtual void vtkMultiCorrelativeStatistics::ExecuteLearn | ( | vtkTable * | inData, | |
| vtkDataObject * | outMeta | |||
| ) | [protected, virtual] |
Execute the calculations required by the Learn option.
Implements vtkStatisticsAlgorithm.
Reimplemented in vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.
| virtual void vtkMultiCorrelativeStatistics::SelectAssessFunctor | ( | vtkTable * | inData, | |
| vtkDataObject * | inMeta, | |||
| vtkStringArray * | rowNames, | |||
| AssessFunctor *& | dfunc | |||
| ) | [protected, virtual] |
Execute the calculations required by the Learn option.
Implements vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics.
The documentation for this class was generated from the following file:
- dox/Infovis/vtkMultiCorrelativeStatistics.h
