vtkCorrelativeStatistics Class Reference
#include <vtkCorrelativeStatistics.h>
Detailed Description
A class for linear correlation.
Given a selection of pairs of columns of interest, this class provides the following functionalities, depending on the execution mode it is executed in: Learn: calculate means, unbiased variance and covariance estimators of column pairs, and corresponding linear regressions and linear correlation coefficient. More precisely, ExecuteLearn calculates the sums; if finalize is set to true (default), the final statistics are calculated with the function CalculateFromSums. Otherwise, only raw sums are output; this option is made for efficient parallel calculations. Note that CalculateFromSums is a static function, so that it can be used directly with no need to instantiate a vtkCorrelativeStatistics object. Assess: given two data vectors X and Y with the same number of entries as input in port 0, and reference means, variances, and covariance, along with an acceptable threshold t>1, assess all pairs of values of (X,Y) whose relative PDF (assuming a bivariate Gaussian model) is below t.
- Thanks:
- Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
Definition at line 55 of file vtkCorrelativeStatistics.h.
Public Types | |
| typedef vtkBivariateStatisticsAlgorithm | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkCorrelativeStatistics * | SafeDownCast (vtkObject *o) |
| static vtkCorrelativeStatistics * | New () |
Protected Member Functions | |
| vtkCorrelativeStatistics () | |
| ~vtkCorrelativeStatistics () | |
| virtual void | ExecuteDerive (vtkDataObject *) |
| virtual void | ExecuteLearn (vtkTable *inData, vtkDataObject *outMeta) |
| virtual void | SelectAssessFunctor (vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc) |
Member Typedef Documentation
Reimplemented from vtkBivariateStatisticsAlgorithm.
Reimplemented in vtkPCorrelativeStatistics.
Definition at line 58 of file vtkCorrelativeStatistics.h.
Constructor & Destructor Documentation
| vtkCorrelativeStatistics::vtkCorrelativeStatistics | ( | ) | [protected] |
| vtkCorrelativeStatistics::~vtkCorrelativeStatistics | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkCorrelativeStatistics::GetClassName | ( | ) | [virtual] |
| static int vtkCorrelativeStatistics::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 vtkBivariateStatisticsAlgorithm.
Reimplemented in vtkPCorrelativeStatistics.
| virtual int vtkCorrelativeStatistics::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 vtkBivariateStatisticsAlgorithm.
Reimplemented in vtkPCorrelativeStatistics.
| static vtkCorrelativeStatistics* vtkCorrelativeStatistics::SafeDownCast | ( | vtkObject * | o | ) | [static] |
| void vtkCorrelativeStatistics::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 vtkBivariateStatisticsAlgorithm.
Reimplemented in vtkPCorrelativeStatistics.
| static vtkCorrelativeStatistics* vtkCorrelativeStatistics::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkTableAlgorithm.
Reimplemented in vtkPCorrelativeStatistics.
| virtual void vtkCorrelativeStatistics::ExecuteLearn | ( | vtkTable * | inData, | |
| vtkDataObject * | outMeta | |||
| ) | [protected, virtual] |
Execute the calculations required by the Learn option.
Implements vtkStatisticsAlgorithm.
Reimplemented in vtkPCorrelativeStatistics.
| virtual void vtkCorrelativeStatistics::ExecuteDerive | ( | vtkDataObject * | ) | [protected, virtual] |
Execute the calculations required by the Derive option.
Implements vtkStatisticsAlgorithm.
| virtual void vtkCorrelativeStatistics::SelectAssessFunctor | ( | vtkTable * | outData, | |
| vtkDataObject * | inMeta, | |||
| vtkStringArray * | rowNames, | |||
| AssessFunctor *& | dfunc | |||
| ) | [protected, virtual] |
Provide the appropriate assessment functor.
Implements vtkStatisticsAlgorithm.
The documentation for this class was generated from the following file:
- dox/Infovis/vtkCorrelativeStatistics.h
