VTK
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
 

Public Types

typedef vtkTableAlgorithm Superclass
 
enum  InputPorts { INPUT_DATA = 0, LEARN_PARAMETERS = 1, INPUT_MODEL = 2 }
 
enum  OutputIndices { OUTPUT_DATA = 0, OUTPUT_MODEL = 1, ASSESSMENT = 2, OUTPUT_TEST = 2 }
 
- Public Types inherited from vtkTableAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

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

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkStatisticsAlgorithmSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkTableAlgorithm
static vtkTableAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTableAlgorithmSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObject *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyPRESERVES_DATASET ()
 
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
 
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKeyPRESERVES_RANGES ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

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

Protected Attributes

int NumberOfPrimaryTables
 
bool LearnOption
 
bool DeriveOption
 
bool AssessOption
 
bool TestOption
 
vtkStringArrayAssessParameters
 
vtkStringArrayAssessNames
 
vtkStatisticsAlgorithmPrivateInternals
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 
- Friends inherited from vtkObject

Detailed Description

Base class for statistics algorithms.

All statistics algorithms can conceptually be operated with several options: 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 vtkTable ports 3 input ports: Data (mandatory) Parameters to the learn phase (optional) Input model (optional) 3 output port (called Output): Data (annotated with assessments when the Assess option is ON). Output model (identical to the the input model when Learn option 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 option is ON.

Thanks:
Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.
Tests:
vtkStatisticsAlgorithm (Tests)

Definition at line 70 of file vtkStatisticsAlgorithm.h.

Member Typedef Documentation

Definition at line 73 of file vtkStatisticsAlgorithm.h.

Member Enumeration Documentation

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

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.

ASSESSMENT 

This is an old, deprecated name for OUTPUT_TEST.

OUTPUT_TEST 

Output 2 contains result of statistical test(s)

Definition at line 89 of file vtkStatisticsAlgorithm.h.

Constructor & Destructor Documentation

vtkStatisticsAlgorithm::vtkStatisticsAlgorithm ( )
protected
vtkStatisticsAlgorithm::~vtkStatisticsAlgorithm ( )
protected

Member Function Documentation

virtual const char* vtkStatisticsAlgorithm::GetClassName ( )
virtual
static int vtkStatisticsAlgorithm::IsTypeOf ( const char *  type)
static
virtual int vtkStatisticsAlgorithm::IsA ( const char *  name)
virtual
static vtkStatisticsAlgorithm* vtkStatisticsAlgorithm::SafeDownCast ( vtkObject o)
static
void vtkStatisticsAlgorithm::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkUnivariateStatisticsAlgorithm.

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

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 SetInput( 1, params );

Definition at line 111 of file vtkStatisticsAlgorithm.h.

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

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 SetInput( 2, model );

Definition at line 126 of file vtkStatisticsAlgorithm.h.

virtual void vtkStatisticsAlgorithm::SetLearnOption ( bool  )
virtual

Set/Get the Learn option.

virtual bool vtkStatisticsAlgorithm::GetLearnOption ( )
virtual

Set/Get the Learn option.

virtual void vtkStatisticsAlgorithm::SetDeriveOption ( bool  )
virtual

Set/Get the Derive option.

virtual bool vtkStatisticsAlgorithm::GetDeriveOption ( )
virtual

Set/Get the Derive option.

virtual void vtkStatisticsAlgorithm::SetAssessOption ( bool  )
virtual

Set/Get the Assess option.

virtual bool vtkStatisticsAlgorithm::GetAssessOption ( )
virtual

Set/Get the Assess option.

virtual void vtkStatisticsAlgorithm::SetTestOption ( bool  )
virtual

Set/Get the Test option.

virtual bool vtkStatisticsAlgorithm::GetTestOption ( )
virtual

Set/Get the Test option.

virtual void vtkStatisticsAlgorithm::SetNumberOfPrimaryTables ( vtkIdType  )
virtual

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

virtual vtkIdType vtkStatisticsAlgorithm::GetNumberOfPrimaryTables ( )
virtual

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

virtual void vtkStatisticsAlgorithm::SetAssessParameters ( vtkStringArray )
virtual

Set/get assessment parameters.

virtual vtkStringArray* vtkStatisticsAlgorithm::GetAssessParameters ( )
virtual

Set/get assessment parameters.

virtual void vtkStatisticsAlgorithm::SetAssessNames ( vtkStringArray )
virtual

Set/get assessment names.

virtual vtkStringArray* vtkStatisticsAlgorithm::GetAssessNames ( )
virtual

Set/get assessment names.

void vtkStatisticsAlgorithm::SetAssessOptionParameter ( vtkIdType  id,
vtkStdString  name 
)

Set the name of a parameter of the Assess option

vtkStdString vtkStatisticsAlgorithm::GetAssessParameter ( vtkIdType  id)

Get the name of a parameter of the Assess option

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.

virtual void vtkStatisticsAlgorithm::ResetAllColumnStates ( )
virtual

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

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.

Reimplemented in vtkBivariateStatisticsAlgorithm, and vtkUnivariateStatisticsAlgorithm.

virtual void vtkStatisticsAlgorithm::ResetRequests ( )
virtual

Empty the list of current requests.

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

virtual vtkIdType vtkStatisticsAlgorithm::GetNumberOfColumnsForRequest ( vtkIdType  request)
virtual

Return the number of columns for a given request.

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 NULL. Otherwise it returns the column name. This version is not thread-safe.

virtual int vtkStatisticsAlgorithm::GetColumnForRequest ( vtkIdType  r,
vtkIdType  c,
vtkStdString columnName 
)
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 NULL. Otherwise it returns the column name. This version is not thread-safe.

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

virtual void vtkStatisticsAlgorithm::Aggregate ( vtkDataObjectCollection ,
vtkMultiBlockDataSet  
)
pure virtual
virtual int vtkStatisticsAlgorithm::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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.

Reimplemented in vtkPCAStatistics.

virtual int vtkStatisticsAlgorithm::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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.

Reimplemented in vtkExtractHistogram2D, and vtkPairwiseExtractHistogram2D.

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

This is called by the superclass. This is the method you should override.

Reimplemented from vtkTableAlgorithm.

virtual void vtkStatisticsAlgorithm::Learn ( vtkTable ,
vtkTable ,
vtkMultiBlockDataSet  
)
protectedpure virtual
virtual void vtkStatisticsAlgorithm::Derive ( vtkMultiBlockDataSet )
protectedpure virtual
virtual void vtkStatisticsAlgorithm::Assess ( vtkTable ,
vtkMultiBlockDataSet ,
vtkTable  
)
protectedpure virtual
virtual void vtkStatisticsAlgorithm::Test ( vtkTable ,
vtkMultiBlockDataSet ,
vtkTable  
)
protectedpure virtual
virtual void vtkStatisticsAlgorithm::SelectAssessFunctor ( vtkTable outData,
vtkDataObject inMeta,
vtkStringArray rowNames,
AssessFunctor *&  dfunc 
)
protectedpure virtual

Member Data Documentation

int vtkStatisticsAlgorithm::NumberOfPrimaryTables
protected

Definition at line 305 of file vtkStatisticsAlgorithm.h.

bool vtkStatisticsAlgorithm::LearnOption
protected

Definition at line 306 of file vtkStatisticsAlgorithm.h.

bool vtkStatisticsAlgorithm::DeriveOption
protected

Definition at line 307 of file vtkStatisticsAlgorithm.h.

bool vtkStatisticsAlgorithm::AssessOption
protected

Definition at line 308 of file vtkStatisticsAlgorithm.h.

bool vtkStatisticsAlgorithm::TestOption
protected

Definition at line 309 of file vtkStatisticsAlgorithm.h.

vtkStringArray* vtkStatisticsAlgorithm::AssessParameters
protected

Definition at line 310 of file vtkStatisticsAlgorithm.h.

vtkStringArray* vtkStatisticsAlgorithm::AssessNames
protected

Definition at line 311 of file vtkStatisticsAlgorithm.h.

vtkStatisticsAlgorithmPrivate* vtkStatisticsAlgorithm::Internals
protected

Definition at line 312 of file vtkStatisticsAlgorithm.h.


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