vtkPContingencyStatistics Class Reference

#include <vtkPContingencyStatistics.h>

Inheritance diagram for vtkPContingencyStatistics:

Inheritance graph
[legend]
Collaboration diagram for vtkPContingencyStatistics:

Collaboration graph
[legend]

List of all members.


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 49 of file vtkPContingencyStatistics.h.


Public Types

typedef vtkContingencyStatistics Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetController (vtkMultiProcessController *)
virtual vtkMultiProcessControllerGetController ()
virtual void Learn (vtkTable *inData, vtkTable *inParameters, vtkMultiBlockDataSet *outMeta)

Static Public Member Functions

static vtkPContingencyStatisticsNew ()
static int IsTypeOf (const char *type)
static vtkPContingencyStatisticsSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPContingencyStatistics ()
 ~vtkPContingencyStatistics ()
bool Pack (vtkTable *contingencyTab, vtkStdString &xyPacked, vtkstd::vector< vtkIdType > &kcValues)
bool Reduce (vtkIdType &xySizeTotal, char *xyPacked_g, vtkStdString &xyPacked_l, vtkIdType &kcSizeTotal, vtkIdType *kcValues_g, vtkstd::vector< vtkIdType > &kcValues_l)
bool Broadcast (vtkIdType xySizeTotal, vtkStdString &xyPacked, vtkstd::vector< vtkStdString > &xyValues, vtkIdType kcSizeTotal, vtkstd::vector< vtkIdType > &kcValues, vtkIdType reduceProc)

Protected Attributes

vtkMultiProcessControllerController

Member Typedef Documentation

Reimplemented from vtkContingencyStatistics.

Definition at line 53 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.

virtual const char* vtkPContingencyStatistics::GetClassName (  )  [virtual]

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 ( vtkObject o  )  [static]

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 inData,
vtkTable inParameters,
vtkMultiBlockDataSet outMeta 
) [virtual]

Execute the parallel calculations required by the Learn option.

Reimplemented from vtkContingencyStatistics.

bool vtkPContingencyStatistics::Pack ( vtkTable contingencyTab,
vtkStdString xyPacked,
vtkstd::vector< vtkIdType > &  kcValues 
) [protected]

Pack all entries of a contingency table in: 1. a single string for all realizations of pairs of categorical variables, and 2. a single vector for the corresponding keys and cardinalities

bool vtkPContingencyStatistics::Reduce ( vtkIdType xySizeTotal,
char *  xyPacked_g,
vtkStdString xyPacked_l,
vtkIdType kcSizeTotal,
vtkIdType kcValues_g,
vtkstd::vector< vtkIdType > &  kcValues_l 
) [protected]

Reduce the collection of local contingency tables to the global one

bool vtkPContingencyStatistics::Broadcast ( vtkIdType  xySizeTotal,
vtkStdString xyPacked,
vtkstd::vector< vtkStdString > &  xyValues,
vtkIdType  kcSizeTotal,
vtkstd::vector< vtkIdType > &  kcValues,
vtkIdType  reduceProc 
) [protected]

Broadcast reduced contingency table to all processes


Member Data Documentation

Definition at line 105 of file vtkPContingencyStatistics.h.


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

Generated on Wed Aug 24 11:54:16 2011 for VTK by  doxygen 1.5.6