VTK  9.3.20240327
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkStatisticsAlgorithm Class Referenceabstract

Base class for statistics algorithms. More...

#include <vtkStatisticsAlgorithm.h>

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

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. More...
 
vtkStatisticsAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetLearnOptionParameterConnection (vtkAlgorithmOutput *params)
 A convenience method for setting learn input parameters (if one is expected or allowed). More...
 
virtual void SetLearnOptionParameters (vtkDataObject *params)
 A convenience method for setting learn input parameters (if one is expected or allowed). More...
 
virtual void SetInputModelConnection (vtkAlgorithmOutput *model)
 A convenience method for setting the input model connection (if one is expected or allowed). More...
 
virtual void SetInputModel (vtkDataObject *model)
 A convenience method for setting the input model (if one is expected or allowed). More...
 
virtual void SetColumnStatus (const char *namCol, int status)
 Add or remove a column from the current analysis request. More...
 
virtual void ResetAllColumnStates ()
 Set the status of each and every column in the current request to OFF (0). More...
 
virtual int RequestSelectedColumns ()
 Use the current column status values to produce a new request for statistics to be produced when RequestData() is called. More...
 
virtual void ResetRequests ()
 Empty the list of current requests. More...
 
virtual vtkIdType GetNumberOfRequests ()
 Return the number of requests. More...
 
virtual vtkIdType GetNumberOfColumnsForRequest (vtkIdType request)
 Return the number of columns for a given request. More...
 
virtual const char * GetColumnForRequest (vtkIdType r, vtkIdType c)
 Provide the name of the c-th column for the r-th request. More...
 
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). More...
 
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). More...
 
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. More...
 
virtual void Aggregate (vtkDataObjectCollection *, vtkMultiBlockDataSet *)=0
 Given a collection of models, calculate aggregate model. More...
 
virtual void SetLearnOption (bool)
 Set/Get the Learn operation. More...
 
virtual bool GetLearnOption ()
 Set/Get the Learn operation. More...
 
virtual void SetDeriveOption (bool)
 Set/Get the Derive operation. More...
 
virtual bool GetDeriveOption ()
 Set/Get the Derive operation. More...
 
virtual void SetAssessOption (bool)
 Set/Get the Assess operation. More...
 
virtual bool GetAssessOption ()
 Set/Get the Assess operation. More...
 
virtual void SetTestOption (bool)
 Set/Get the Test operation. More...
 
virtual bool GetTestOption ()
 Set/Get the Test operation. More...
 
virtual void SetNumberOfPrimaryTables (vtkIdType)
 Set/Get the number of tables in the primary model. More...
 
virtual vtkIdType GetNumberOfPrimaryTables ()
 Set/Get the number of tables in the primary model. More...
 
virtual void SetAssessNames (vtkStringArray *)
 Set/get assessment names. More...
 
virtual vtkStringArrayGetAssessNames ()
 Set/get assessment names. More...
 
- Public Member Functions inherited from vtkTableAlgorithm
vtkTableAlgorithmNewInstance () const
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkTableGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkTableGetOutput (int index)
 
void SetInputData (vtkDataObject *obj)
 Assign a data object as input. More...
 
void SetInputData (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
bool CheckAbort ()
 Checks to see if this filter should abort. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
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). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
bool UsesGarbageCollector () const override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm. More...
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm. More...
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports. More...
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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. More...
 
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. More...
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
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. More...
 
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. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkStatisticsAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkTableAlgorithm
static vtkTableAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTableAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkStatisticsAlgorithm ()
 
 ~vtkStatisticsAlgorithm () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
virtual void Learn (vtkTable *, vtkTable *, vtkMultiBlockDataSet *)=0
 Execute the calculations required by the Learn option, given some input Data. More...
 
virtual void Derive (vtkMultiBlockDataSet *)=0
 Execute the calculations required by the Derive option. More...
 
virtual void Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)=0
 Execute the calculations required by the Assess option. More...
 
void Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *, int)
 A convenience implementation for generic assessment with variable number of variables. More...
 
virtual void Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *)=0
 Execute the calculations required by the Test option. More...
 
virtual void SelectAssessFunctor (vtkTable *outData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc)=0
 A pure virtual method to select the appropriate assessment functor. More...
 
- 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. More...
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
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. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkIdType NumberOfPrimaryTables
 
bool LearnOption
 
bool DeriveOption
 
bool AssessOption
 
bool TestOption
 
vtkStringArrayAssessNames
 
vtkStatisticsAlgorithmPrivateInternals
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Base class for statistics algorithms.

All statistics algorithms can conceptually be operated with several operations:

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 118 of file vtkStatisticsAlgorithm.h.

Member Typedef Documentation

◆ Superclass

Definition at line 121 of file vtkStatisticsAlgorithm.h.

Member Enumeration Documentation

◆ 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 127 of file vtkStatisticsAlgorithm.h.

◆ 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 137 of file vtkStatisticsAlgorithm.h.

Constructor & Destructor Documentation

◆ vtkStatisticsAlgorithm()

vtkStatisticsAlgorithm::vtkStatisticsAlgorithm ( )
protected

◆ ~vtkStatisticsAlgorithm()

vtkStatisticsAlgorithm::~vtkStatisticsAlgorithm ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkStatisticsAlgorithm::IsA ( const char *  name)
virtual

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

◆ 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 148 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 157 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 166 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 175 of file vtkStatisticsAlgorithm.h.

◆ SetLearnOption()

virtual void vtkStatisticsAlgorithm::SetLearnOption ( bool  )
virtual

Set/Get the Learn operation.

◆ GetLearnOption()

virtual bool vtkStatisticsAlgorithm::GetLearnOption ( )
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.

◆ SetAssessOption()

virtual void vtkStatisticsAlgorithm::SetAssessOption ( bool  )
virtual

Set/Get the Assess operation.

◆ GetAssessOption()

virtual bool vtkStatisticsAlgorithm::GetAssessOption ( )
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.

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

◆ 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 vtkPCAStatistics, vtkOrderStatistics, and vtkKMeansStatistics.

◆ Aggregate()

virtual void vtkStatisticsAlgorithm::Aggregate ( vtkDataObjectCollection ,
vtkMultiBlockDataSet  
)
pure virtual

◆ FillInputPortInformation()

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

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkTableAlgorithm.

◆ FillOutputPortInformation()

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

Fill the output port information objects for this algorithm.

This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkTableAlgorithm.

◆ RequestData()

int vtkStatisticsAlgorithm::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkTableAlgorithm.

◆ Learn()

virtual void vtkStatisticsAlgorithm::Learn ( vtkTable ,
vtkTable ,
vtkMultiBlockDataSet  
)
protectedpure virtual

◆ Derive()

virtual void vtkStatisticsAlgorithm::Derive ( vtkMultiBlockDataSet )
protectedpure virtual

◆ Assess() [1/2]

virtual void vtkStatisticsAlgorithm::Assess ( vtkTable ,
vtkMultiBlockDataSet ,
vtkTable  
)
protectedpure virtual

◆ Assess() [2/2]

void vtkStatisticsAlgorithm::Assess ( vtkTable ,
vtkMultiBlockDataSet ,
vtkTable ,
int   
)
protected

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

◆ Test()

virtual void vtkStatisticsAlgorithm::Test ( vtkTable ,
vtkMultiBlockDataSet ,
vtkTable  
)
protectedpure virtual

◆ SelectAssessFunctor()

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

Member Data Documentation

◆ NumberOfPrimaryTables

vtkIdType vtkStatisticsAlgorithm::NumberOfPrimaryTables
protected

Definition at line 377 of file vtkStatisticsAlgorithm.h.

◆ LearnOption

bool vtkStatisticsAlgorithm::LearnOption
protected

Definition at line 378 of file vtkStatisticsAlgorithm.h.

◆ DeriveOption

bool vtkStatisticsAlgorithm::DeriveOption
protected

Definition at line 379 of file vtkStatisticsAlgorithm.h.

◆ AssessOption

bool vtkStatisticsAlgorithm::AssessOption
protected

Definition at line 380 of file vtkStatisticsAlgorithm.h.

◆ TestOption

bool vtkStatisticsAlgorithm::TestOption
protected

Definition at line 381 of file vtkStatisticsAlgorithm.h.

◆ AssessNames

vtkStringArray* vtkStatisticsAlgorithm::AssessNames
protected

Definition at line 382 of file vtkStatisticsAlgorithm.h.

◆ Internals

vtkStatisticsAlgorithmPrivate* vtkStatisticsAlgorithm::Internals
protected

Definition at line 383 of file vtkStatisticsAlgorithm.h.


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