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:
[legend]
Collaboration diagram for vtkOrderStatistics:
[legend]

List of all members.

Public Types

typedef
vtkUnivariateStatisticsAlgorithm 
Superclass
enum  QuantileDefinitionType { InverseCDF = 0, InverseCDFAveragedSteps = 1 }
- Public Types inherited from vtkUnivariateStatisticsAlgorithm
- Public Types inherited from vtkStatisticsAlgorithm
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 Types inherited from vtkTableAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkIdType GetQuantileDefinition ()
virtual void SetNumericType (int)
virtual int GetNumericType ()
virtual void NumericTypeOn ()
virtual void NumericTypeOff ()
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 *, vtkMultiBlockDataSet *)
- Public Member Functions inherited from vtkUnivariateStatisticsAlgorithm
void AddColumn (const char *namCol)
virtual int RequestSelectedColumns ()
- Public Member Functions inherited from vtkStatisticsAlgorithm
void SetAssessOptionParameter (vtkIdType id, vtkStdString name)
vtkStdString GetAssessParameter (vtkIdType id)
virtual void SetColumnStatus (const char *namCol, int status)
virtual void ResetAllColumnStates ()
virtual void ResetRequests ()
virtual vtkIdType GetNumberOfRequests ()
virtual vtkIdType GetNumberOfColumnsForRequest (vtkIdType request)
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 SetAssessParameters (vtkStringArray *)
virtual vtkStringArrayGetAssessParameters ()
virtual void SetAssessNames (vtkStringArray *)
virtual vtkStringArrayGetAssessNames ()
virtual const char * GetColumnForRequest (vtkIdType r, vtkIdType c)
virtual int GetColumnForRequest (vtkIdType r, vtkIdType c, vtkStdString &columnName)
- Public Member Functions inherited from vtkTableAlgorithm
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkTableGetOutput ()
vtkTableGetOutput (int index)
void SetInput (vtkDataObject *obj)
void SetInput (int index, vtkDataObject *obj)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

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

Protected Member Functions

 vtkOrderStatistics ()
 ~vtkOrderStatistics ()
virtual void Derive (vtkMultiBlockDataSet *)
virtual void Learn (vtkTable *inData, vtkTable *inParameters, vtkMultiBlockDataSet *outMeta)
virtual void Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)
virtual void SelectAssessFunctor (vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)
- Protected Member Functions inherited from vtkUnivariateStatisticsAlgorithm
 vtkUnivariateStatisticsAlgorithm ()
 ~vtkUnivariateStatisticsAlgorithm ()
virtual void Assess (vtkTable *inData, vtkMultiBlockDataSet *inMeta, vtkTable *outData)
- 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 *)
- Protected Member Functions inherited from vtkTableAlgorithm
 vtkTableAlgorithm ()
 ~vtkTableAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int NumericType
int NumberOfIntervals
QuantileDefinitionType QuantileDefinition

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

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 54 of file vtkOrderStatistics.h.


Member Typedef Documentation

Reimplemented from vtkUnivariateStatisticsAlgorithm.

Reimplemented in vtkPOrderStatistics.

Definition at line 57 of file vtkOrderStatistics.h.


Member Enumeration Documentation

The type of quantile definition.

Enumerator:
InverseCDF 
InverseCDFAveragedSteps 

Definition at line 64 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.

Reimplemented in vtkPOrderStatistics.

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.

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

Reimplemented in vtkPOrderStatistics.

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

Reimplemented from vtkUnivariateStatisticsAlgorithm.

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

Reimplemented in vtkPOrderStatistics.

static vtkOrderStatistics* vtkOrderStatistics::New ( )
static

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

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPOrderStatistics.

virtual void vtkOrderStatistics::SetNumericType ( int  )
virtual

Set/get whether histograms and assessment data should be treated as numeric data. Otherwise, then everything is treated as strings, which always works, and is thus the the default. Note that if the data is indeed numeric but this is not set, some strange results will occur because of the use of the lexicographic order instead of the order on reals.

virtual int vtkOrderStatistics::GetNumericType ( )
virtual

Set/get whether histograms and assessment data should be treated as numeric data. Otherwise, then everything is treated as strings, which always works, and is thus the the default. Note that if the data is indeed numeric but this is not set, some strange results will occur because of the use of the lexicographic order instead of the order on reals.

virtual void vtkOrderStatistics::NumericTypeOn ( )
virtual

Set/get whether histograms and assessment data should be treated as numeric data. Otherwise, then everything is treated as strings, which always works, and is thus the the default. Note that if the data is indeed numeric but this is not set, some strange results will occur because of the use of the lexicographic order instead of the order on reals.

virtual void vtkOrderStatistics::NumericTypeOff ( )
virtual

Set/get whether histograms and assessment data should be treated as numeric data. Otherwise, then everything is treated as strings, which always works, and is thus the the default. Note that if the data is indeed numeric but this is not set, some strange results will occur because of the use of the lexicographic order instead of the order on reals.

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.

vtkIdType vtkOrderStatistics::GetQuantileDefinition ( )
inline

Get the quantile definition.

Definition at line 96 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 110 of file vtkOrderStatistics.h.

virtual void vtkOrderStatistics::Learn ( vtkTable inData,
vtkTable inParameters,
vtkMultiBlockDataSet outMeta 
)
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::SelectAssessFunctor ( vtkTable outData,
vtkDataObject inMeta,
vtkStringArray rowNames,
AssessFunctor *&  dfunc 
)
protectedvirtual

Provide the appropriate assessment functor.

Implements vtkStatisticsAlgorithm.


Member Data Documentation

int vtkOrderStatistics::NumericType
protected

Definition at line 145 of file vtkOrderStatistics.h.

int vtkOrderStatistics::NumberOfIntervals
protected

Definition at line 146 of file vtkOrderStatistics.h.

QuantileDefinitionType vtkOrderStatistics::QuantileDefinition
protected

Definition at line 147 of file vtkOrderStatistics.h.


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