vtkStatisticsAlgorithm Class Reference

#include <vtkStatisticsAlgorithm.h>

Inheritance diagram for vtkStatisticsAlgorithm:

Inheritance graph
[legend]
Collaboration diagram for vtkStatisticsAlgorithm:

Collaboration graph
[legend]
List of all members.

Detailed Description

Base class for statistics algorithms.

All statistics algorithms can conceptually be operated in a variety of execution modes: Learn: given an input data set, calculate some type of statistics (e.g., descriptive, 5-point, correlations, PCA). Assess: given an input data set, input statistics, and some form of threshold, assess a subset of the data set. Therefore, a vtkStatisticsAlgorithm has the following vtkTable ports 2 input ports: Data (mandatory) Statistics (optional) 1 output port (called Output): When in Learn mode, the output table contains summary statistics of the input inData. When in Assess mode, the output table is a list of input rows that don't fit (or fit) the model to within some amount specified by the filter input parameters.

Thanks:
Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
Tests:
vtkStatisticsAlgorithm (Tests)

Definition at line 57 of file vtkStatisticsAlgorithm.h.

Public Types

typedef vtkTableAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetInputStatisticsConnection (vtkAlgorithmOutput *)
void SetAssessParameter (vtkIdType id, vtkStdString name)
vtkStdString SetAssessParameter (vtkIdType id)
virtual void SetSampleSize (vtkIdType)
virtual vtkIdType GetSampleSize ()
virtual void SetLearn (bool)
virtual bool GetLearn ()
virtual void SetValidate (bool)
virtual bool GetValidate ()
virtual void SetAssess (bool)
virtual bool GetAssess ()
virtual void SetAssessmentName (const char *)
virtual char * GetAssessmentName ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkStatisticsAlgorithmSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkStatisticsAlgorithm ()
 ~vtkStatisticsAlgorithm ()
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ExecuteLearn (vtkTable *, vtkTable *)=0
virtual void ExecuteAssess (vtkTable *, vtkTable *, vtkTable *, vtkTable *)=0

Protected Attributes

vtkIdType SampleSize
bool Learn
bool Validate
bool Assess
char * AssessmentName
vtkStringArrayAssessParameters


Member Typedef Documentation

typedef vtkTableAlgorithm vtkStatisticsAlgorithm::Superclass

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkBivariateStatisticsAlgorithm, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkOrderStatistics, and vtkUnivariateStatisticsAlgorithm.

Definition at line 60 of file vtkStatisticsAlgorithm.h.


Constructor & Destructor Documentation

vtkStatisticsAlgorithm::vtkStatisticsAlgorithm (  )  [protected]

vtkStatisticsAlgorithm::~vtkStatisticsAlgorithm (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkBivariateStatisticsAlgorithm, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkOrderStatistics, and vtkUnivariateStatisticsAlgorithm.

static int vtkStatisticsAlgorithm::IsTypeOf ( const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkBivariateStatisticsAlgorithm, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkOrderStatistics, and vtkUnivariateStatisticsAlgorithm.

virtual int vtkStatisticsAlgorithm::IsA ( const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkBivariateStatisticsAlgorithm, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkOrderStatistics, and vtkUnivariateStatisticsAlgorithm.

static vtkStatisticsAlgorithm* vtkStatisticsAlgorithm::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkBivariateStatisticsAlgorithm, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkOrderStatistics, and vtkUnivariateStatisticsAlgorithm.

void vtkStatisticsAlgorithm::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 vtkTableAlgorithm.

Reimplemented in vtkBivariateStatisticsAlgorithm, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkOrderStatistics, and vtkUnivariateStatisticsAlgorithm.

virtual void vtkStatisticsAlgorithm::SetInputStatisticsConnection ( vtkAlgorithmOutput  )  [virtual]

A convenience method for setting the statistics table input. NB: This is mainly for the benefit of the VTK client/server layer, vanilla VTKcode should use, e.g: stats_algo2->SetInputConnection( 1, stats_algo1->output() );

virtual void vtkStatisticsAlgorithm::SetSampleSize ( vtkIdType   )  [virtual]

Set the sample size.

virtual vtkIdType vtkStatisticsAlgorithm::GetSampleSize (  )  [virtual]

Get the sample size.

virtual void vtkStatisticsAlgorithm::SetLearn ( bool   )  [virtual]

Set the Learn option.

virtual bool vtkStatisticsAlgorithm::GetLearn (  )  [virtual]

Get the Learn option.

virtual void vtkStatisticsAlgorithm::SetValidate ( bool   )  [virtual]

Set the Validate option.

virtual bool vtkStatisticsAlgorithm::GetValidate (  )  [virtual]

Get the Validate option.

virtual void vtkStatisticsAlgorithm::SetAssess ( bool   )  [virtual]

Set the Assess option.

virtual bool vtkStatisticsAlgorithm::GetAssess (  )  [virtual]

Get the Assess option.

virtual void vtkStatisticsAlgorithm::SetAssessmentName ( const char *   )  [virtual]

Set the assessment name.

virtual char* vtkStatisticsAlgorithm::GetAssessmentName (  )  [virtual]

Get the assessment name.

void vtkStatisticsAlgorithm::SetAssessParameter ( vtkIdType  id,
vtkStdString  name 
)

Set the name of a parameter of the Assess option

vtkStdString vtkStatisticsAlgorithm::SetAssessParameter ( vtkIdType  id  ) 

Get the name of a parameter of the Assess option

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

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkTableAlgorithm.

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

Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkTableAlgorithm.

virtual int vtkStatisticsAlgorithm::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkTableAlgorithm.

virtual void vtkStatisticsAlgorithm::ExecuteLearn ( vtkTable ,
vtkTable  
) [protected, pure virtual]

Execute the required calculations in the specified execution modes

Implemented in vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, and vtkOrderStatistics.

virtual void vtkStatisticsAlgorithm::ExecuteAssess ( vtkTable ,
vtkTable ,
vtkTable ,
vtkTable  
) [protected, pure virtual]

Execute the required calculations in the specified execution modes

Implemented in vtkContingencyStatistics, vtkCorrelativeStatistics, and vtkUnivariateStatisticsAlgorithm.


Member Data Documentation

vtkIdType vtkStatisticsAlgorithm::SampleSize [protected]

Definition at line 149 of file vtkStatisticsAlgorithm.h.

bool vtkStatisticsAlgorithm::Learn [protected]

Definition at line 150 of file vtkStatisticsAlgorithm.h.

bool vtkStatisticsAlgorithm::Validate [protected]

Definition at line 151 of file vtkStatisticsAlgorithm.h.

bool vtkStatisticsAlgorithm::Assess [protected]

Definition at line 152 of file vtkStatisticsAlgorithm.h.

char* vtkStatisticsAlgorithm::AssessmentName [protected]

Definition at line 153 of file vtkStatisticsAlgorithm.h.

vtkStringArray* vtkStatisticsAlgorithm::AssessParameters [protected]

Definition at line 154 of file vtkStatisticsAlgorithm.h.


The documentation for this class was generated from the following file:
Generated on Fri Sep 5 15:29:09 2008 for VTK by  doxygen 1.4.7