ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPSciVizPCAStats Class Reference

Perform PCA on data and/or project data into a subspace defined by the PCA. More...

#include <vtkPSciVizPCAStats.h>

Inheritance diagram for vtkPSciVizPCAStats:
Inheritance graph
[legend]
Collaboration diagram for vtkPSciVizPCAStats:
Collaboration graph
[legend]

Public Types

typedef vtkSciVizStatistics Superclass
 
- Public Types inherited from vtkSciVizStatistics
enum  Tasks { MODEL_INPUT, CREATE_MODEL, ASSESS_INPUT, MODEL_AND_ASSESS }
 Possible tasks the filter can perform. More...
 
typedef vtkTableAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetNormalizationScheme (int)
 
virtual int GetNormalizationScheme ()
 
virtual void SetBasisScheme (int)
 
virtual int GetBasisScheme ()
 
virtual void SetFixedBasisSize (int)
 
virtual int GetFixedBasisSize ()
 
virtual void SetFixedBasisEnergy (double)
 
virtual double GetFixedBasisEnergy ()
 
virtual void SetRobustPCA (bool)
 
virtual bool GetRobustPCA ()
 
virtual void RobustPCAOn ()
 
virtual void RobustPCAOff ()
 
- Public Member Functions inherited from vtkSciVizStatistics
int GetNumberOfAttributeArrays ()
 Return the number of columns available for the current value of AttributeMode. More...
 
const char * GetAttributeArrayName (int n)
 Get the name of the n-th array ffor the current value of AttributeMode. More...
 
int GetAttributeArrayStatus (const char *arrName)
 Get the status of the specified array (i.e., whether or not it is a column of interest). More...
 
vtkInformationIntegerKey * MULTIPLE_MODELS ()
 A key used to mark the output model data object (output port 0) when it is a multiblock of models (any of which may be multiblock dataset themselves) as opposed to a multiblock dataset containing a single model. More...
 
virtual int GetAttributeMode ()
 Set/get the type of field attribute (cell, point, field) More...
 
virtual void SetAttributeMode (int)
 Set/get the type of field attribute (cell, point, field) More...
 
void EnableAttributeArray (const char *arrName)
 An alternate interface for preparing a selection of arrays in ParaView. More...
 
void ClearAttributeArrays ()
 An alternate interface for preparing a selection of arrays in ParaView. More...
 
virtual void SetTrainingFraction (double)
 Set/get the amount of data to be used for training. More...
 
virtual double GetTrainingFraction ()
 Set/get the amount of data to be used for training. More...
 
virtual void SetTask (int)
 Set/get whether this filter should create a model of the input or assess the input or both. More...
 
virtual int GetTask ()
 Set/get whether this filter should create a model of the input or assess the input or both. More...
 

Static Public Member Functions

static vtkPSciVizPCAStatsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPSciVizPCAStatsSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSciVizStatistics
static int IsTypeOf (const char *type)
 
static vtkSciVizStatisticsSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPSciVizPCAStats ()
 
virtual ~vtkPSciVizPCAStats ()
 
virtual int LearnAndDerive (vtkMultiBlockDataSet *model, vtkTable *inData)
 Method subclasses must override to calculate a full model from the given input data. More...
 
virtual int AssessData (vtkTable *observations, vtkDataObject *dataset, vtkMultiBlockDataSet *model)
 Method subclasses must override to assess an input table given a model of the proper type. More...
 
- Protected Member Functions inherited from vtkSciVizStatistics
 vtkSciVizStatistics ()
 
virtual ~vtkSciVizStatistics ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **input, vtkInformationVector *output)
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **input, vtkInformationVector *output)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **input, vtkInformationVector *output)
 
virtual int RequestData (vtkCompositeDataSet *compDataOu, vtkCompositeDataSet *compModelOu, vtkCompositeDataSet *compDataIn, vtkCompositeDataSet *compModelIn, vtkDataObject *singleModel)
 
virtual int RequestData (vtkDataObject *observationsOut, vtkDataObject *modelOut, vtkDataObject *observationsIn, vtkDataObject *modelIn)
 
virtual int PrepareFullDataTable (vtkTable *table, vtkFieldData *dataAttrIn)
 
virtual int PrepareTrainingTable (vtkTable *trainingTable, vtkTable *fullDataTable, vtkIdType numObservations)
 
virtual vtkIdType GetNumberOfObservationsForTraining (vtkTable *observations)
 Subclasses may (but need not) override this function to guarantee that some minimum number of observations are included in the training data. More...
 

Protected Attributes

int NormalizationScheme
 
int BasisScheme
 
int FixedBasisSize
 
double FixedBasisEnergy
 
bool RobustPCA
 
- Protected Attributes inherited from vtkSciVizStatistics
int AttributeMode
 
int Task
 
double TrainingFraction
 
vtkSciVizStatisticsPP
 

Detailed Description

Perform PCA on data and/or project data into a subspace defined by the PCA.

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

This filter performs additional analysis above and beyond the vtkPSciVizMultiCorrelativeStats filter. It computes the eigenvalues and eigenvectors of the covariance matrix from the multicorrelative filter. Data is then assessed by projecting the original tuples into a possibly lower-dimensional space.

Since the PCA filter uses the multicorrelative filter's analysis, it shares the same raw covariance table specified in the multicorrelative documentation. The second table in the multiblock dataset comprising the model output is an expanded version of the multicorrelative version.

As with the multicorrlative filter, the second model table contains the mean values, the upper-triangular portion of the symmetric covariance matrix, and the non-zero lower-triangular portion of the Cholesky decomposition of the covariance matrix. Below these entries are the eigenvalues of the covariance matrix (in the column labeled "Mean") and the eigenvectors (as row vectors) in an additional NxN matrix.

Definition at line 52 of file vtkPSciVizPCAStats.h.

Member Typedef Documentation

◆ Superclass

Definition at line 56 of file vtkPSciVizPCAStats.h.

Constructor & Destructor Documentation

◆ vtkPSciVizPCAStats()

vtkPSciVizPCAStats::vtkPSciVizPCAStats ( )
protected

◆ ~vtkPSciVizPCAStats()

virtual vtkPSciVizPCAStats::~vtkPSciVizPCAStats ( )
protectedvirtual

Member Function Documentation

◆ New()

static vtkPSciVizPCAStats* vtkPSciVizPCAStats::New ( )
static

◆ GetClassName()

virtual const char* vtkPSciVizPCAStats::GetClassName ( )
virtual

Reimplemented from vtkSciVizStatistics.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSciVizStatistics.

◆ SafeDownCast()

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

◆ PrintSelf()

virtual void vtkPSciVizPCAStats::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented from vtkSciVizStatistics.

◆ SetNormalizationScheme()

virtual void vtkPSciVizPCAStats::SetNormalizationScheme ( int  )
virtual

◆ GetNormalizationScheme()

virtual int vtkPSciVizPCAStats::GetNormalizationScheme ( )
virtual

◆ SetBasisScheme()

virtual void vtkPSciVizPCAStats::SetBasisScheme ( int  )
virtual

◆ GetBasisScheme()

virtual int vtkPSciVizPCAStats::GetBasisScheme ( )
virtual

◆ SetFixedBasisSize()

virtual void vtkPSciVizPCAStats::SetFixedBasisSize ( int  )
virtual

◆ GetFixedBasisSize()

virtual int vtkPSciVizPCAStats::GetFixedBasisSize ( )
virtual

◆ SetFixedBasisEnergy()

virtual void vtkPSciVizPCAStats::SetFixedBasisEnergy ( double  )
virtual

◆ GetFixedBasisEnergy()

virtual double vtkPSciVizPCAStats::GetFixedBasisEnergy ( )
virtual

◆ SetRobustPCA()

virtual void vtkPSciVizPCAStats::SetRobustPCA ( bool  )
virtual

◆ GetRobustPCA()

virtual bool vtkPSciVizPCAStats::GetRobustPCA ( )
virtual

◆ RobustPCAOn()

virtual void vtkPSciVizPCAStats::RobustPCAOn ( )
virtual

◆ RobustPCAOff()

virtual void vtkPSciVizPCAStats::RobustPCAOff ( )
virtual

◆ LearnAndDerive()

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

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

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

Implements vtkSciVizStatistics.

◆ AssessData()

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

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

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

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

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

Implements vtkSciVizStatistics.

Member Data Documentation

◆ NormalizationScheme

int vtkPSciVizPCAStats::NormalizationScheme
protected

Definition at line 83 of file vtkPSciVizPCAStats.h.

◆ BasisScheme

int vtkPSciVizPCAStats::BasisScheme
protected

Definition at line 84 of file vtkPSciVizPCAStats.h.

◆ FixedBasisSize

int vtkPSciVizPCAStats::FixedBasisSize
protected

Definition at line 85 of file vtkPSciVizPCAStats.h.

◆ FixedBasisEnergy

double vtkPSciVizPCAStats::FixedBasisEnergy
protected

Definition at line 86 of file vtkPSciVizPCAStats.h.

◆ RobustPCA

bool vtkPSciVizPCAStats::RobustPCA
protected

Definition at line 87 of file vtkPSciVizPCAStats.h.


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