Base class for statistics algorithms. More...

#include <vtkStatisticsAlgorithm.h>

Inheritance diagram for vtkStatisticsAlgorithm:

Collaboration diagram for vtkStatisticsAlgorithm:

Classes
class	AssessFunctor
	A base class for a functor that assesses data. More...

Public Types
enum	InputPorts { INPUT_DATA = 0 , LEARN_PARAMETERS = 1 , INPUT_MODEL = 2 }
	enumeration values to specify input port types More...

enum	OutputIndices { OUTPUT_DATA = 0 , OUTPUT_MODEL = 1 , OUTPUT_TEST = 2 }
	enumeration values to specify output port types More...

typedef vtkTableAlgorithm	Superclass

Public Types inherited from vtkTableAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkStatisticsAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetLearnOptionParameterConnection (vtkAlgorithmOutput *params)
	A convenience method for setting learn input parameters (if one is expected or allowed).

virtual void	SetLearnOptionParameters (vtkDataObject *params)
	A convenience method for setting learn input parameters (if one is expected or allowed).

virtual void	SetInputModelConnection (vtkAlgorithmOutput *model)
	A convenience method for setting the input model connection (if one is expected or allowed).

virtual void	SetInputModel (vtkDataObject *model)
	A convenience method for setting the input model (if one is expected or allowed).

virtual vtkStatisticalModel *	GetOutputModel ()
	A convenience method for fetching an output model that returns the proper type so downcasting is not required.

virtual int	GetMaximumNumberOfColumnsPerRequest () const
	Provide a limit on the number of columns per request for this algorithm subclass.

virtual void	SetColumnStatus (const char *namCol, int status)
	Add or remove a column from the current analysis request.

virtual void	ResetAllColumnStates ()
	Set the status of each and every column in the current request to OFF (0).

virtual int	RequestSelectedColumns ()
	Use the current column status values to produce a new request for statistics to be produced when RequestData() is called.

virtual void	ResetRequests ()
	Empty the list of current requests.

virtual vtkIdType	GetNumberOfRequests ()
	Return the number of requests.

virtual vtkIdType	GetNumberOfColumnsForRequest (vtkIdType request)
	Return the number of columns for a given request.

virtual const char *	GetColumnForRequest (vtkIdType r, vtkIdType c)
	Provide the name of the c-th column for the r-th request.

virtual int	GetColumnForRequest (vtkIdType r, vtkIdType c, vtkStdString &columnName)

void	AddColumn (const char *namCol)
	Convenience method to create a request with a single column name `namCol` in a single call; this is the preferred method to select columns, ensuring selection consistency (a single column per request).

void	AddColumnPair (const char namColX, const char namColY)
	Convenience method to create a request with a single column name pair (`namColX`, `namColY`) in a single call; this is the preferred method to select columns pairs, ensuring selection consistency (a pair of columns per request).

virtual bool	SetParameter (const char *parameter, int index, vtkVariant value)
	A convenience method (in particular for access from other applications) to set parameter values of Learn mode.

virtual bool	Aggregate (vtkDataObjectCollection collection, vtkStatisticalModel model)=0
	Given a collection of models, calculate an aggregate model.


virtual void	SetLearnOption (bool)
	Set/Get the Learn operation.

virtual bool	GetLearnOption ()
	Set/Get the Learn operation.

virtual void	LearnOptionOn ()
	Set/Get the Learn operation.

virtual void	LearnOptionOff ()
	Set/Get the Learn operation.


virtual void	SetDeriveOption (bool)
	Set/Get the Derive operation.

virtual bool	GetDeriveOption ()
	Set/Get the Derive operation.

virtual void	DeriveOptionOn ()
	Set/Get the Derive operation.

virtual void	DeriveOptionOff ()
	Set/Get the Derive operation.


virtual void	SetAssessOption (bool)
	Set/Get the Assess operation.

virtual bool	GetAssessOption ()
	Set/Get the Assess operation.

virtual void	AssessOptionOn ()
	Set/Get the Assess operation.

virtual void	AssessOptionOff ()
	Set/Get the Assess operation.


virtual void	SetTestOption (bool)
	Set/Get the Test operation.

virtual bool	GetTestOption ()
	Set/Get the Test operation.

virtual void	TestOptionOn ()
	Set/Get the Test operation.

virtual void	TestOptionOff ()
	Set/Get the Test operation.


virtual void	SetNumberOfPrimaryTables (vtkIdType)
	Set/Get the number of tables in the primary model.

virtual vtkIdType	GetNumberOfPrimaryTables ()
	Set/Get the number of tables in the primary model.


virtual void	SetAssessNames (vtkStringArray *)
	Set/get assessment names.

virtual vtkStringArray *	GetAssessNames ()
	Set/get assessment names.


bool	CopyRequests (vtkStatisticsAlgorithmPrivate *requests)
	Copy requests for analysis from another container into this algorithm.


virtual void	SetGhostsToSkip (unsigned char)
	If there is a ghost array in the input, then ghosts matching `GhostsToSkip` mask will be skipped.

virtual unsigned char	GetGhostsToSkip ()
	If there is a ghost array in the input, then ghosts matching `GhostsToSkip` mask will be skipped.


virtual void	SetSkipInvalidValues (bool)
	If set, invalid values (NaN or, depending on the circumstances, positive and negative infinity) should cause input samples to be skipped during the Learn phase (i.e., the construction of a model).

virtual bool	GetSkipInvalidValues ()
	If set, invalid values (NaN or, depending on the circumstances, positive and negative infinity) should cause input samples to be skipped during the Learn phase (i.e., the construction of a model).

virtual void	SkipInvalidValuesOn ()
	If set, invalid values (NaN or, depending on the circumstances, positive and negative infinity) should cause input samples to be skipped during the Learn phase (i.e., the construction of a model).

virtual void	SkipInvalidValuesOff ()
	If set, invalid values (NaN or, depending on the circumstances, positive and negative infinity) should cause input samples to be skipped during the Learn phase (i.e., the construction of a model).


virtual std::string	GetAlgorithmParameters () const
	Provide a serialization of this object's internal state so it can be recreated by a vtkStatisticalModel as needed.

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

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	see vtkAlgorithm for details

vtkTable *	GetOutput ()
	Get the output data object for a port on this algorithm.

vtkTable *	GetOutput (int index)

void	SetInputData (vtkDataObject *obj)
	Assign a data object as input.

void	SetInputData (int index, vtkDataObject *obj)

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

vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.

void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.

void	UpdateProgress (double amount)
	Update the progress of the process object.

bool	CheckAbort ()
	Checks to see if this filter should abort.

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.

int	GetNumberOfInputArraySpecifications ()
	Get the number of input array indices that have already been set.

bool	ResetInputArraySpecifications ()
	Clear all existing input array specifications (as if SetInputArrayToProcess had never been called).

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.

virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date.

virtual void	UpdateDataObject ()
	Create output object(s).

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()` to all output ports of this `vtkAlgorithm`.

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.

bool	UsesGarbageCollector () const override
	Participate in garbage collection.

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.

virtual double	GetProgress ()
	Get the execution progress of a process object.

void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.

vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.

virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.

virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.

void	SetInputArrayToProcess (const char *name, int fieldAssociation, int component=vtkArrayComponents::AllComponents)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name, int component)
	This method variant also accepts a component to consider rather than the entire tuple.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType, int component)
	This method variant also accepts a component to consider rather than the entire tuple.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName, const char *component)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual void	Update ()
	Bring this algorithm's outputs up-to-date.

virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.

virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

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

static vtkStatisticsAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkTableAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

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 ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

static vtkInformationIntegerKey *	ABORTED ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

Protected Member Functions inherited from vtkTableAlgorithm
	vtkTableAlgorithm ()

	~vtkTableAlgorithm () override

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

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm () override

bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

int	GetInputArrayComponent (int idx)
	Get the component to process of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkSmartPointer< vtkAbstractArray >	GetInputArray (int idx, int connection, vtkInformationVector **inputVector, int &association, int requestedComponent=vtkArrayComponents::Requested)
	Get an array from the input at index idx.

vtkSmartPointer< vtkAbstractArray >	GetInputArray (int idx, vtkDataObject *input, int &association, int requestedComponent=vtkArrayComponents::Requested)
	Get an array from the input at index idx.

template<typename ArrayType, typename... Params>
vtkSmartPointer< ArrayType >	GetInputArrayAs (Params &&... params)
	Get an array from the input at index idx.

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static std::size_t	ConsumeDouble (const std::string &source, double &value)
	Turn tuples (or respectively tuples of tuples) of numbers into a vector (or respectively a vector of vectors) of doubles, returning the number of bytes consumed.

static std::size_t	ConsumeDoubleTuple (const std::string &source, std::vector< double > &tuple)

static std::size_t	ConsumeDoubleTuples (const std::string &source, std::vector< std::vector< double > > &tuple)

static std::size_t	ConsumeStringToDoublesMap (const std::string &source, std::map< std::string, std::vector< double > > &map)

static std::size_t	ConsumeInt (const std::string &source, int &value)
	Turn a string holding an integer value into an integer, returning the number of bytes consumed by the integer.

static AlgorithmConstructorMap &	GetConstructorMap ()
	Return a map of registered algorithm types.

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

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkIdType	NumberOfPrimaryTables

bool	LearnOption

bool	DeriveOption

bool	AssessOption

bool	TestOption

vtkStringArray *	AssessNames

unsigned char	GhostsToSkip

vtkIdType	NumberOfGhosts

bool	SkipInvalidValues

vtkStatisticsAlgorithmPrivate *	Internals

Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime

vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

using	AlgorithmConstructor = std::function<vtkSmartPointer<vtkStatisticsAlgorithm>()>
	Return a new instance of a subclass named and configured by the algorithmParameters.

using	AlgorithmConstructorMap = std::unordered_map<vtkStringToken, AlgorithmConstructor>
	Return a new instance of a subclass named and configured by the algorithmParameters.

static vtkSmartPointer< vtkStatisticsAlgorithm >	NewFromAlgorithmParameters (const std::string &algorithmParameters)
	Return a new instance of a subclass named and configured by the algorithmParameters.

template<typename Algorithm>
static void	RegisterAlgorithm ()
	Register a subclass of this algorithm.

	vtkStatisticsAlgorithm ()
	Return a new instance of a subclass named and configured by the algorithmParameters.

	~vtkStatisticsAlgorithm () override
	Return a new instance of a subclass named and configured by the algorithmParameters.

virtual bool	ConfigureFromAlgorithmParameters (const std::string &algorithmParameters)
	Loop over algorithmParameters until all are consumed or an error occurs.

virtual void	AppendAlgorithmParameters (std::string &algorithmParameters) const
	Subclasses must override this method if they have any internal ivars that affect the behavior of RequestData (specifically Learn/Derive at this point).

virtual std::size_t	ConsumeNextAlgorithmParameter (vtkStringToken parameterName, const std::string &algorithmParameters)
	Consume a single parameter value, setting the value on this instance of the class.

int	FillInputPortInformation (int port, vtkInformation *info) override
	Return a new instance of a subclass named and configured by the algorithmParameters.

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Return a new instance of a subclass named and configured by the algorithmParameters.

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	Return a new instance of a subclass named and configured by the algorithmParameters.

virtual void	Learn (vtkTable , vtkTable , vtkStatisticalModel *)=0
	Execute the calculations required by the Learn option, given some input Data.

virtual void	Derive (vtkStatisticalModel *)=0
	Execute the calculations required by the Derive option.

virtual void	Assess (vtkTable , vtkStatisticalModel , vtkTable *)=0
	Execute the calculations required by the Assess option.

void	Assess (vtkTable , vtkStatisticalModel , vtkTable *, int)
	A convenience implementation for generic assessment with variable number of variables.

virtual void	Test (vtkTable , vtkStatisticalModel , vtkTable *)=0
	Execute the calculations required by the Test option.

virtual void	SelectAssessFunctor (vtkTable outData, vtkDataObject inMeta, vtkStringArray rowNames, AssessFunctor &dfunc)=0
	A pure virtual method to select the appropriate assessment functor.

static std::size_t	ConsumeString (const std::string &source, std::string &value)
	Turn a quoted string value into std::string, returning the number of bytes consumed.

static std::size_t	ConsumeStringTuple (const std::string &source, std::vector< std::string > &tuple)
	Turn a tuple of strings into a vtkStringArray, returning the number of bytes consumed.

static std::size_t	ConsumeStringTuple (const std::string &source, vtkStringArray *tuple)
	Return a new instance of a subclass named and configured by the algorithmParameters.

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Base class for statistics algorithms.

All statistics algorithms can conceptually be operated with several operations:

Learn: given an input data set, calculate a minimal statistical model (e.g., sums, raw moments, joint probabilities).
Derive: given an input minimal statistical model, derive the full model (e.g., descriptive statistics, quantiles, correlations, conditional probabilities). NB: It may be, or not be, a problem that a full model was not derived. For instance, when doing parallel calculations, one only wants to derive the full model after all partial calculations have completed. On the other hand, one can also directly provide a full model, that was previously calculated or guessed, and not derive a new one.
Assess: given an input data set, input statistics, and some form of threshold, assess a subset of the data set.
Test: perform at least one statistical test. Therefore, a vtkStatisticsAlgorithm has the following ports
3 optional input ports:
- Data (vtkTable)
- Parameters to the learn operation (vtkTable)
- Input model (vtkStatisticalModel)
3 output ports:
- Data (input annotated with assessments when the Assess operation is ON).
- Output model (identical to the input model when Learn operation is OFF).
- Output of statistical tests. Some engines do not offer such tests yet, in which case this output will always be empty even when the Test operation is ON.

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

Online Examples:

Tests:: vtkStatisticsAlgorithm (Tests)

Definition at line 122 of file vtkStatisticsAlgorithm.h.

Member Typedef Documentation

◆ Superclass

typedef vtkTableAlgorithm vtkStatisticsAlgorithm::Superclass

Definition at line 125 of file vtkStatisticsAlgorithm.h.

◆ AlgorithmConstructor

using vtkStatisticsAlgorithm::AlgorithmConstructor = std::function<vtkSmartPointer<vtkStatisticsAlgorithm>()>

protected

Return a new instance of a subclass named and configured by the algorithmParameters.

This will return a null object for unknown subclasses (not registered with the VTK object factory.

If VTK's serialization-deserialization (SerDes) support ever becomes mandatory, this method should be replaced with it.

Definition at line 464 of file vtkStatisticsAlgorithm.h.

◆ AlgorithmConstructorMap

using vtkStatisticsAlgorithm::AlgorithmConstructorMap = std::unordered_map<vtkStringToken, AlgorithmConstructor>

protected

Return a new instance of a subclass named and configured by the algorithmParameters.

This will return a null object for unknown subclasses (not registered with the VTK object factory.

If VTK's serialization-deserialization (SerDes) support ever becomes mandatory, this method should be replaced with it.

Definition at line 465 of file vtkStatisticsAlgorithm.h.

Member Enumeration Documentation

◆ InputPorts

enum vtkStatisticsAlgorithm::InputPorts

enumeration values to specify input port types

Enumerator
INPUT_DATA	Port 0 is for learn data.
LEARN_PARAMETERS	Port 1 is for learn parameters (initial guesses, etc.)
INPUT_MODEL	Port 2 is for a priori models.

Definition at line 131 of file vtkStatisticsAlgorithm.h.

◆ OutputIndices

enum vtkStatisticsAlgorithm::OutputIndices

enumeration values to specify output port types

Enumerator
OUTPUT_DATA	Output 0 mirrors the input data, plus optional assessment columns.
OUTPUT_MODEL	Output 1 contains any generated model.
OUTPUT_TEST	Output 2 contains result of statistical test(s)

Definition at line 141 of file vtkStatisticsAlgorithm.h.

Constructor & Destructor Documentation

◆ vtkStatisticsAlgorithm()

vtkStatisticsAlgorithm::vtkStatisticsAlgorithm ( )

protected

Return a new instance of a subclass named and configured by the algorithmParameters.

This will return a null object for unknown subclasses (not registered with the VTK object factory.

If VTK's serialization-deserialization (SerDes) support ever becomes mandatory, this method should be replaced with it.

◆ ~vtkStatisticsAlgorithm()

vtkStatisticsAlgorithm::~vtkStatisticsAlgorithm ( )

overrideprotected

Return a new instance of a subclass named and configured by the algorithmParameters.

This will return a null object for unknown subclasses (not registered with the VTK object factory.

If VTK's serialization-deserialization (SerDes) support ever becomes mandatory, this method should be replaced with it.

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkStatisticsAlgorithm::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkStatisticsAlgorithm::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 vtkTableAlgorithm.

Reimplemented in vtkAutoCorrelativeStatistics, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkExtractHistogram2D, vtkHighestDensityRegionsStatistics, vtkKMeansStatistics, vtkMultiCorrelativeStatistics, vtkOrderStatistics, vtkPairwiseExtractHistogram2D, vtkPAutoCorrelativeStatistics, vtkPCAStatistics, vtkPContingencyStatistics, vtkPCorrelativeStatistics, vtkPDescriptiveStatistics, vtkPExtractHistogram2D, vtkPKMeansStatistics, vtkPMultiCorrelativeStatistics, vtkPOrderStatistics, vtkPPairwiseExtractHistogram2D, vtkPPCAStatistics, and vtkVisualStatistics.

◆ SafeDownCast()

static vtkStatisticsAlgorithm * vtkStatisticsAlgorithm::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkStatisticsAlgorithm::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkStatisticsAlgorithm * vtkStatisticsAlgorithm::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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

Reimplemented in vtkVisualStatistics.

◆ SetLearnOptionParameterConnection()

virtual void vtkStatisticsAlgorithm::SetLearnOptionParameterConnection ( vtkAlgorithmOutput * params )

inlinevirtual

A convenience method for setting learn input parameters (if one is expected or allowed).

It is equivalent to calling SetInputConnection( 1, params );

Definition at line 152 of file vtkStatisticsAlgorithm.h.

◆ SetLearnOptionParameters()

virtual void vtkStatisticsAlgorithm::SetLearnOptionParameters ( vtkDataObject * params )

inlinevirtual

A convenience method for setting learn input parameters (if one is expected or allowed).

It is equivalent to calling SetInputData( 1, params );

Definition at line 161 of file vtkStatisticsAlgorithm.h.

◆ SetInputModelConnection()

virtual void vtkStatisticsAlgorithm::SetInputModelConnection ( vtkAlgorithmOutput * model )

inlinevirtual

A convenience method for setting the input model connection (if one is expected or allowed).

It is equivalent to calling SetInputConnection( 2, model );

Definition at line 170 of file vtkStatisticsAlgorithm.h.

◆ SetInputModel()

virtual void vtkStatisticsAlgorithm::SetInputModel ( vtkDataObject * model )

inlinevirtual

A convenience method for setting the input model (if one is expected or allowed).

It is equivalent to calling SetInputData( 2, model );

Definition at line 179 of file vtkStatisticsAlgorithm.h.

◆ GetOutputModel()

virtual vtkStatisticalModel * vtkStatisticsAlgorithm::GetOutputModel ( )

virtual

A convenience method for fetching an output model that returns the proper type so downcasting is not required.

◆ SetLearnOption()

virtual void vtkStatisticsAlgorithm::SetLearnOption ( bool )

virtual

Set/Get the Learn operation.

◆ GetLearnOption()

virtual bool vtkStatisticsAlgorithm::GetLearnOption ( )

virtual

Set/Get the Learn operation.

◆ LearnOptionOn()

virtual void vtkStatisticsAlgorithm::LearnOptionOn ( )

virtual

Set/Get the Learn operation.

◆ LearnOptionOff()

virtual void vtkStatisticsAlgorithm::LearnOptionOff ( )

virtual

Set/Get the Learn operation.

◆ SetDeriveOption()

virtual void vtkStatisticsAlgorithm::SetDeriveOption ( bool )

virtual

Set/Get the Derive operation.

◆ GetDeriveOption()

virtual bool vtkStatisticsAlgorithm::GetDeriveOption ( )

virtual

Set/Get the Derive operation.

◆ DeriveOptionOn()

virtual void vtkStatisticsAlgorithm::DeriveOptionOn ( )

virtual

Set/Get the Derive operation.

◆ DeriveOptionOff()

virtual void vtkStatisticsAlgorithm::DeriveOptionOff ( )

virtual

Set/Get the Derive operation.

◆ SetAssessOption()

virtual void vtkStatisticsAlgorithm::SetAssessOption ( bool )

virtual

Set/Get the Assess operation.

◆ GetAssessOption()

virtual bool vtkStatisticsAlgorithm::GetAssessOption ( )

virtual

Set/Get the Assess operation.

◆ AssessOptionOn()

virtual void vtkStatisticsAlgorithm::AssessOptionOn ( )

virtual

Set/Get the Assess operation.

◆ AssessOptionOff()

virtual void vtkStatisticsAlgorithm::AssessOptionOff ( )

virtual

Set/Get the Assess operation.

◆ SetTestOption()

virtual void vtkStatisticsAlgorithm::SetTestOption ( bool )

virtual

Set/Get the Test operation.

◆ GetTestOption()

virtual bool vtkStatisticsAlgorithm::GetTestOption ( )

virtual

Set/Get the Test operation.

◆ TestOptionOn()

virtual void vtkStatisticsAlgorithm::TestOptionOn ( )

virtual

Set/Get the Test operation.

◆ TestOptionOff()

virtual void vtkStatisticsAlgorithm::TestOptionOff ( )

virtual

Set/Get the Test operation.

◆ SetNumberOfPrimaryTables()

virtual void vtkStatisticsAlgorithm::SetNumberOfPrimaryTables ( vtkIdType )

virtual

Set/Get the number of tables in the primary model.

◆ GetNumberOfPrimaryTables()

virtual vtkIdType vtkStatisticsAlgorithm::GetNumberOfPrimaryTables ( )

virtual

Set/Get the number of tables in the primary model.

◆ SetAssessNames()

virtual void vtkStatisticsAlgorithm::SetAssessNames ( vtkStringArray * )

virtual

Set/get assessment names.

◆ GetAssessNames()

virtual vtkStringArray * vtkStatisticsAlgorithm::GetAssessNames ( )

virtual

Set/get assessment names.

◆ GetMaximumNumberOfColumnsPerRequest()

virtual int vtkStatisticsAlgorithm::GetMaximumNumberOfColumnsPerRequest ( ) const

inlinevirtual

Provide a limit on the number of columns per request for this algorithm subclass.

Subclasses may override if they require requests to have N or fewer columns per request. This is used by other filters (such as vtkGenerateStatistics) to decide how to configure an algorithm when more columns have been specified than are supported. The result of this call is not used by this class or its subclasses; it is provided solely for other filters and user interfaces.

A value of 0 indicates no limit on the number of columns per request.

Reimplemented in vtkAutoCorrelativeStatistics, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkExtractHistogram2D, vtkHighestDensityRegionsStatistics, vtkOrderStatistics, and vtkPairwiseExtractHistogram2D.

Definition at line 265 of file vtkStatisticsAlgorithm.h.

◆ SetColumnStatus()

virtual void vtkStatisticsAlgorithm::SetColumnStatus	(	const char *	namCol,
		int	status )

virtual

Add or remove a column from the current analysis request.

Once all the column status values are set, call RequestSelectedColumns() before selecting another set of columns for a different analysis request. The way that columns selections are used varies from algorithm to algorithm.

Note: the set of selected columns is maintained in vtkStatisticsAlgorithmPrivate::Buffer until RequestSelectedColumns() is called, at which point the set is appended to vtkStatisticsAlgorithmPrivate::Requests. If there are any columns in vtkStatisticsAlgorithmPrivate::Buffer at the time RequestData() is called, RequestSelectedColumns() will be called and the selection added to the list of requests.

◆ ResetAllColumnStates()

virtual void vtkStatisticsAlgorithm::ResetAllColumnStates ( )

virtual

Set the status of each and every column in the current request to OFF (0).

◆ RequestSelectedColumns()

virtual int vtkStatisticsAlgorithm::RequestSelectedColumns ( )

virtual

Use the current column status values to produce a new request for statistics to be produced when RequestData() is called.

See SetColumnStatus() for more information.

◆ ResetRequests()

virtual void vtkStatisticsAlgorithm::ResetRequests ( )

virtual

Empty the list of current requests.

◆ GetNumberOfRequests()

virtual vtkIdType vtkStatisticsAlgorithm::GetNumberOfRequests ( )

virtual

Return the number of requests.

This does not include any request that is in the column-status buffer but for which RequestSelectedColumns() has not yet been called (even though it is possible this request will be honored when the filter is run – see SetColumnStatus() for more information).

◆ GetNumberOfColumnsForRequest()

virtual vtkIdType vtkStatisticsAlgorithm::GetNumberOfColumnsForRequest ( vtkIdType request )

virtual

Return the number of columns for a given request.

◆ GetColumnForRequest() [1/2]

virtual const char * vtkStatisticsAlgorithm::GetColumnForRequest	(	vtkIdType	r,
		vtkIdType	c )

virtual

Provide the name of the c-th column for the r-th request.

For the version of this routine that returns an integer, if the request or column does not exist because r or c is out of bounds, this routine returns 0 and the value of columnName is unspecified. Otherwise, it returns 1 and the value of columnName is set.

For the version of this routine that returns const char*, if the request or column does not exist because r or c is out of bounds, the routine returns nullptr. Otherwise it returns the column name. This version is not thread-safe.

◆ GetColumnForRequest() [2/2]

virtual int vtkStatisticsAlgorithm::GetColumnForRequest	(	vtkIdType	r,
		vtkIdType	c,
		vtkStdString &	columnName )

virtual

◆ AddColumn()

void vtkStatisticsAlgorithm::AddColumn ( const char * namCol )

Convenience method to create a request with a single column name namCol in a single call; this is the preferred method to select columns, ensuring selection consistency (a single column per request).

Warning: no name checking is performed on namCol; it is the user's responsibility to use valid column names.

◆ AddColumnPair()

void vtkStatisticsAlgorithm::AddColumnPair	(	const char *	namColX,
		const char *	namColY )

Convenience method to create a request with a single column name pair (namColX, namColY) in a single call; this is the preferred method to select columns pairs, ensuring selection consistency (a pair of columns per request).

Unlike SetColumnStatus(), you need not call RequestSelectedColumns() after AddColumnPair().

Warning: namColX and namColY are only checked for their validity as strings; no check is made that either are valid column names.

◆ SetParameter()

virtual bool vtkStatisticsAlgorithm::SetParameter	(	const char *	parameter,
		int	index,
		vtkVariant	value )

virtual

A convenience method (in particular for access from other applications) to set parameter values of Learn mode.

Return true if setting of requested parameter name was executed, false otherwise. NB: default method (which is sufficient for most statistics algorithms) does not have any Learn parameters to set and always returns false.

Reimplemented in vtkKMeansStatistics, vtkOrderStatistics, and vtkPCAStatistics.

◆ Aggregate()

virtual bool vtkStatisticsAlgorithm::Aggregate	(	vtkDataObjectCollection *	collection,
		vtkStatisticalModel *	model )

pure virtual

Given a collection of models, calculate an aggregate model.

If the algorithm does not support aggregation, it may return false.

Implemented in vtkAutoCorrelativeStatistics, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkExtractHistogram2D, vtkHighestDensityRegionsStatistics, vtkKMeansStatistics, vtkMultiCorrelativeStatistics, vtkOrderStatistics, vtkPairwiseExtractHistogram2D, and vtkVisualStatistics.

◆ CopyRequests()

bool vtkStatisticsAlgorithm::CopyRequests ( vtkStatisticsAlgorithmPrivate * requests )

Copy requests for analysis from another container into this algorithm.

This method will return true if the algorithm is marked as modified because the requests were different and false otherwise.

◆ SetGhostsToSkip()

virtual void vtkStatisticsAlgorithm::SetGhostsToSkip ( unsigned char )

virtual

If there is a ghost array in the input, then ghosts matching GhostsToSkip mask will be skipped.

It is set to 0xff by default (every ghost type is skipped).

See also: vtkDataSetAttributes vtkFieldData vtkPointData vtkCellData

◆ GetGhostsToSkip()

virtual unsigned char vtkStatisticsAlgorithm::GetGhostsToSkip ( )

virtual

If there is a ghost array in the input, then ghosts matching GhostsToSkip mask will be skipped.

It is set to 0xff by default (every ghost type is skipped).

See also: vtkDataSetAttributes vtkFieldData vtkPointData vtkCellData

◆ SetSkipInvalidValues()

virtual void vtkStatisticsAlgorithm::SetSkipInvalidValues ( bool )

virtual

If set, invalid values (NaN or, depending on the circumstances, positive and negative infinity) should cause input samples to be skipped during the Learn phase (i.e., the construction of a model).

Not all statistics algorithms use this setting yet.

The default is true (skip invalid values).

◆ GetSkipInvalidValues()

virtual bool vtkStatisticsAlgorithm::GetSkipInvalidValues ( )

virtual

If set, invalid values (NaN or, depending on the circumstances, positive and negative infinity) should cause input samples to be skipped during the Learn phase (i.e., the construction of a model).

Not all statistics algorithms use this setting yet.

The default is true (skip invalid values).

◆ SkipInvalidValuesOn()

virtual void vtkStatisticsAlgorithm::SkipInvalidValuesOn ( )

virtual

If set, invalid values (NaN or, depending on the circumstances, positive and negative infinity) should cause input samples to be skipped during the Learn phase (i.e., the construction of a model).

Not all statistics algorithms use this setting yet.

The default is true (skip invalid values).

◆ SkipInvalidValuesOff()

virtual void vtkStatisticsAlgorithm::SkipInvalidValuesOff ( )

virtual

If set, invalid values (NaN or, depending on the circumstances, positive and negative infinity) should cause input samples to be skipped during the Learn phase (i.e., the construction of a model).

Not all statistics algorithms use this setting yet.

The default is true (skip invalid values).

◆ GetAlgorithmParameters()

virtual std::string vtkStatisticsAlgorithm::GetAlgorithmParameters ( ) const

virtual

Provide a serialization of this object's internal state so it can be recreated by a vtkStatisticalModel as needed.

Subclasses must override this method to encode ivar values after the class name. Use parentheses after the class name to hold a dictionary of ivar name and value pairs. For example, an instance of vtkDescriptiveStatistics might return

vtkDescriptiveStatistics(SampleEstimate=True,SignedDeviations=False)

It is unnecessary but allowed to specify ivar values that are the default.

If VTK's serialization-deserialization (SerDes) support ever becomes mandatory, this method should be replaced with it.

◆ NewFromAlgorithmParameters()

static vtkSmartPointer< vtkStatisticsAlgorithm > vtkStatisticsAlgorithm::NewFromAlgorithmParameters ( const std::string & algorithmParameters )

static

Return a new instance of a subclass named and configured by the algorithmParameters.

This will return a null object for unknown subclasses (not registered with the VTK object factory.

If VTK's serialization-deserialization (SerDes) support ever becomes mandatory, this method should be replaced with it.

◆ RegisterAlgorithm()

template<typename Algorithm>

static void vtkStatisticsAlgorithm::RegisterAlgorithm ( )

inlinestatic

Register a subclass of this algorithm.

Any algorithm registered with this method can be constructed by NewFromAlgorithmParameters(). Algorithms that are not registered cannot be. Some features of vtkGenerateStatistics and planned downstream filters will not work unless subclasses are registered.

Definition at line 452 of file vtkStatisticsAlgorithm.h.

◆ ConfigureFromAlgorithmParameters()

virtual bool vtkStatisticsAlgorithm::ConfigureFromAlgorithmParameters ( const std::string & algorithmParameters )

protectedvirtual

Loop over algorithmParameters until all are consumed or an error occurs.

◆ AppendAlgorithmParameters()

virtual void vtkStatisticsAlgorithm::AppendAlgorithmParameters ( std::string & algorithmParameters ) const

protectedvirtual

Subclasses must override this method if they have any internal ivars that affect the behavior of RequestData (specifically Learn/Derive at this point).

The algorithm should append a string holding comma-separated parameters. If the tail of the input algorithmParameters string is an open-parenthesis character, then this method need not start by appending a comma before adding its ivars. Any other tailing character indicates a comma is required if any ivars must be added. This method should not add a terminating close-parenthesis character (because that is added by GetAlgorithmParameters()).

Implementations should call their superclass's implementation before proceeding themselves.

Reimplemented in vtkDescriptiveStatistics, vtkHighestDensityRegionsStatistics, vtkKMeansStatistics, vtkMultiCorrelativeStatistics, vtkOrderStatistics, and vtkVisualStatistics.

◆ ConsumeNextAlgorithmParameter()

virtual std::size_t vtkStatisticsAlgorithm::ConsumeNextAlgorithmParameter	(	vtkStringToken	parameterName,
		const std::string &	algorithmParameters )

protectedvirtual

Consume a single parameter value, setting the value on this instance of the class.

Subclasses must override this method if they have any internal ivars that affect the behavior of RequestData (specifically Learn/Derive at this point).

If the parameterName is not recognized by this method or any of its superclasses, your implementation should return a value of 0 (indicating refusal to consume the parameterName). Otherwise, your implementation should return the number of bytes consumed from algorithmParameters to obtain a value for parameterName (not including any terminating comma or closing-parenthesis).

Reimplemented in vtkDescriptiveStatistics, vtkHighestDensityRegionsStatistics, vtkKMeansStatistics, vtkMultiCorrelativeStatistics, vtkOrderStatistics, and vtkVisualStatistics.

◆ FillInputPortInformation()

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

overrideprotectedvirtual

Return a new instance of a subclass named and configured by the algorithmParameters.

This will return a null object for unknown subclasses (not registered with the VTK object factory.

If VTK's serialization-deserialization (SerDes) support ever becomes mandatory, this method should be replaced with it.

Reimplemented from vtkAlgorithm.

◆ FillOutputPortInformation()

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

overrideprotectedvirtual

Return a new instance of a subclass named and configured by the algorithmParameters.

This will return a null object for unknown subclasses (not registered with the VTK object factory.

If VTK's serialization-deserialization (SerDes) support ever becomes mandatory, this method should be replaced with it.

Reimplemented from vtkAlgorithm.

◆ RequestData()

int vtkStatisticsAlgorithm::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *	)

overrideprotectedvirtual

Return a new instance of a subclass named and configured by the algorithmParameters.

This will return a null object for unknown subclasses (not registered with the VTK object factory.

If VTK's serialization-deserialization (SerDes) support ever becomes mandatory, this method should be replaced with it.

Reimplemented from vtkTableAlgorithm.

◆ Learn()

virtual void vtkStatisticsAlgorithm::Learn	(	vtkTable *	,
		vtkTable *	,
		vtkStatisticalModel *	)

protectedpure virtual

Execute the calculations required by the Learn option, given some input Data.

Implemented in vtkAutoCorrelativeStatistics, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkExtractHistogram2D, vtkHighestDensityRegionsStatistics, vtkKMeansStatistics, vtkMultiCorrelativeStatistics, vtkOrderStatistics, vtkPairwiseExtractHistogram2D, vtkPAutoCorrelativeStatistics, vtkPContingencyStatistics, vtkPCorrelativeStatistics, vtkPDescriptiveStatistics, vtkPExtractHistogram2D, vtkPMultiCorrelativeStatistics, vtkPOrderStatistics, vtkPPCAStatistics, and vtkVisualStatistics.

◆ Derive()

virtual void vtkStatisticsAlgorithm::Derive ( vtkStatisticalModel * )

protectedpure virtual

Execute the calculations required by the Derive option.

Implemented in vtkAutoCorrelativeStatistics, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkExtractHistogram2D, vtkHighestDensityRegionsStatistics, vtkKMeansStatistics, vtkMultiCorrelativeStatistics, vtkOrderStatistics, vtkPairwiseExtractHistogram2D, vtkPCAStatistics, and vtkVisualStatistics.

◆ Assess() [1/2]

virtual void vtkStatisticsAlgorithm::Assess	(	vtkTable *	,
		vtkStatisticalModel *	,
		vtkTable *	)

protectedpure virtual

Execute the calculations required by the Assess option.

Implemented in vtkAutoCorrelativeStatistics, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkExtractHistogram2D, vtkHighestDensityRegionsStatistics, vtkKMeansStatistics, vtkMultiCorrelativeStatistics, vtkOrderStatistics, vtkPairwiseExtractHistogram2D, and vtkPCAStatistics.

◆ Assess() [2/2]

void vtkStatisticsAlgorithm::Assess	(	vtkTable *	,
		vtkStatisticalModel *	,
		vtkTable *	,
		int	)

protected

A convenience implementation for generic assessment with variable number of variables.

◆ Test()

virtual void vtkStatisticsAlgorithm::Test	(	vtkTable *	,
		vtkStatisticalModel *	,
		vtkTable *	)

protectedpure virtual

Execute the calculations required by the Test option.

Implemented in vtkAutoCorrelativeStatistics, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkExtractHistogram2D, vtkHighestDensityRegionsStatistics, vtkKMeansStatistics, vtkMultiCorrelativeStatistics, vtkOrderStatistics, vtkPairwiseExtractHistogram2D, vtkPAutoCorrelativeStatistics, vtkPCAStatistics, vtkPCorrelativeStatistics, and vtkPPCAStatistics.

◆ SelectAssessFunctor()

virtual void vtkStatisticsAlgorithm::SelectAssessFunctor	(	vtkTable *	outData,
		vtkDataObject *	inMeta,
		vtkStringArray *	rowNames,
		AssessFunctor *&	dfunc )

protectedpure virtual

A pure virtual method to select the appropriate assessment functor.

Implemented in vtkAutoCorrelativeStatistics, vtkContingencyStatistics, vtkCorrelativeStatistics, vtkDescriptiveStatistics, vtkExtractHistogram2D, vtkHighestDensityRegionsStatistics, vtkKMeansStatistics, vtkMultiCorrelativeStatistics, vtkOrderStatistics, vtkPairwiseExtractHistogram2D, and vtkPCAStatistics.

◆ ConsumeString()

static std::size_t vtkStatisticsAlgorithm::ConsumeString	(	const std::string &	source,
		std::string &	value )

staticprotected

Turn a quoted string value into std::string, returning the number of bytes consumed.

The "tuple" should be a parenthesized list of single- or double-quoted strings, e.g., "('foo', 'bar', 'baz')" or '("foo", "bar", "baz")'. Escaped quotes inside strings are not currently supported.

This is used by ConsumeNextAlgorithmParameter() but available for subclasses to use as well.

◆ ConsumeStringTuple() [1/2]

static std::size_t vtkStatisticsAlgorithm::ConsumeStringTuple	(	const std::string &	source,
		std::vector< std::string > &	tuple )

staticprotected

Turn a tuple of strings into a vtkStringArray, returning the number of bytes consumed.

The "tuple" should be a parenthesized list of single-quoted strings, e.g., "('foo', 'bar', 'baz')". Escaped single-quotes inside strings are not currently supported.

This is used by ConsumeNextAlgorithmParameter() but available for subclasses to use as well.

◆ ConsumeStringTuple() [2/2]

static std::size_t vtkStatisticsAlgorithm::ConsumeStringTuple	(	const std::string &	source,
		vtkStringArray *	tuple )

staticprotected

Return a new instance of a subclass named and configured by the algorithmParameters.

This will return a null object for unknown subclasses (not registered with the VTK object factory.

If VTK's serialization-deserialization (SerDes) support ever becomes mandatory, this method should be replaced with it.

◆ ConsumeDouble()

static std::size_t vtkStatisticsAlgorithm::ConsumeDouble	(	const std::string &	source,
		double &	value )

staticprotected

Turn tuples (or respectively tuples of tuples) of numbers into a vector (or respectively a vector of vectors) of doubles, returning the number of bytes consumed.

The "tuple" should be a parenthesized list of numbers, e.g., "(2.3,3.4,4.5)" (or respectively, parenthesized tuples, e.g., "((1, 0), (0,1))").

This is available for subclasses to use in their ConsumeNextAlgorithmParameter() overrides.

◆ ConsumeDoubleTuple()

static std::size_t vtkStatisticsAlgorithm::ConsumeDoubleTuple	(	const std::string &	source,
		std::vector< double > &	tuple )

staticprotected

◆ ConsumeDoubleTuples()

static std::size_t vtkStatisticsAlgorithm::ConsumeDoubleTuples	(	const std::string &	source,
		std::vector< std::vector< double > > &	tuple )

staticprotected

◆ ConsumeStringToDoublesMap()

static std::size_t vtkStatisticsAlgorithm::ConsumeStringToDoublesMap	(	const std::string &	source,
		std::map< std::string, std::vector< double > > &	map )

staticprotected

◆ ConsumeInt()

static std::size_t vtkStatisticsAlgorithm::ConsumeInt	(	const std::string &	source,
		int &	value )

staticprotected

Turn a string holding an integer value into an integer, returning the number of bytes consumed by the integer.

◆ GetConstructorMap()

static AlgorithmConstructorMap & vtkStatisticsAlgorithm::GetConstructorMap ( )

staticprotected

Return a map of registered algorithm types.

Member Data Documentation

◆ NumberOfPrimaryTables

vtkIdType vtkStatisticsAlgorithm::NumberOfPrimaryTables

protected

Definition at line 588 of file vtkStatisticsAlgorithm.h.

◆ LearnOption

bool vtkStatisticsAlgorithm::LearnOption

protected

Definition at line 589 of file vtkStatisticsAlgorithm.h.

◆ DeriveOption

bool vtkStatisticsAlgorithm::DeriveOption

protected

Definition at line 590 of file vtkStatisticsAlgorithm.h.

◆ AssessOption

bool vtkStatisticsAlgorithm::AssessOption

protected

Definition at line 591 of file vtkStatisticsAlgorithm.h.

◆ TestOption

bool vtkStatisticsAlgorithm::TestOption

protected

Definition at line 592 of file vtkStatisticsAlgorithm.h.

◆ AssessNames

vtkStringArray* vtkStatisticsAlgorithm::AssessNames

protected

Definition at line 593 of file vtkStatisticsAlgorithm.h.

◆ GhostsToSkip

unsigned char vtkStatisticsAlgorithm::GhostsToSkip

protected

Definition at line 594 of file vtkStatisticsAlgorithm.h.

◆ NumberOfGhosts

vtkIdType vtkStatisticsAlgorithm::NumberOfGhosts

protected

Definition at line 595 of file vtkStatisticsAlgorithm.h.

◆ SkipInvalidValues

bool vtkStatisticsAlgorithm::SkipInvalidValues

protected

Definition at line 596 of file vtkStatisticsAlgorithm.h.

◆ Internals

vtkStatisticsAlgorithmPrivate* vtkStatisticsAlgorithm::Internals

protected

Definition at line 597 of file vtkStatisticsAlgorithm.h.

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

Filters/Statistics/vtkStatisticsAlgorithm.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

◆ AlgorithmConstructor

◆ AlgorithmConstructorMap

Member Enumeration Documentation

◆ InputPorts

◆ OutputIndices

Constructor & Destructor Documentation

◆ vtkStatisticsAlgorithm()

◆ ~vtkStatisticsAlgorithm()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetLearnOptionParameterConnection()

◆ SetLearnOptionParameters()

◆ SetInputModelConnection()

◆ SetInputModel()

◆ GetOutputModel()

◆ SetLearnOption()

◆ GetLearnOption()

◆ LearnOptionOn()

◆ LearnOptionOff()

◆ SetDeriveOption()

◆ GetDeriveOption()

◆ DeriveOptionOn()

◆ DeriveOptionOff()

◆ SetAssessOption()

◆ GetAssessOption()

◆ AssessOptionOn()

◆ AssessOptionOff()

◆ SetTestOption()

◆ GetTestOption()

◆ TestOptionOn()

◆ TestOptionOff()

◆ SetNumberOfPrimaryTables()

◆ GetNumberOfPrimaryTables()

◆ SetAssessNames()

◆ GetAssessNames()

◆ GetMaximumNumberOfColumnsPerRequest()

◆ SetColumnStatus()

◆ ResetAllColumnStates()

◆ RequestSelectedColumns()

◆ ResetRequests()

◆ GetNumberOfRequests()

◆ GetNumberOfColumnsForRequest()

◆ GetColumnForRequest() [1/2]

◆ GetColumnForRequest() [2/2]

◆ AddColumn()

◆ AddColumnPair()

◆ SetParameter()

◆ Aggregate()

◆ CopyRequests()

◆ SetGhostsToSkip()

◆ GetGhostsToSkip()

◆ SetSkipInvalidValues()

◆ GetSkipInvalidValues()

◆ SkipInvalidValuesOn()

◆ SkipInvalidValuesOff()

◆ GetAlgorithmParameters()

◆ NewFromAlgorithmParameters()

◆ RegisterAlgorithm()

◆ ConfigureFromAlgorithmParameters()

◆ AppendAlgorithmParameters()

◆ ConsumeNextAlgorithmParameter()

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ RequestData()