vtkPContingencyStatistics Class Reference

A class for parallel bivariate contingency statistics. More...

#include <vtkPContingencyStatistics.h>

Inheritance diagram for vtkPContingencyStatistics:

Collaboration diagram for vtkPContingencyStatistics:

List of all members.

Public Types
typedef vtkContingencyStatistics	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkPContingencyStatistics *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetController (vtkMultiProcessController *)
virtual vtkMultiProcessController *	GetController ()
virtual void	Learn (vtkTable *, vtkTable *, vtkMultiBlockDataSet *)
Static Public Member Functions
static vtkPContingencyStatistics *	New ()
static int	IsTypeOf (const char *type)
static vtkPContingencyStatistics *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPContingencyStatistics ()
	~vtkPContingencyStatistics ()
bool	Reduce (vtkIdType &, char *, vtkStdString &, vtkIdType &, vtkIdType *, std::vector< vtkIdType > &)
bool	Broadcast (vtkIdType, vtkStdString &, std::vector< vtkStdString > &, vtkIdType, std::vector< vtkIdType > &, vtkIdType)
Protected Attributes
vtkMultiProcessController *	Controller

---

Detailed Description

A class for parallel bivariate contingency statistics.

vtkPContingencyStatistics is vtkContingencyStatistics subclass for parallel datasets. It learns and derives the global statistical model on each node, but assesses each individual data points on the node that owns it.

.NOTE: It is assumed that the keys in the contingency table be contained in the set {0,...,n-1} of successive integers, where n is the number of rows of the summary table. If this requirement is not fulfilled, then the outcome of the parallel update of contingency tables is unpredictable but will most likely be a crash. Note that this requirement is consistent with the way contingency tables are constructed by the (serial) superclass and thus, if you are using this class as it is intended to be ran, then you do not have to worry about this requirement.

Thanks:

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

Tests:

vtkPContingencyStatistics (Tests)

Definition at line 55 of file vtkPContingencyStatistics.h.

---

Member Typedef Documentation

typedef vtkContingencyStatistics vtkPContingencyStatistics::Superclass

Reimplemented from vtkContingencyStatistics.

Definition at line 59 of file vtkPContingencyStatistics.h.

---

Constructor & Destructor Documentation

vtkPContingencyStatistics::vtkPContingencyStatistics

(

)

[protected]

vtkPContingencyStatistics::~vtkPContingencyStatistics

(

)

[protected]

---

Member Function Documentation

static vtkPContingencyStatistics* vtkPContingencyStatistics::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkContingencyStatistics.

static int vtkPContingencyStatistics::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 vtkContingencyStatistics.

virtual int vtkPContingencyStatistics::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 vtkContingencyStatistics.

static vtkPContingencyStatistics* vtkPContingencyStatistics::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkContingencyStatistics.

virtual vtkObjectBase* vtkPContingencyStatistics::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkContingencyStatistics.

vtkPContingencyStatistics* vtkPContingencyStatistics::NewInstance

(

)

const

Reimplemented from vtkContingencyStatistics.

void vtkPContingencyStatistics::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 vtkContingencyStatistics.

virtual void vtkPContingencyStatistics::SetController

(

vtkMultiProcessController *

)

[virtual]

Get/Set the multiprocess controller. If no controller is set, single process is assumed.

virtual vtkMultiProcessController* vtkPContingencyStatistics::GetController

(

)

[virtual]

Get/Set the multiprocess controller. If no controller is set, single process is assumed.

virtual void vtkPContingencyStatistics::Learn	(	vtkTable *	,
		vtkTable *	,
		vtkMultiBlockDataSet *
	)		[virtual]

Execute the parallel calculations required by the Learn option.

Reimplemented from vtkContingencyStatistics.

bool vtkPContingencyStatistics::Reduce	(	vtkIdType &	,
		char *	,
		vtkStdString &	,
		vtkIdType &	,
		vtkIdType *	,
		std::vector< vtkIdType > &
	)		[protected]

Reduce the collection of local contingency tables to the global one

bool vtkPContingencyStatistics::Broadcast	(	vtkIdType	,
		vtkStdString &	,
		std::vector< vtkStdString > &	,
		vtkIdType	,
		std::vector< vtkIdType > &	,
		vtkIdType
	)		[protected]

Broadcast reduced contingency table to all processes

---

Member Data Documentation

vtkMultiProcessController* vtkPContingencyStatistics::Controller [protected]

Definition at line 102 of file vtkPContingencyStatistics.h.

---

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

• dox/Filters/ParallelStatistics/vtkPContingencyStatistics.h