VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkCorrelativeStatistics Class Reference

A class for linear correlation. More...

#include <vtkCorrelativeStatistics.h>

Inheritance diagram for vtkCorrelativeStatistics:
[legend]
Collaboration diagram for vtkCorrelativeStatistics:
[legend]

Public Types

typedef
vtkBivariateStatisticsAlgorithm 
Superclass
 
- Public Types inherited from vtkBivariateStatisticsAlgorithm
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 Types inherited from vtkTableAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Aggregate (vtkDataObjectCollection *, vtkMultiBlockDataSet *)
 
- Public Member Functions inherited from vtkBivariateStatisticsAlgorithm
void AddColumnPair (const char *namColX, const char *namColY)
 
virtual int RequestSelectedColumns ()
 
- Public Member Functions inherited from vtkStatisticsAlgorithm
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetAssessOptionParameter (vtkIdType id, vtkStdString name)
 
vtkStdString GetAssessParameter (vtkIdType id)
 
virtual void SetColumnStatus (const char *namCol, int status)
 
virtual void ResetAllColumnStates ()
 
virtual void ResetRequests ()
 
virtual vtkIdType GetNumberOfRequests ()
 
virtual vtkIdType GetNumberOfColumnsForRequest (vtkIdType request)
 
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 SetAssessParameters (vtkStringArray *)
 
virtual vtkStringArrayGetAssessParameters ()
 
virtual void SetAssessNames (vtkStringArray *)
 
virtual vtkStringArrayGetAssessNames ()
 
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)
 
- Public Member Functions inherited from vtkTableAlgorithm
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkTableGetOutput ()
 
vtkTableGetOutput (int index)
 
void SetInput (vtkDataObject *obj)
 
void SetInput (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
virtual void Update ()
 
virtual void UpdateInformation ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkCorrelativeStatisticsSafeDownCast (vtkObject *o)
 
static vtkCorrelativeStatisticsNew ()
 
- Static Public Member Functions inherited from vtkBivariateStatisticsAlgorithm
static int IsTypeOf (const char *type)
 
static
vtkBivariateStatisticsAlgorithm
SafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkStatisticsAlgorithm
static int IsTypeOf (const char *type)
 
static vtkStatisticsAlgorithmSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkTableAlgorithm
static vtkTableAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTableAlgorithmSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObject *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyPRESERVES_DATASET ()
 
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
 
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKeyPRESERVES_RANGES ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkCorrelativeStatistics ()
 
 ~vtkCorrelativeStatistics ()
 
virtual void Derive (vtkMultiBlockDataSet *)
 
virtual void Learn (vtkTable *inData, vtkTable *inParameters, vtkMultiBlockDataSet *outMeta)
 
virtual void Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)
 
virtual void SelectAssessFunctor (vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)
 
- Protected Member Functions inherited from vtkBivariateStatisticsAlgorithm
 vtkBivariateStatisticsAlgorithm ()
 
 ~vtkBivariateStatisticsAlgorithm ()
 
virtual void Assess (vtkTable *inData, vtkMultiBlockDataSet *inMeta, vtkTable *outData)
 
- 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 *)
 
- Protected Member Functions inherited from vtkTableAlgorithm
 vtkTableAlgorithm ()
 
 ~vtkTableAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
virtual void SetErrorCode (unsigned long)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Protected Attributes inherited from vtkStatisticsAlgorithm
int NumberOfPrimaryTables
 
bool LearnOption
 
bool DeriveOption
 
bool AssessOption
 
bool TestOption
 
vtkStringArrayAssessParameters
 
vtkStringArrayAssessNames
 
vtkStatisticsAlgorithmPrivateInternals
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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 chosen execution options: Learn: calculate extremal values, sample mean, and M2 aggregates (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 variance and covariance estimators, estimator of standard deviations, 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: no statistical tests available yet.

Thanks:
Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
Examples:
vtkCorrelativeStatistics (Examples)
Tests:
vtkCorrelativeStatistics (Tests)

Definition at line 58 of file vtkCorrelativeStatistics.h.

Member Typedef Documentation

Definition at line 61 of file vtkCorrelativeStatistics.h.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual const char* vtkCorrelativeStatistics::GetClassName ( )
virtual

Reimplemented from vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPCorrelativeStatistics.

static int vtkCorrelativeStatistics::IsTypeOf ( const char *  type)
static
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 vtkTypeMacro 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
virtual void vtkCorrelativeStatistics::Aggregate ( vtkDataObjectCollection ,
vtkMultiBlockDataSet  
)
virtual

Given a collection of models, calculate aggregate model

Implements vtkStatisticsAlgorithm.

virtual void vtkCorrelativeStatistics::Learn ( vtkTable inData,
vtkTable inParameters,
vtkMultiBlockDataSet outMeta 
)
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.

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: