A class for univariate order statistics. More...

#include <vtkOrderStatistics.h>

Inheritance diagram for vtkOrderStatistics:

Collaboration diagram for vtkOrderStatistics:

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, OUTPUT_TEST = 2 }

Public Types inherited from vtkTableAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkOrderStatistics *	NewInstance () 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
vtkStatisticsAlgorithm *	NewInstance () 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)

Public Member Functions inherited from vtkTableAlgorithm
vtkTableAlgorithm *	NewInstance () const

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

vtkTable *	GetOutput ()

vtkTable *	GetOutput (int index)

void	SetInputData (vtkDataObject *obj)

void	SetInputData (int index, vtkDataObject *obj)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

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)

vtkDataObject *	GetInputDataObject (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)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool 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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)

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 vtkOrderStatistics *	SafeDownCast (vtkObjectBase *o)

static vtkOrderStatistics *	New ()

Static Public Member Functions inherited from vtkStatisticsAlgorithm
static int	IsTypeOf (const char *type)

static vtkStatisticsAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkTableAlgorithm
static vtkTableAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkTableAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

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 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 vtkExecutive *	CreateDefaultExecutive ()

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)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *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 &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkIdType	NumberOfIntervals

QuantileDefinitionType	QuantileDefinition

bool	Quantize

vtkIdType	MaximumHistogramSize

Protected Attributes inherited from vtkStatisticsAlgorithm
vtkIdType	NumberOfPrimaryTables

bool	LearnOption

bool	DeriveOption

bool	AssessOption

bool	TestOption

vtkStringArray *	AssessNames

vtkStatisticsAlgorithmPrivate *	Internals

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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

typedef vtkStatisticsAlgorithm vtkOrderStatistics::Superclass

Definition at line 62 of file vtkOrderStatistics.h.

Member Enumeration Documentation

enum vtkOrderStatistics::QuantileDefinitionType

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

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
	)

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

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.