VTK
|
A class for linear correlation. More...
#include <vtkMultiCorrelativeStatistics.h>
Public Types | |
typedef vtkStatisticsAlgorithm | Superclass |
![]() | |
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 } |
![]() | |
typedef vtkAlgorithm | Superclass |
![]() | |
typedef vtkObject | Superclass |
![]() | |
typedef vtkObjectBase | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
virtual void | PrintSelf (ostream &os, vtkIndent indent) |
virtual void | Aggregate (vtkDataObjectCollection *, vtkMultiBlockDataSet *) |
![]() | |
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 vtkStringArray * | GetAssessParameters () |
virtual void | SetAssessNames (vtkStringArray *) |
virtual vtkStringArray * | GetAssessNames () |
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 int | ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
vtkTable * | GetOutput () |
vtkTable * | GetOutput (int index) |
void | SetInput (vtkDataObject *obj) |
void | SetInput (int index, vtkDataObject *obj) |
![]() | |
int | HasExecutive () |
vtkExecutive * | GetExecutive () |
virtual void | SetExecutive (vtkExecutive *executive) |
virtual int | ModifyRequest (vtkInformation *request, int when) |
vtkInformation * | GetInputPortInformation (int port) |
vtkInformation * | GetOutputPortInformation (int port) |
int | GetNumberOfInputPorts () |
int | GetNumberOfOutputPorts () |
void | UpdateProgress (double amount) |
vtkInformation * | GetInputArrayInformation (int idx) |
void | RemoveAllInputs () |
vtkDataObject * | GetOutputDataObject (int port) |
virtual void | RemoveInputConnection (int port, vtkAlgorithmOutput *input) |
int | GetNumberOfInputConnections (int port) |
int | GetTotalNumberOfInputConnections () |
vtkAlgorithmOutput * | GetInputConnection (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 vtkInformation * | GetInformation () |
virtual void | SetInformation (vtkInformation *) |
virtual void | Register (vtkObjectBase *o) |
virtual void | UnRegister (vtkObjectBase *o) |
virtual void | SetAbortExecute (int) |
virtual int | GetAbortExecute () |
virtual void | AbortExecuteOn () |
virtual void | AbortExecuteOff () |
virtual void | SetProgress (double) |
virtual double | GetProgress () |
void | SetProgressText (const char *ptext) |
virtual char * | GetProgressText () |
virtual unsigned long | GetErrorCode () |
virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name) |
virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) |
virtual void | SetInputArrayToProcess (int idx, vtkInformation *info) |
virtual void | SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName) |
vtkDataObject * | GetInputDataObject (int port, int connection) |
virtual void | SetInputConnection (int port, vtkAlgorithmOutput *input) |
virtual void | SetInputConnection (vtkAlgorithmOutput *input) |
virtual void | AddInputConnection (int port, vtkAlgorithmOutput *input) |
virtual void | AddInputConnection (vtkAlgorithmOutput *input) |
vtkAlgorithmOutput * | GetOutputPort (int index) |
vtkAlgorithmOutput * | GetOutputPort () |
virtual void | SetReleaseDataFlag (int) |
virtual int | GetReleaseDataFlag () |
void | ReleaseDataFlagOn () |
void | ReleaseDataFlagOff () |
int | UpdateExtentIsEmpty (vtkDataObject *output) |
int | UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType) |
![]() | |
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) |
vtkCommand * | GetCommand (unsigned long tag) |
void | RemoveObserver (vtkCommand *) |
void | RemoveObservers (unsigned long event, vtkCommand *) |
void | RemoveObservers (const char *event, vtkCommand *) |
int | HasObserver (unsigned long event, vtkCommand *) |
int | HasObserver (const char *event, vtkCommand *) |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
int | HasObserver (unsigned long event) |
int | HasObserver (const char *event) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
int | InvokeEvent (unsigned long event, void *callData) |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
![]() | |
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 () |
Additional Inherited Members | |
![]() | |
int | AbortExecute |
![]() | |
static vtkInformationIntegerKey * | PORT_REQUIREMENTS_FILLED () |
![]() | |
int | NumberOfPrimaryTables |
bool | LearnOption |
bool | DeriveOption |
bool | AssessOption |
bool | TestOption |
vtkStringArray * | AssessParameters |
vtkStringArray * | AssessNames |
vtkStatisticsAlgorithmPrivate * | Internals |
![]() | |
vtkInformation * | Information |
double | Progress |
char * | ProgressText |
unsigned long | ErrorCode |
![]() | |
unsigned char | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
int | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
![]() | |
static vtkExecutive * | DefaultExecutivePrototype |
A class for linear correlation.
Given a selection of sets of columns of interest, this class provides the following functionalities, depending on the execution mode it is executed in: Learn: calculates means, unbiased variance and covariance estimators of column pairs coefficient. More precisely, Learn calculates the averages and centered variance/covariance sums; if finalize
is set to true (default), the final statistics are calculated. The output metadata on port OUTPUT_MODEL is a multiblock dataset containing at a minimum one vtkTable holding the raw sums in a sparse matrix style. If finalize is true, then one additional vtkTable will be present for each requested set of column correlations. These additional tables contain column averages, the upper triangular portion of the covariance matrix (in the upper right hand portion of the table) and the Cholesky decomposition of the covariance matrix (in the lower portion of the table beneath the covariance triangle). The leftmost column will be a vector of column averages. The last entry in the column averages vector is the number of samples. As an example, consider a request for a 3-column correlation with columns named ColA, ColB, and ColC. The resulting table will look like this:
Column |Mean |ColA |ColB |ColC --------+---------+---------+---------+--------- ColA |avg(A) |cov(A,A) |cov(A,B) |cov(A,C) ColB |avg(B) |chol(1,1)|cov(B,B) |cov(B,C) ColC |avg(C) |chol(2,1)|chol(2,2)|cov(C,C) Cholesky|length(A)|chol(3,1)|chol(3,2)|chol(3,3)
Assess: given a set of results matrices as specified above in input port INPUT_MODEL and tabular data on input port INPUT_DATA that contains column names matching those of the tables on input port INPUT_MODEL, the assess mode computes the relative deviation of each observation in port INPUT_DATA's table according to the linear correlations implied by each table in port INPUT_MODEL.
Definition at line 76 of file vtkMultiCorrelativeStatistics.h.
Definition at line 79 of file vtkMultiCorrelativeStatistics.h.
|
protected |
|
protected |
|
virtual |
Reimplemented from vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics, vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics, vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.
|
static |
|
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 vtkPCAStatistics, vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.
|
static |
|
virtual |
Given a collection of models, calculate aggregate model
Implements vtkStatisticsAlgorithm.
|
protectedvirtual |
Execute the calculations required by the Learn option.
Implements vtkStatisticsAlgorithm.
Reimplemented in vtkPMultiCorrelativeStatistics, and vtkPPCAStatistics.
|
protectedvirtual |
Execute the calculations required by the Derive option.
Implements vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics.
|
protectedvirtual |
Execute the calculations required by the Assess option.
Implements vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics.
|
inlineprotectedvirtual |
Execute the calculations required by the Test option.
Implements vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics.
Definition at line 112 of file vtkMultiCorrelativeStatistics.h.
|
protectedvirtual |
Provide the appropriate assessment functor.
Implements vtkStatisticsAlgorithm.
Reimplemented in vtkPCAStatistics.