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

A class for bivariate correlation contigency tables, conditional probabilities, and information entropy. More...

#include <vtkContingencyStatistics.h>

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

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkContingencyStatistics ()
 
 ~vtkContingencyStatistics ()
 
virtual void Derive (vtkMultiBlockDataSet *)
 
virtual void CalculatePValues (vtkTable *)
 
virtual void Learn (vtkTable *, vtkTable *, vtkMultiBlockDataSet *)
 
virtual void Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)
 
virtual void Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)
 
virtual void SelectAssessFunctor (vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)
 
virtual void SelectAssessFunctor (vtkTable *outData, vtkMultiBlockDataSet *inMeta, vtkIdType pairKey, 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 correlation contigency tables, conditional probabilities, and information entropy.

Given a pair of columns of interest, this class provides the following functionalities, depending on the operation in which it is executed: Learn: calculate contigency tables and corresponding discrete joint probability distribution. Derive: calculate conditional probabilities, information entropies, and pointwise mutual information. Assess: given two columns of interest with the same number of entries as input in port INPUT_DATA, and a corresponding bivariate probability distribution, Test: calculate Chi-square independence statistic and, if VTK to R interface is available, retrieve corresponding p-value for independence testing.

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

Definition at line 61 of file vtkContingencyStatistics.h.

Member Typedef Documentation

Definition at line 64 of file vtkContingencyStatistics.h.

Constructor & Destructor Documentation

vtkContingencyStatistics::vtkContingencyStatistics ( )
protected
vtkContingencyStatistics::~vtkContingencyStatistics ( )
protected

Member Function Documentation

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

Given a collection of models, calculate aggregate model NB: not implemented

Implements vtkStatisticsAlgorithm.

Definition at line 71 of file vtkContingencyStatistics.h.

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

Execute the calculations required by the Learn option.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPContingencyStatistics.

virtual void vtkContingencyStatistics::Derive ( vtkMultiBlockDataSet *  )
protectedvirtual

Execute the calculations required by the Derive option.

Implements vtkStatisticsAlgorithm.

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

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

virtual void vtkContingencyStatistics::Assess ( vtkTable *  ,
vtkMultiBlockDataSet *  ,
vtkTable *   
)
protectedvirtual

Execute the calculations required by the Assess option.

Implements vtkStatisticsAlgorithm.

virtual void vtkContingencyStatistics::CalculatePValues ( vtkTable *  )
protectedvirtual

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

Reimplemented in vtkContingencyStatisticsGnuR.

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

Provide the appropriate assessment functor. This one does nothing because the API is not sufficient for tables indexed by a separate summary table.

Implements vtkStatisticsAlgorithm.

virtual void vtkContingencyStatistics::SelectAssessFunctor ( vtkTable *  outData,
vtkMultiBlockDataSet *  inMeta,
vtkIdType  pairKey,
vtkStringArray *  rowNames,
AssessFunctor *&  dfunc 
)
protectedvirtual

Provide the appropriate assessment functor. This one is the one that is actually used.


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