vtkContingencyStatistics Class Reference

#include <vtkContingencyStatistics.h>

Inheritance diagram for vtkContingencyStatistics:

[legend]

Collaboration diagram for vtkContingencyStatistics:

[legend]

List of all members.

---

Detailed Description

A class for correlation with contigency tables.

Given a pair of columns of interest, this class provides the following functionalities, depending on the execution mode it is executed in: Learn: calculate contigency tables and corresponding discrete bivariate probability distribution. Assess: given two columns of interest with the same number of entries as input in port INPUT_DATA, and a corresponding bivariate probability distribution,

Thanks:

Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.

Examples:

vtkContingencyStatistics (Examples)

Tests:

vtkContingencyStatistics (Tests)

Definition at line 53 of file vtkContingencyStatistics.h.

Public Types
typedef vtkBivariateStatisticsAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Aggregate (vtkDataObjectCollection *, vtkDataObject *)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkContingencyStatistics *	SafeDownCast (vtkObject *o)
static vtkContingencyStatistics *	New ()
Protected Member Functions
	vtkContingencyStatistics ()
	~vtkContingencyStatistics ()
virtual void	Derive (vtkDataObject *)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual void	Learn (vtkTable *inData, vtkTable *inParameters, vtkDataObject *outMeta)
virtual void	Assess (vtkTable *inData, vtkDataObject *inMeta, vtkTable *outData)
virtual void	Test (vtkTable *inData, vtkDataObject *inMeta, vtkDataObject *outMeta)
virtual void	SelectAssessFunctor (vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)
virtual void	SelectAssessFunctor (vtkTable *outData, vtkMultiBlockDataSet *inMeta, vtkIdType pairKey, vtkStringArray *rowNames, AssessFunctor *&dfunc)

---

Member Typedef Documentation

typedef vtkBivariateStatisticsAlgorithm vtkContingencyStatistics::Superclass

Reimplemented from vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPContingencyStatistics.

Definition at line 56 of file vtkContingencyStatistics.h.

---

Constructor & Destructor Documentation

vtkContingencyStatistics::vtkContingencyStatistics

(

)

[protected]

vtkContingencyStatistics::~vtkContingencyStatistics

(

)

[protected]

---

Member Function Documentation

virtual const char* vtkContingencyStatistics::GetClassName

(

)

[virtual]

Reimplemented from vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPContingencyStatistics.

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 vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPContingencyStatistics.

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 vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPContingencyStatistics.

static vtkContingencyStatistics* vtkContingencyStatistics::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPContingencyStatistics.

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 vtkBivariateStatisticsAlgorithm.

Reimplemented in vtkPContingencyStatistics.

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.

virtual void vtkContingencyStatistics::Aggregate	(	vtkDataObjectCollection *	,
		vtkDataObject *
	)			[inline, virtual]

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

Implements vtkStatisticsAlgorithm.

Definition at line 63 of file vtkContingencyStatistics.h.

virtual int vtkContingencyStatistics::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)			[protected, virtual]

This algorithm accepts and returns a multiblock dataset containing several tables for its meta input/output instead of a single vtkTable. FillInputPortInformation/FillOutputPortInformation are overridden accordingly.

Reimplemented from vtkStatisticsAlgorithm.

virtual int vtkContingencyStatistics::FillOutputPortInformation	(	int	port,
		vtkInformation *	info
	)			[protected, virtual]

This algorithm accepts and returns a multiblock dataset containing several tables for its meta input/output instead of a single vtkTable. FillInputPortInformation/FillOutputPortInformation are overridden accordingly.

Reimplemented from vtkStatisticsAlgorithm.

virtual void vtkContingencyStatistics::Learn	(	vtkTable *	inData,
		vtkTable *	inParameters,
		vtkDataObject *	outMeta
	)			[protected, virtual]

Execute the calculations required by the Learn option.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPContingencyStatistics.

virtual void vtkContingencyStatistics::Derive

(

vtkDataObject *

)

[protected, virtual]

Execute the calculations required by the Derive option.

Implements vtkStatisticsAlgorithm.

virtual void vtkContingencyStatistics::Assess	(	vtkTable *	inData,
		vtkDataObject *	inMeta,
		vtkTable *	outData
	)			[protected, virtual]

Execute the calculations required by the Assess option.

Reimplemented from vtkBivariateStatisticsAlgorithm.

virtual void vtkContingencyStatistics::Test	(	vtkTable *	inData,
		vtkDataObject *	inMeta,
		vtkDataObject *	outMeta
	)			[protected, virtual]

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

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 does nothing because the API is not sufficient for tables indexed by a separate summary table.

---

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

• dox/Infovis/vtkContingencyStatistics.h