A class for bivariate correlation contigency tables, conditional probabilities, and information entropy. More...
#include <vtkContingencyStatistics.h>
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)
Definition at line 61 of file vtkContingencyStatistics.h.
Member Typedef Documentation
Reimplemented from vtkStatisticsAlgorithm.
Reimplemented in vtkPContingencyStatistics, and vtkContingencyStatisticsGnuR.
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 * | 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 vtkPContingencyStatistics, and vtkContingencyStatisticsGnuR.
| virtual int vtkContingencyStatistics::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 vtkPContingencyStatistics, and vtkContingencyStatisticsGnuR.
| static vtkContingencyStatistics* vtkContingencyStatistics::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkStatisticsAlgorithm.
Reimplemented in vtkPContingencyStatistics, and vtkContingencyStatisticsGnuR.
| virtual vtkObjectBase* vtkContingencyStatistics::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkStatisticsAlgorithm.
Reimplemented in vtkPContingencyStatistics, and vtkContingencyStatisticsGnuR.
Reimplemented from vtkStatisticsAlgorithm.
Reimplemented in vtkPContingencyStatistics, and vtkContingencyStatisticsGnuR.
| void vtkContingencyStatistics::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 vtkPContingencyStatistics, and vtkContingencyStatisticsGnuR.
| static vtkContingencyStatistics* vtkContingencyStatistics::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkTableAlgorithm.
Reimplemented in vtkPContingencyStatistics, and vtkContingencyStatisticsGnuR.
| virtual void vtkContingencyStatistics::Aggregate | ( | vtkDataObjectCollection * | , |
| vtkMultiBlockDataSet * | |||
| ) | [inline, virtual] |
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 * | |||
| ) | [protected, virtual] |
Execute the calculations required by the Learn option.
Implements vtkStatisticsAlgorithm.
Reimplemented in vtkPContingencyStatistics.
| virtual void vtkContingencyStatistics::Derive | ( | vtkMultiBlockDataSet * | ) | [protected, virtual] |
Execute the calculations required by the Derive option.
Implements vtkStatisticsAlgorithm.
| virtual void vtkContingencyStatistics::Test | ( | vtkTable * | , |
| vtkMultiBlockDataSet * | , | ||
| vtkTable * | |||
| ) | [protected, virtual] |
Execute the calculations required by the Test option.
Implements vtkStatisticsAlgorithm.
| virtual void vtkContingencyStatistics::Assess | ( | vtkTable * | , |
| vtkMultiBlockDataSet * | , | ||
| vtkTable * | |||
| ) | [protected, virtual] |
Execute the calculations required by the Assess option.
Implements vtkStatisticsAlgorithm.
| virtual void vtkContingencyStatistics::CalculatePValues | ( | vtkTable * | ) | [protected, virtual] |
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 | ||
| ) | [protected, virtual] |
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 | ||
| ) | [protected, virtual] |
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:
- dox/Filters/Statistics/vtkContingencyStatistics.h
