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
vtkOrderStatistics Class Reference

A class for univariate order statistics. More...

#include <vtkOrderStatistics.h>

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

Public Types

typedef vtkStatisticsAlgorithm Superclass
 
enum  QuantileDefinitionType { InverseCDF = 0, InverseCDFAveragedSteps = 1, NearestObservation = 2 }
 
- 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)
 
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 *)
 
- 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)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkOrderStatisticsSafeDownCast (vtkObjectBase *o)
 
static vtkOrderStatisticsNew ()
 
- Static Public Member Functions inherited from vtkStatisticsAlgorithm
static int IsTypeOf (const char *type)
 
static vtkStatisticsAlgorithmSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () 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 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

int NumberOfIntervals
 
QuantileDefinitionType QuantileDefinition
 
bool Quantize
 
vtkIdType MaximumHistogramSize
 
- Protected Attributes inherited from vtkStatisticsAlgorithm
int NumberOfPrimaryTables
 
bool LearnOption
 
bool DeriveOption
 
bool AssessOption
 
bool TestOption
 
vtkStringArray * AssessNames
 
vtkStatisticsAlgorithmPrivateInternals
 

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

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

vtkOrderStatistics::vtkOrderStatistics ( )
protected
vtkOrderStatistics::~vtkOrderStatistics ( )
protected

Member Function Documentation

static int vtkOrderStatistics::IsTypeOf ( const char *  type)
static
virtual int vtkOrderStatistics::IsA ( const char *  type)
virtual

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPOrderStatistics.

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

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPOrderStatistics.

vtkOrderStatistics* vtkOrderStatistics::NewInstance ( ) const
void vtkOrderStatistics::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkOrderStatistics* vtkOrderStatistics::New ( )
static
virtual void vtkOrderStatistics::SetNumberOfIntervals ( vtkIdType  )
virtual

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

virtual vtkIdType vtkOrderStatistics::GetNumberOfIntervals ( )
virtual

Set/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.

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.

virtual void vtkOrderStatistics::SetMaximumHistogramSize ( vtkIdType  )
virtual

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

virtual vtkIdType vtkOrderStatistics::GetMaximumHistogramSize ( )
virtual

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

vtkIdType vtkOrderStatistics::GetQuantileDefinition ( )
inline

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 *   
)
inlinevirtual

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 *   
)
protectedvirtual

Execute the calculations required by the Learn option.

Implements vtkStatisticsAlgorithm.

Reimplemented in vtkPOrderStatistics.

virtual void vtkOrderStatistics::Derive ( vtkMultiBlockDataSet *  )
protectedvirtual

Execute the calculations required by the Derive option.

Implements vtkStatisticsAlgorithm.

virtual void vtkOrderStatistics::Test ( vtkTable *  ,
vtkMultiBlockDataSet *  ,
vtkTable *   
)
protectedvirtual

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

virtual void vtkOrderStatistics::Assess ( vtkTable *  inData,
vtkMultiBlockDataSet *  inMeta,
vtkTable *  outData 
)
inlineprotectedvirtual

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 
)
protectedvirtual

Provide the appropriate assessment functor.

Implements vtkStatisticsAlgorithm.

Member Data Documentation

int vtkOrderStatistics::NumberOfIntervals
protected

Definition at line 161 of file vtkOrderStatistics.h.

QuantileDefinitionType vtkOrderStatistics::QuantileDefinition
protected

Definition at line 162 of file vtkOrderStatistics.h.

bool vtkOrderStatistics::Quantize
protected

Definition at line 163 of file vtkOrderStatistics.h.

vtkIdType vtkOrderStatistics::MaximumHistogramSize
protected

Definition at line 164 of file vtkOrderStatistics.h.


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