vtkOrderStatistics Class Reference

#include <vtkOrderStatistics.h>

Inheritance diagram for vtkOrderStatistics:

[legend]

Collaboration diagram for vtkOrderStatistics:

[legend]

List of all members.

Detailed Description

A class for univariate order statistics.

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 5-point statistics (minimum, 1st quartile, median, third quartile, maximum) and all other deciles (1,2,3,4,6,7,8,9). Assess: given an input data set in port INPUT_DATA, and two percentiles p1 < p2, assess all entries in the data set which are outside of [p1,p2].

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

Examples:: vtkOrderStatistics (Examples)

Tests:: vtkOrderStatistics (Tests)

Definition at line 52 of file vtkOrderStatistics.h.


Public Types
typedef vtkUnivariateStatisticsAlgorithm	Superclass

enum	QuantileDefinitionType { InverseCDF = 0, InverseCDFAveragedSteps = 1 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
vtkIdType	GetQuantileDefinition ()

virtual void	SetNumberOfIntervals (vtkIdType)

virtual vtkIdType	GetNumberOfIntervals ()

virtual void	SetQuantileDefinition (QuantileDefinitionType)
void	SetQuantileDefinition (int)

virtual bool	SetParameter (const char *parameter, int index, vtkVariant value)

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

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

virtual void	Test (vtkTable , vtkDataObject , vtkDataObject *)

virtual void	SelectAssessFunctor (vtkTable outData, vtkDataObject inMeta, vtkStringArray rowNames, AssessFunctor &dfunc)
Protected Attributes
int	NumberOfIntervals
QuantileDefinitionType	QuantileDefinition

Member Typedef Documentation

typedef vtkUnivariateStatisticsAlgorithm vtkOrderStatistics::Superclass

Reimplemented from vtkUnivariateStatisticsAlgorithm.

Definition at line 55 of file vtkOrderStatistics.h.

Member Enumeration Documentation

enum vtkOrderStatistics::QuantileDefinitionType

The type of quantile definition. BTX

Enumerator:

InverseCDF
InverseCDFAveragedSteps

Definition at line 61 of file vtkOrderStatistics.h.

Constructor & Destructor Documentation

vtkOrderStatistics::vtkOrderStatistics ( ) [protected]

vtkOrderStatistics::~vtkOrderStatistics ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkUnivariateStatisticsAlgorithm.

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

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

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

Reimplemented from vtkUnivariateStatisticsAlgorithm.

void vtkOrderStatistics::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.

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

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

Reimplemented from vtkTableAlgorithm.

virtual void vtkOrderStatistics::SetNumberOfIntervals ( vtkIdType ) [virtual]

Set the number of quantiles (with uniform spacing).

virtual vtkIdType vtkOrderStatistics::GetNumberOfIntervals ( ) [virtual]

Get the number of quantiles (with uniform spacing).

virtual void vtkOrderStatistics::SetQuantileDefinition ( QuantileDefinitionType ) [virtual]

Set the quantile definition.

void vtkOrderStatistics::SetQuantileDefinition ( int )

Set the quantile definition.

vtkIdType vtkOrderStatistics::GetQuantileDefinition ( ) [inline]

Get the quantile definition.

Definition at line 85 of file vtkOrderStatistics.h.

virtual bool vtkOrderStatistics::SetParameter	(	const char *	parameter,
		int	index,
		vtkVariant	value
	)			`[virtual]`

A convenience method (in particular for access from other applications) to set parameter values. Return true if setting of requested parameter name was excuted, false otherwise.

Reimplemented from vtkStatisticsAlgorithm.

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

Given a collection of models, calculate aggregate model NB: not implemented

Implements vtkStatisticsAlgorithm.

Definition at line 101 of file vtkOrderStatistics.h.

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

Execute the calculations required by the Learn option.

Implements vtkStatisticsAlgorithm.

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

Execute the calculations required by the Derive option.

Implements vtkStatisticsAlgorithm.

virtual void vtkOrderStatistics::Test	(	vtkTable *	,
		vtkDataObject *	,
		vtkDataObject *
	)			`[inline, protected, virtual]`

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

Definition at line 121 of file vtkOrderStatistics.h.

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