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 | Protected Attributes | List of all members
vtkPContingencyStatistics Class Reference

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

#include <vtkPContingencyStatistics.h>

Inheritance diagram for vtkPContingencyStatistics:
[legend]
Collaboration diagram for vtkPContingencyStatistics:
[legend]

Public Types

typedef vtkContingencyStatistics Superclass
 
- Public Types inherited from vtkContingencyStatistics
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)
 
vtkPContingencyStatisticsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetController (vtkMultiProcessController *)
 
virtual vtkMultiProcessController * GetController ()
 
virtual void Learn (vtkTable *, vtkTable *, vtkMultiBlockDataSet *)
 
- Public Member Functions inherited from vtkContingencyStatistics
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 vtkPContingencyStatisticsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPContingencyStatisticsSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkContingencyStatistics
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
 
 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 Member Functions inherited from vtkContingencyStatistics
 vtkContingencyStatistics ()
 
 ~vtkContingencyStatistics ()
 
virtual void Derive (vtkMultiBlockDataSet *)
 
virtual void CalculatePValues (vtkTable *)
 
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)
 

Protected Attributes

vtkMultiProcessController * Controller
 
- Protected Attributes inherited from vtkStatisticsAlgorithm
int NumberOfPrimaryTables
 
bool LearnOption
 
bool DeriveOption
 
bool AssessOption
 
bool TestOption
 
vtkStringArray * AssessNames
 
vtkStatisticsAlgorithmPrivateInternals
 

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

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
static int vtkPContingencyStatistics::IsTypeOf ( const char *  type)
static
virtual int vtkPContingencyStatistics::IsA ( const char *  type)
virtual

Reimplemented from vtkContingencyStatistics.

static vtkPContingencyStatistics* vtkPContingencyStatistics::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkPContingencyStatistics::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkContingencyStatistics.

vtkPContingencyStatistics* vtkPContingencyStatistics::NewInstance ( ) const
void vtkPContingencyStatistics::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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: