VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkAutoCorrelativeStatistics Class Reference

A class for univariate auto-correlative statistics. More...

#include <vtkAutoCorrelativeStatistics.h>

Inheritance diagram for vtkAutoCorrelativeStatistics:
Inheritance graph
[legend]
Collaboration diagram for vtkAutoCorrelativeStatistics:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkStatisticsAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkAutoCorrelativeStatisticsNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetSliceCardinality (vtkIdType)
virtual vtkIdType GetSliceCardinality ()
virtual void Aggregate (vtkDataObjectCollection *, vtkMultiBlockDataSet *)

Static Public Member Functions

static int IsTypeOf (const char *type)
static
vtkAutoCorrelativeStatistics
SafeDownCast (vtkObjectBase *o)
static
vtkAutoCorrelativeStatistics
New ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkAutoCorrelativeStatistics ()
 ~vtkAutoCorrelativeStatistics ()
virtual void Derive (vtkMultiBlockDataSet *)
virtual vtkDoubleArrayCalculatePValues (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 Attributes

vtkIdType SliceCardinality

Detailed Description

A class for univariate auto-correlative statistics.

Given a selection of columns of interest in an input data table, this class provides the following functionalities, depending on the chosen execution options: Learn: calculate sample mean and M2 aggregates for each variable w.r.t. itself (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) for each specified time lag. Derive: calculate unbiased autocovariance matrix estimators and its determinant, linear regressions, and Pearson correlation coefficient, for each specified time lag. Assess: given an input data set, two means and a 2x2 covariance matrix, mark each datum with corresponding relative deviation (2-dimensional Mahlanobis distance).

Thanks:
This class was written by Philippe Pebay, Kitware SAS 2012
Tests:
vtkAutoCorrelativeStatistics (Tests)

Definition at line 54 of file vtkAutoCorrelativeStatistics.h.


Member Typedef Documentation

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPAutoCorrelativeStatistics.

Definition at line 57 of file vtkAutoCorrelativeStatistics.h.


Constructor & Destructor Documentation


Member Function Documentation

static int vtkAutoCorrelativeStatistics::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPAutoCorrelativeStatistics.

virtual int vtkAutoCorrelativeStatistics::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPAutoCorrelativeStatistics.

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPAutoCorrelativeStatistics.

virtual vtkObjectBase* vtkAutoCorrelativeStatistics::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPAutoCorrelativeStatistics.

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPAutoCorrelativeStatistics.

void vtkAutoCorrelativeStatistics::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 vtkPAutoCorrelativeStatistics.

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPAutoCorrelativeStatistics.

Set/get the cardinality of the data set at given time, i.e., of any given time slice. It cannot be negative. The input data set is assumed to have a cardinality which is a multiple of this value. The default is 0, meaning that the user must specify a value that is consistent with the input data set.

Set/get the cardinality of the data set at given time, i.e., of any given time slice. It cannot be negative. The input data set is assumed to have a cardinality which is a multiple of this value. The default is 0, meaning that the user must specify a value that is consistent with the input data set.

Given a collection of models, calculate aggregate model

Implements vtkStatisticsAlgorithm.

virtual void vtkAutoCorrelativeStatistics::Learn ( vtkTable ,
vtkTable ,
vtkMultiBlockDataSet  
) [protected, virtual]

Execute the calculations required by the Learn option, given some input Data NB: input parameters are unused.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPAutoCorrelativeStatistics.

virtual void vtkAutoCorrelativeStatistics::Derive ( vtkMultiBlockDataSet ) [protected, virtual]

Execute the calculations required by the Derive option.

Implements vtkStatisticsAlgorithm.

virtual void vtkAutoCorrelativeStatistics::Test ( vtkTable ,
vtkMultiBlockDataSet ,
vtkTable  
) [inline, protected, virtual]

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPAutoCorrelativeStatistics.

Definition at line 94 of file vtkAutoCorrelativeStatistics.h.

virtual void vtkAutoCorrelativeStatistics::Assess ( vtkTable inData,
vtkMultiBlockDataSet inMeta,
vtkTable outData 
) [inline, protected, virtual]

Execute the calculations required by the Assess option.

Implements vtkStatisticsAlgorithm.

Definition at line 101 of file vtkAutoCorrelativeStatistics.h.

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

virtual void vtkAutoCorrelativeStatistics::SelectAssessFunctor ( vtkTable outData,
vtkDataObject inMeta,
vtkStringArray rowNames,
AssessFunctor *&  dfunc 
) [protected, virtual]

Provide the appropriate assessment functor.

Implements vtkStatisticsAlgorithm.


Member Data Documentation

Definition at line 121 of file vtkAutoCorrelativeStatistics.h.


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