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
vtkCorrelativeStatistics Class Reference

A class for bivariate linear correlation. More...

#include <vtkCorrelativeStatistics.h>

Inheritance diagram for vtkCorrelativeStatistics:
[legend]
Collaboration diagram for vtkCorrelativeStatistics:
[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)
 
vtkCorrelativeStatisticsNewInstance () const
 
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 vtkCorrelativeStatisticsSafeDownCast (vtkObjectBase *o)
 
static vtkCorrelativeStatisticsNew ()
 
- Static Public Member Functions inherited from vtkStatisticsAlgorithm
static int IsTypeOf (const char *type)
 
static vtkStatisticsAlgorithmSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkCorrelativeStatistics ()
 
 ~vtkCorrelativeStatistics ()
 
virtual void Derive (vtkMultiBlockDataSet *)
 
virtual vtkDoubleArray * CalculatePValues (vtkDoubleArray *)
 
virtual void Learn (vtkTable *, vtkTable *, vtkMultiBlockDataSet *)
 
virtual void Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)
 
virtual void Assess (vtkTable *inData, vtkMultiBlockDataSet *inMeta, vtkTable *outData)
 
virtual void SelectAssessFunctor (vtkTable *outData, 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 bivariate linear correlation.

Given a selection of pairs of columns of interest, this class provides the following functionalities, depending on the chosen execution options: Learn: calculate sample mean and M2 aggregates for each pair of variables (cf. P. Pebay, Formulas for robust, one-pass parallel computation of covariances and Arbitrary-Order Statistical Moments, Sandia Report SAND2008-6212, Sep 2008, http://infoserve.sandia.gov/sand_doc/2008/086212.pdf for details) Derive: calculate unbiased covariance matrix estimators and its determinant, linear regressions, and Pearson correlation coefficient. Assess: given an input data set, two means and a 2x2 covariance matrix, mark each datum with corresponding relative deviation (2-dimensional Mahlanobis distance). Test: Perform Jarque-Bera-Srivastava test of 2-d normality

Thanks:
Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class. Updated by Philippe Pebay, Kitware SAS 2012
Examples:
vtkCorrelativeStatistics (Examples)
Tests:
vtkCorrelativeStatistics (Tests)

Definition at line 61 of file vtkCorrelativeStatistics.h.

Member Typedef Documentation

Definition at line 64 of file vtkCorrelativeStatistics.h.

Constructor & Destructor Documentation

vtkCorrelativeStatistics::vtkCorrelativeStatistics ( )
protected
vtkCorrelativeStatistics::~vtkCorrelativeStatistics ( )
protected

Member Function Documentation

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

Given a collection of models, calculate aggregate model

Implements vtkStatisticsAlgorithm.

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

Execute the calculations required by the Learn option.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPCorrelativeStatistics.

virtual void vtkCorrelativeStatistics::Derive ( vtkMultiBlockDataSet *  )
protectedvirtual

Execute the calculations required by the Derive option.

Implements vtkStatisticsAlgorithm.

virtual void vtkCorrelativeStatistics::Test ( vtkTable *  ,
vtkMultiBlockDataSet *  ,
vtkTable *   
)
protectedvirtual

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPCorrelativeStatistics.

virtual void vtkCorrelativeStatistics::Assess ( vtkTable *  inData,
vtkMultiBlockDataSet *  inMeta,
vtkTable *  outData 
)
inlineprotectedvirtual

Execute the calculations required by the Assess option.

Implements vtkStatisticsAlgorithm.

Definition at line 97 of file vtkCorrelativeStatistics.h.

virtual vtkDoubleArray* vtkCorrelativeStatistics::CalculatePValues ( vtkDoubleArray *  )
protectedvirtual

Calculate p-value. This will be overridden using the object factory with an R implementation if R is present.

Reimplemented in vtkCorrelativeStatisticsGnuR.

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

Provide the appropriate assessment functor.

Implements vtkStatisticsAlgorithm.


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