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 | Protected Attributes | List of all members
vtkAutoCorrelativeStatistics Class Reference

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

#include <vtkAutoCorrelativeStatistics.h>

Inheritance diagram for vtkAutoCorrelativeStatistics:
[legend]
Collaboration diagram for vtkAutoCorrelativeStatistics:
[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)
 
vtkAutoCorrelativeStatisticsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetSliceCardinality (vtkIdType)
 
virtual vtkIdType GetSliceCardinality ()
 
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
vtkAutoCorrelativeStatistics
SafeDownCast (vtkObjectBase *o)
 
static
vtkAutoCorrelativeStatistics
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
 
 vtkAutoCorrelativeStatistics ()
 
 ~vtkAutoCorrelativeStatistics ()
 
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)
 

Protected Attributes

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

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

Definition at line 57 of file vtkAutoCorrelativeStatistics.h.

Constructor & Destructor Documentation

vtkAutoCorrelativeStatistics::vtkAutoCorrelativeStatistics ( )
protected
vtkAutoCorrelativeStatistics::~vtkAutoCorrelativeStatistics ( )
protected

Member Function Documentation

static int vtkAutoCorrelativeStatistics::IsTypeOf ( const char *  type)
static
virtual int vtkAutoCorrelativeStatistics::IsA ( const char *  type)
virtual

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPAutoCorrelativeStatistics.

static vtkAutoCorrelativeStatistics* vtkAutoCorrelativeStatistics::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkAutoCorrelativeStatistics::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPAutoCorrelativeStatistics.

vtkAutoCorrelativeStatistics* vtkAutoCorrelativeStatistics::NewInstance ( ) const
void vtkAutoCorrelativeStatistics::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkAutoCorrelativeStatistics* vtkAutoCorrelativeStatistics::New ( )
static
virtual void vtkAutoCorrelativeStatistics::SetSliceCardinality ( vtkIdType  )
virtual

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.

virtual vtkIdType vtkAutoCorrelativeStatistics::GetSliceCardinality ( )
virtual

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.

virtual void vtkAutoCorrelativeStatistics::Aggregate ( vtkDataObjectCollection *  ,
vtkMultiBlockDataSet *   
)
virtual

Given a collection of models, calculate aggregate model

Implements vtkStatisticsAlgorithm.

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

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 *  )
protectedvirtual

Execute the calculations required by the Derive option.

Implements vtkStatisticsAlgorithm.

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

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 
)
inlineprotectedvirtual

Execute the calculations required by the Assess option.

Implements vtkStatisticsAlgorithm.

Definition at line 101 of file vtkAutoCorrelativeStatistics.h.

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

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 
)
protectedvirtual

Provide the appropriate assessment functor.

Implements vtkStatisticsAlgorithm.

Member Data Documentation

vtkIdType vtkAutoCorrelativeStatistics::SliceCardinality
protected

Definition at line 121 of file vtkAutoCorrelativeStatistics.h.


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