vtkDescriptiveStatistics Class Reference

#include <vtkDescriptiveStatistics.h>

Inheritance diagram for vtkDescriptiveStatistics:

[legend]

Collaboration diagram for vtkDescriptiveStatistics:

[legend]

List of all members.

Detailed Description

A class for univariate descriptive statistics.

Private implementation for bivariate statistics algorithms.

Given a selection of columns of interest in an input data table, this class provides the following functionalities, depending on the execution mode it is executed in: Learn: calculate extremal values, arithmetic mean, unbiased variance estimator, skewness estimator, and both sample and G2 estimation of the kurtosis excess. More precisely, Learn calculates the sums; if finalize is set to true (default), the final statistics are calculated with CalculateFromSums. Otherwise, only raw sums are output; this option is made for efficient parallel calculations. Note that CalculateFromSums is a static function, so that it can be used directly with no need to instantiate a vtkDescriptiveStatistics object. Assess: given an input data set in port INPUT_DATA, and a reference value x along with an acceptable deviation d>0, assess all entries in the data set which are outside of [x-d,x+d].

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

Examples:: vtkDescriptiveStatistics (Examples)

Tests:: vtkDescriptiveStatistics (Tests)

The main purpose of this class is to avoid exposure of STL container through the APIs of the vtkStatistics classes APIs

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

Definition at line 59 of file vtkDescriptiveStatistics.h.


Public Types
typedef vtkUnivariateStatisticsAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetNominalParameter (const char *name)
void	SetDeviationParameter (const char *name)

virtual void	SetUnbiasedVariance (int)
virtual int	GetUnbiasedVariance ()
virtual void	UnbiasedVarianceOn ()
virtual void	UnbiasedVarianceOff ()

virtual void	SetSignedDeviations (int)
virtual int	GetSignedDeviations ()
virtual void	SignedDeviationsOn ()
virtual void	SignedDeviationsOff ()

virtual void	Aggregate (vtkDataObjectCollection , vtkDataObject )
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkDescriptiveStatistics *	SafeDownCast (vtkObject *o)
static vtkDescriptiveStatistics *	New ()
Protected Member Functions
	vtkDescriptiveStatistics ()
	~vtkDescriptiveStatistics ()
virtual void	Derive (vtkDataObject *)

virtual void	Learn (vtkTable inData, vtkTable inParameters, vtkDataObject *outMeta)

virtual void	Test (vtkTable inData, vtkDataObject inMeta, vtkDataObject *outMeta)

virtual void	SelectAssessFunctor (vtkTable outData, vtkDataObject inMeta, vtkStringArray rowNames, AssessFunctor &dfunc)
Protected Attributes
int	UnbiasedVariance
int	SignedDeviations

Member Typedef Documentation

typedef vtkUnivariateStatisticsAlgorithm vtkDescriptiveStatistics::Superclass

Reimplemented from vtkUnivariateStatisticsAlgorithm.

Reimplemented in vtkPDescriptiveStatistics.

Definition at line 62 of file vtkDescriptiveStatistics.h.

Constructor & Destructor Documentation

vtkDescriptiveStatistics::vtkDescriptiveStatistics ( ) [protected]

vtkDescriptiveStatistics::~vtkDescriptiveStatistics ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkUnivariateStatisticsAlgorithm.

Reimplemented in vtkPDescriptiveStatistics.

static int vtkDescriptiveStatistics::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 vtkUnivariateStatisticsAlgorithm.

Reimplemented in vtkPDescriptiveStatistics.

virtual int vtkDescriptiveStatistics::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 vtkUnivariateStatisticsAlgorithm.

Reimplemented in vtkPDescriptiveStatistics.

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

Reimplemented from vtkUnivariateStatisticsAlgorithm.

Reimplemented in vtkPDescriptiveStatistics.

void vtkDescriptiveStatistics::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 vtkUnivariateStatisticsAlgorithm.

Reimplemented in vtkPDescriptiveStatistics.

static vtkDescriptiveStatistics* vtkDescriptiveStatistics::New ( ) [static]

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

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPDescriptiveStatistics.

virtual void vtkDescriptiveStatistics::SetUnbiasedVariance ( int ) [virtual]

Set/get whether the unbiased estimator for the variance should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.

virtual int vtkDescriptiveStatistics::GetUnbiasedVariance ( ) [virtual]

Set/get whether the unbiased estimator for the variance should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.

virtual void vtkDescriptiveStatistics::UnbiasedVarianceOn ( ) [virtual]

Set/get whether the unbiased estimator for the variance should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.

virtual void vtkDescriptiveStatistics::UnbiasedVarianceOff ( ) [virtual]

Set/get whether the unbiased estimator for the variance should be used, or if the population variance will be calculated. The default is that the unbiased estimator will be used.

virtual void vtkDescriptiveStatistics::SetSignedDeviations ( int ) [virtual]

Set/get whether the deviations returned should be signed, or should only have their magnitude reported. The default is that signed deviations will be computed.

virtual int vtkDescriptiveStatistics::GetSignedDeviations ( ) [virtual]

Set/get whether the deviations returned should be signed, or should only have their magnitude reported. The default is that signed deviations will be computed.

virtual void vtkDescriptiveStatistics::SignedDeviationsOn ( ) [virtual]

Set/get whether the deviations returned should be signed, or should only have their magnitude reported. The default is that signed deviations will be computed.

virtual void vtkDescriptiveStatistics::SignedDeviationsOff ( ) [virtual]

Set/get whether the deviations returned should be signed, or should only have their magnitude reported. The default is that signed deviations will be computed.

void vtkDescriptiveStatistics::SetNominalParameter ( const char * name )

A convenience method (in particular for UI wrapping) to set the name of the column that contains the nominal value for the Assess option.

void vtkDescriptiveStatistics::SetDeviationParameter ( const char * name )

A convenience method (in particular for UI wrapping) to set the name of the column that contains the deviation for the Assess option.

virtual void vtkDescriptiveStatistics::Aggregate	(	vtkDataObjectCollection *	,
		vtkDataObject *
	)			`[virtual]`

Given a collection of models, calculate aggregate model

Implements vtkStatisticsAlgorithm.

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

Execute the calculations required by the Learn option, given some input Data NB: input parameters are unused.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPDescriptiveStatistics.

virtual void vtkDescriptiveStatistics::Derive ( vtkDataObject * ) [protected, virtual]

Execute the calculations required by the Derive option.

Implements vtkStatisticsAlgorithm.

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

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

virtual void vtkDescriptiveStatistics::SelectAssessFunctor	(	vtkTable *	outData,
		vtkDataObject *	inMeta,
		vtkStringArray *	rowNames,
		AssessFunctor *&	dfunc
	)			`[protected, virtual]`