Abstract base class for computing statistics with vtkStatistics. More...

#include <vtkSciVizStatistics.h>

Inheritance diagram for vtkSciVizStatistics:

[legend]

Collaboration diagram for vtkSciVizStatistics:

[legend]

Public Types
enum	Tasks { MODEL_INPUT, CREATE_MODEL, ASSESS_INPUT, MODEL_AND_ASSESS }
	Possible tasks the filter can perform. More...

typedef vtkTableAlgorithm	Superclass

Public Types inherited from vtkTableAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision

enum	DesiredOutputPrecision

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

int	GetNumberOfAttributeArrays ()
	Return the number of columns available for the current value of AttributeMode. More...

const char *	GetAttributeArrayName (int n)
	Get the name of the n-th array ffor the current value of AttributeMode. More...

int	GetAttributeArrayStatus (const char *arrName)
	Get the status of the specified array (i.e., whether or not it is a column of interest). More...

vtkInformationIntegerKey *	MULTIPLE_MODELS ()
	A key used to mark the output model data object (output port 0) when it is a multiblock of models (any of which may be multiblock dataset themselves) as opposed to a multiblock dataset containing a single model. More...


virtual int	GetAttributeMode ()
	Set/get the type of field attribute (cell, point, field) More...

virtual void	SetAttributeMode (int)
	Set/get the type of field attribute (cell, point, field) More...


void	EnableAttributeArray (const char *arrName)
	An alternate interface for preparing a selection of arrays in ParaView. More...

void	ClearAttributeArrays ()
	An alternate interface for preparing a selection of arrays in ParaView. More...


virtual void	SetTrainingFraction (double)
	Set/get the amount of data to be used for training. More...

virtual double	GetTrainingFraction ()
	Set/get the amount of data to be used for training. More...


virtual void	SetController (vtkMultiProcessController *)
	Get/Set the multiprocess controller. More...

virtual vtkMultiProcessController *	GetController ()
	Get/Set the multiprocess controller. More...


virtual void	SetTask (int)
	Set/get whether this filter should create a model of the input or assess the input or both. More...

virtual int	GetTask ()
	Set/get whether this filter should create a model of the input or assess the input or both. More...

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

vtkTable *	GetOutput ()

vtkTable *	GetOutput (int index)

void	SetInputData (vtkDataObject *obj)

void	SetInputData (int index, vtkDataObject *obj)

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 int	Update (int port, vtkInformationVector *requests)

virtual int	Update (vtkInformation *requests)

virtual int	UpdateExtent (const int extents[6])

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

void	SetUpdateExtent (int extent[6])

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

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

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

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 int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

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)

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

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

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

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

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 int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

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)

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
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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 )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

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)

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 )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

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)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

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

static vtkSciVizStatistics *	SafeDownCast (vtkObject *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 vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSciVizStatistics ()

	~vtkSciVizStatistics () override

int	FillInputPortInformation (int port, vtkInformation *info) override

int	FillOutputPortInformation (int port, vtkInformation *info) override

int	ProcessRequest (vtkInformation request, vtkInformationVector input, vtkInformationVector output) override

virtual int	RequestDataObject (vtkInformation request, vtkInformationVector input, vtkInformationVector output)

int	RequestData (vtkInformation request, vtkInformationVector input, vtkInformationVector output) override

virtual int	RequestData (vtkCompositeDataSet compDataOu, vtkCompositeDataSet compModelOu, vtkCompositeDataSet compDataIn, vtkCompositeDataSet compModelIn, vtkDataObject *singleModel)

virtual int	RequestData (vtkDataObject observationsOut, vtkDataObject modelOut, vtkDataObject observationsIn, vtkDataObject modelIn)

virtual int	PrepareFullDataTable (vtkTable table, vtkFieldData dataAttrIn)

virtual int	PrepareTrainingTable (vtkTable trainingTable, vtkTable fullDataTable, vtkIdType numObservations)

virtual int	LearnAndDerive (vtkMultiBlockDataSet model, vtkTable inData)=0
	Method subclasses must override to calculate a full model from the given input data. More...

virtual int	AssessData (vtkTable observations, vtkDataObject dataset, vtkMultiBlockDataSet *model)=0
	Method subclasses must override to assess an input table given a model of the proper type. More...

virtual vtkIdType	GetNumberOfObservationsForTraining (vtkIdType N)
	Subclasses may (but need not) override this function to guarantee that some minimum number of observations are included in the training data. More...

void	ShallowCopy (vtkDataObject out, vtkDataObject in)
	A variant of shallow copy that calls vtkDataObject::ShallowCopy() and then for composite datasets, creates clones for each leaf node that then shallow copies the fields and geometry. More...

Protected Member Functions inherited from vtkTableAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkTableAlgorithm ()

	~vtkTableAlgorithm ()

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

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

void	ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE

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)

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	SetErrorCode (unsigned long)

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

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

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
int	AttributeMode

int	Task

double	TrainingFraction

vtkSciVizStatisticsP *	P

vtkMultiProcessController *	Controller

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
	SINGLE_PRECISION

	DOUBLE_PRECISION

	DEFAULT_PRECISION

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

Abstract base class for computing statistics with vtkStatistics.

This filter either computes a statistical model of a dataset or takes such a model as its second input. Then, the model (however it is obtained) may optionally be used to assess the input dataset.

This class serves as a base class that handles table conversion, interfacing with the array selection in the ParaView user interface, and provides a simplified interface to vtkStatisticsAlgorithm.

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

Definition at line 36 of file vtkSciVizStatistics.h.

Member Typedef Documentation

◆ Superclass

typedef vtkTableAlgorithm vtkSciVizStatistics::Superclass

Definition at line 39 of file vtkSciVizStatistics.h.

Member Enumeration Documentation

◆ Tasks

enum vtkSciVizStatistics::Tasks

Possible tasks the filter can perform.

The MODEL_AND_ASSESS task is not recommended; you should never evaluate data with a model if that data was used to create the model. Doing so can result in a too-liberal estimate of model error, especially if overfitting occurs. Because we expect that MODEL_AND_ASSESS, despite being ill-advised, will be frequently used the TrainingFraction parameter has been created.

Enumerator
MODEL_INPUT	Execute Learn and Derive operations of a statistical engine on the input dataset.
CREATE_MODEL	Create a statistical model from a random subset the input dataset.
ASSESS_INPUT	Assess the input dataset using a statistical model from input port 1.
MODEL_AND_ASSESS	Create a statistical model of the input dataset and use it to assess the dataset. This is a bad idea.

Definition at line 109 of file vtkSciVizStatistics.h.

Constructor & Destructor Documentation

◆ vtkSciVizStatistics()

vtkSciVizStatistics::vtkSciVizStatistics ( )

protected

◆ ~vtkSciVizStatistics()

vtkSciVizStatistics::~vtkSciVizStatistics ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkSciVizStatistics::GetClassName ( )

virtual

Reimplemented in vtkPSciVizMultiCorrelativeStats, vtkPSciVizPCAStats, vtkPSciVizContingencyStats, vtkPSciVizKMeans, and vtkPSciVizDescriptiveStats.

◆ IsTypeOf()

static int vtkSciVizStatistics::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkSciVizStatistics::IsA ( const char * type )

virtual

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPSciVizMultiCorrelativeStats, vtkPSciVizPCAStats, vtkPSciVizContingencyStats, vtkPSciVizKMeans, and vtkPSciVizDescriptiveStats.

◆ SafeDownCast()

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

static

◆ PrintSelf()

void vtkSciVizStatistics::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkTableAlgorithm.

◆ GetAttributeMode()

virtual int vtkSciVizStatistics::GetAttributeMode ( )

virtual

Set/get the type of field attribute (cell, point, field)

◆ SetAttributeMode()

virtual void vtkSciVizStatistics::SetAttributeMode ( int )

virtual

Set/get the type of field attribute (cell, point, field)

◆ GetNumberOfAttributeArrays()

int vtkSciVizStatistics::GetNumberOfAttributeArrays ( )

Return the number of columns available for the current value of AttributeMode.

◆ GetAttributeArrayName()

const char* vtkSciVizStatistics::GetAttributeArrayName ( int n )

Get the name of the n-th array ffor the current value of AttributeMode.

◆ GetAttributeArrayStatus()

int vtkSciVizStatistics::GetAttributeArrayStatus ( const char * arrName )

Get the status of the specified array (i.e., whether or not it is a column of interest).

◆ EnableAttributeArray()

void vtkSciVizStatistics::EnableAttributeArray ( const char * arrName )

An alternate interface for preparing a selection of arrays in ParaView.

◆ ClearAttributeArrays()

void vtkSciVizStatistics::ClearAttributeArrays ( )

An alternate interface for preparing a selection of arrays in ParaView.

◆ SetTrainingFraction()

virtual void vtkSciVizStatistics::SetTrainingFraction ( double )

virtual

Set/get the amount of data to be used for training.

When 0.0 < TrainingFraction < 1.0, a randomly-sampled subset of the data is used for training. When an assessment is requested, all data (including the training data) is assessed, regardless of the value of TrainingFraction. The default value is 0.1.

The random sample of the original dataset (say, of size N) is obtained by choosing N random numbers in [0,1). Any sample where the random number is less than TrainingFraction is included in the training data. Samples are then randomly added or removed from the training data until it is the desired size.

◆ GetTrainingFraction()

virtual double vtkSciVizStatistics::GetTrainingFraction ( )

virtual

Set/get the amount of data to be used for training.

When 0.0 < TrainingFraction < 1.0, a randomly-sampled subset of the data is used for training. When an assessment is requested, all data (including the training data) is assessed, regardless of the value of TrainingFraction. The default value is 0.1.

The random sample of the original dataset (say, of size N) is obtained by choosing N random numbers in [0,1). Any sample where the random number is less than TrainingFraction is included in the training data. Samples are then randomly added or removed from the training data until it is the desired size.

◆ SetController()

virtual void vtkSciVizStatistics::SetController ( vtkMultiProcessController * )

virtual

Get/Set the multiprocess controller.

If no controller is set, single process is assumed.

◆ GetController()

virtual vtkMultiProcessController* vtkSciVizStatistics::GetController ( )

virtual

Get/Set the multiprocess controller.

If no controller is set, single process is assumed.

◆ SetTask()

virtual void vtkSciVizStatistics::SetTask ( int )

virtual

Set/get whether this filter should create a model of the input or assess the input or both.

This should take on a value from the Tasks enum. The default is MODEL_AND_ASSESS.

◆ GetTask()

virtual int vtkSciVizStatistics::GetTask ( )

virtual

Set/get whether this filter should create a model of the input or assess the input or both.

This should take on a value from the Tasks enum. The default is MODEL_AND_ASSESS.

◆ MULTIPLE_MODELS()

vtkInformationIntegerKey* vtkSciVizStatistics::MULTIPLE_MODELS ( )

A key used to mark the output model data object (output port 0) when it is a multiblock of models (any of which may be multiblock dataset themselves) as opposed to a multiblock dataset containing a single model.

◆ FillInputPortInformation()

int vtkSciVizStatistics::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotectedvirtual

Reimplemented from vtkTableAlgorithm.

◆ FillOutputPortInformation()

int vtkSciVizStatistics::FillOutputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotectedvirtual

Reimplemented from vtkTableAlgorithm.

◆ ProcessRequest()

int vtkSciVizStatistics::ProcessRequest	(	vtkInformation *	request,
		vtkInformationVector **	input,
		vtkInformationVector *	output
	)

overrideprotectedvirtual

Reimplemented from vtkTableAlgorithm.

◆ RequestDataObject()

virtual int vtkSciVizStatistics::RequestDataObject	(	vtkInformation *	request,
		vtkInformationVector **	input,
		vtkInformationVector *	output
	)

protectedvirtual

◆ RequestData() [1/3]

int vtkSciVizStatistics::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	input,
		vtkInformationVector *	output
	)

overrideprotectedvirtual

Reimplemented from vtkTableAlgorithm.

◆ RequestData() [2/3]

virtual int vtkSciVizStatistics::RequestData	(	vtkCompositeDataSet *	compDataOu,
		vtkCompositeDataSet *	compModelOu,
		vtkCompositeDataSet *	compDataIn,
		vtkCompositeDataSet *	compModelIn,
		vtkDataObject *	singleModel
	)

protectedvirtual

◆ RequestData() [3/3]

virtual int vtkSciVizStatistics::RequestData	(	vtkDataObject *	observationsOut,
		vtkDataObject *	modelOut,
		vtkDataObject *	observationsIn,
		vtkDataObject *	modelIn
	)

protectedvirtual

◆ PrepareFullDataTable()

virtual int vtkSciVizStatistics::PrepareFullDataTable	(	vtkTable *	table,
		vtkFieldData *	dataAttrIn
	)

protectedvirtual

◆ PrepareTrainingTable()

virtual int vtkSciVizStatistics::PrepareTrainingTable	(	vtkTable *	trainingTable,
		vtkTable *	fullDataTable,
		vtkIdType	numObservations
	)

protectedvirtual

◆ LearnAndDerive()

virtual int vtkSciVizStatistics::LearnAndDerive	(	vtkMultiBlockDataSet *	model,
		vtkTable *	inData
	)

protectedpure virtual

Method subclasses must override to calculate a full model from the given input data.

The model should be placed on the first output port of the passed vtkInformationVector as well as returned in the model parameter.

Implemented in vtkPSciVizMultiCorrelativeStats, vtkPSciVizKMeans, vtkPSciVizPCAStats, vtkPSciVizContingencyStats, and vtkPSciVizDescriptiveStats.

◆ AssessData()

virtual int vtkSciVizStatistics::AssessData	(	vtkTable *	observations,
		vtkDataObject *	dataset,
		vtkMultiBlockDataSet *	model
	)

protectedpure virtual

Method subclasses must override to assess an input table given a model of the proper type.

The dataset parameter contains a shallow copy of input port 0 and should be modified to include the assessment.

Adding new arrays to point/cell/vertex/edge data should not pose a problem, but any alterations to the dataset itself will probably require that you create a deep copy before modification.

Parameters

observations	- a table containing the field data of the dataset converted to a table
dataset	- a shallow copy of the input dataset that should be altered to include an assessment of the output.
model	- the statistical model with which to assess the observations.

Implemented in vtkPSciVizMultiCorrelativeStats, vtkPSciVizKMeans, vtkPSciVizPCAStats, vtkPSciVizContingencyStats, and vtkPSciVizDescriptiveStats.

◆ GetNumberOfObservationsForTraining()

virtual vtkIdType vtkSciVizStatistics::GetNumberOfObservationsForTraining ( vtkIdType N )

protectedvirtual

Subclasses may (but need not) override this function to guarantee that some minimum number of observations are included in the training data.

By default, it returns the maximum of: observations->GetNumberOfRows() * this->TrainingFraction and min( observations->GetNumberOfRows(), 100 ). Thus, it will require the entire set of observations unless there are more than 100. Parameter N is the number of non-ghost observations.

◆ ShallowCopy()

void vtkSciVizStatistics::ShallowCopy	(	vtkDataObject *	out,
		vtkDataObject *	in
	)

protected

A variant of shallow copy that calls vtkDataObject::ShallowCopy() and then for composite datasets, creates clones for each leaf node that then shallow copies the fields and geometry.

Member Data Documentation

◆ AttributeMode

int vtkSciVizStatistics::AttributeMode

protected

Definition at line 200 of file vtkSciVizStatistics.h.

◆ Task

int vtkSciVizStatistics::Task

protected

Definition at line 201 of file vtkSciVizStatistics.h.

◆ TrainingFraction

double vtkSciVizStatistics::TrainingFraction

protected

Definition at line 202 of file vtkSciVizStatistics.h.

◆ P

vtkSciVizStatisticsP* vtkSciVizStatistics::P

protected

Definition at line 203 of file vtkSciVizStatistics.h.

◆ Controller

vtkMultiProcessController* vtkSciVizStatistics::Controller

protected

Definition at line 204 of file vtkSciVizStatistics.h.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/FiltersStatistics/vtkSciVizStatistics.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ Tasks

Constructor & Destructor Documentation

◆ vtkSciVizStatistics()

◆ ~vtkSciVizStatistics()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetAttributeMode()

◆ SetAttributeMode()

◆ GetNumberOfAttributeArrays()

◆ GetAttributeArrayName()

◆ GetAttributeArrayStatus()

◆ EnableAttributeArray()

◆ ClearAttributeArrays()

◆ SetTrainingFraction()

◆ GetTrainingFraction()

◆ SetController()

◆ GetController()

◆ SetTask()

◆ GetTask()

◆ MULTIPLE_MODELS()

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ ProcessRequest()

◆ RequestDataObject()

◆ RequestData() [1/3]

◆ RequestData() [2/3]

◆ RequestData() [3/3]

◆ PrepareFullDataTable()

◆ PrepareTrainingTable()

◆ LearnAndDerive()

◆ AssessData()

◆ GetNumberOfObservationsForTraining()

◆ ShallowCopy()

Member Data Documentation

◆ AttributeMode

◆ Task

◆ TrainingFraction

◆ P

◆ Controller