VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkOrderStatistics Class Reference

A class for univariate order statistics. More...

#include <vtkOrderStatistics.h>

Inheritance diagram for vtkOrderStatistics:
Inheritance graph
[legend]
Collaboration diagram for vtkOrderStatistics:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkStatisticsAlgorithm Superclass
enum  QuantileDefinitionType { InverseCDF = 0, InverseCDFAveragedSteps = 1, NearestObservation = 2 }

Public Member Functions

virtual int IsA (const char *type)
vtkOrderStatisticsNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
vtkIdType GetQuantileDefinition ()
virtual void SetNumberOfIntervals (vtkIdType)
virtual vtkIdType GetNumberOfIntervals ()
virtual void SetQuantileDefinition (QuantileDefinitionType)
void SetQuantileDefinition (int)
virtual void SetQuantize (bool)
virtual bool GetQuantize ()
virtual void SetMaximumHistogramSize (vtkIdType)
virtual vtkIdType GetMaximumHistogramSize ()
virtual bool SetParameter (const char *parameter, int index, vtkVariant value)
virtual void Aggregate (vtkDataObjectCollection *, vtkMultiBlockDataSet *)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkOrderStatisticsSafeDownCast (vtkObjectBase *o)
static vtkOrderStatisticsNew ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkOrderStatistics ()
 ~vtkOrderStatistics ()
virtual void Derive (vtkMultiBlockDataSet *)
virtual void Learn (vtkTable *, vtkTable *, vtkMultiBlockDataSet *)
virtual void Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)
virtual void Assess (vtkTable *inData, vtkMultiBlockDataSet *inMeta, vtkTable *outData)
virtual void SelectAssessFunctor (vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)

Protected Attributes

int NumberOfIntervals
QuantileDefinitionType QuantileDefinition
bool Quantize
vtkIdType MaximumHistogramSize

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 histogram. Derive: calculate PDFs and arbitrary quantiles. Provide specific names when 5-point statistics (minimum, 1st quartile, median, third quartile, maximum) requested. Assess: given an input data set and a set of q-quantiles, label each datum either with the quantile interval to which it belongs, or 0 if it is smaller than smaller quantile, or q if it is larger than largest quantile. Test: calculate Kolmogorov-Smirnov goodness-of-fit statistic between CDF based on model quantiles, and empirical CDF

Thanks:
Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class. Updated by Philippe Pebay, Kitware SAS 2012
Examples:
vtkOrderStatistics (Examples)
Tests:
vtkOrderStatistics (Tests)

Definition at line 59 of file vtkOrderStatistics.h.


Member Typedef Documentation

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPOrderStatistics.

Definition at line 62 of file vtkOrderStatistics.h.


Member Enumeration Documentation

The type of quantile definition.

Enumerator:
InverseCDF 
InverseCDFAveragedSteps 
NearestObservation 

Definition at line 69 of file vtkOrderStatistics.h.


Constructor & Destructor Documentation


Member Function Documentation

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 vtkStatisticsAlgorithm.

Reimplemented in vtkPOrderStatistics.

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 vtkStatisticsAlgorithm.

Reimplemented in vtkPOrderStatistics.

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPOrderStatistics.

virtual vtkObjectBase* vtkOrderStatistics::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPOrderStatistics.

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPOrderStatistics.

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 vtkStatisticsAlgorithm.

Reimplemented in vtkPOrderStatistics.

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

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPOrderStatistics.

Set/Get the number of quantiles (with uniform spacing).

Set/Get the number of quantiles (with uniform spacing).

Set the quantile definition.

Set the quantile definition.

virtual void vtkOrderStatistics::SetQuantize ( bool  ) [virtual]

Set/Get whether quantization will be allowed to enforce maximum histogram size.

virtual bool vtkOrderStatistics::GetQuantize ( ) [virtual]

Set/Get whether quantization will be allowed to enforce maximum histogram size.

Set/Get the maximum histogram size. This maximum size is enforced only when Quantize is TRUE.

Set/Get the maximum histogram size. This maximum size is enforced only when Quantize is TRUE.

Get the quantile definition.

Definition at line 104 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 ,
vtkMultiBlockDataSet  
) [inline, virtual]

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

Implements vtkStatisticsAlgorithm.

Definition at line 118 of file vtkOrderStatistics.h.

virtual void vtkOrderStatistics::Learn ( vtkTable ,
vtkTable ,
vtkMultiBlockDataSet  
) [protected, virtual]

Execute the calculations required by the Learn option.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPOrderStatistics.

virtual void vtkOrderStatistics::Derive ( vtkMultiBlockDataSet ) [protected, virtual]

Execute the calculations required by the Derive option.

Implements vtkStatisticsAlgorithm.

virtual void vtkOrderStatistics::Test ( vtkTable ,
vtkMultiBlockDataSet ,
vtkTable  
) [protected, virtual]

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

virtual void vtkOrderStatistics::Assess ( vtkTable inData,
vtkMultiBlockDataSet inMeta,
vtkTable outData 
) [inline, protected, virtual]

Execute the calculations required by the Assess option.

Implements vtkStatisticsAlgorithm.

Definition at line 145 of file vtkOrderStatistics.h.

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

Provide the appropriate assessment functor.

Implements vtkStatisticsAlgorithm.


Member Data Documentation

Definition at line 161 of file vtkOrderStatistics.h.

Definition at line 162 of file vtkOrderStatistics.h.

bool vtkOrderStatistics::Quantize [protected]

Definition at line 163 of file vtkOrderStatistics.h.

Definition at line 164 of file vtkOrderStatistics.h.


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