VTK  9.2.20220811
vtkPCAStatistics.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3 Program: Visualization Toolkit
4 Module: vtkPCAStatistics.h
5 
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2010 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19  -------------------------------------------------------------------------*/
85 #ifndef vtkPCAStatistics_h
86 #define vtkPCAStatistics_h
87 
88 #include "vtkFiltersStatisticsModule.h" // For export macro
90 
91 class vtkDoubleArray;
92 class vtkIdTypeArray;
93 
94 class VTKFILTERSSTATISTICS_EXPORT vtkPCAStatistics : public vtkMultiCorrelativeStatistics
95 {
96 public:
98  void PrintSelf(ostream& os, vtkIndent indent) override;
99  static vtkPCAStatistics* New();
100 
105  {
110  NUM_NORMALIZATION_SCHEMES
111  };
112 
117  {
121  NUM_BASIS_SCHEMES
122  };
123 
125 
147  vtkSetMacro(NormalizationScheme, int);
148  vtkGetMacro(NormalizationScheme, int);
149  virtual void SetNormalizationSchemeByName(const char* schemeName);
150  virtual const char* GetNormalizationSchemeName(int scheme);
152 
154 
181 
183 
191  void GetEigenvalues(int request, vtkDoubleArray*);
193  double GetEigenvalue(int request, int i);
194  double GetEigenvalue(int i);
196 
198 
208  void GetEigenvectors(int request, vtkDoubleArray* eigenvectors);
209  void GetEigenvectors(vtkDoubleArray* eigenvectors);
210  void GetEigenvector(int i, vtkDoubleArray* eigenvector);
211  void GetEigenvector(int request, int i, vtkDoubleArray* eigenvector);
213 
215 
242  vtkSetMacro(BasisScheme, int);
243  vtkGetMacro(BasisScheme, int);
244  virtual const char* GetBasisSchemeName(int schemeIndex);
245  virtual void SetBasisSchemeByName(const char* schemeName);
247 
249 
254  vtkSetMacro(FixedBasisSize, int);
255  vtkGetMacro(FixedBasisSize, int);
257 
259 
264  vtkSetClampMacro(FixedBasisEnergy, double, 0., 1.);
265  vtkGetMacro(FixedBasisEnergy, double);
267 
273  bool SetParameter(const char* parameter, int index, vtkVariant value) override;
274 
275 protected:
277  ~vtkPCAStatistics() override;
278 
285 
289  void Derive(vtkMultiBlockDataSet*) override;
290 
295 
300 
306 
310  void SelectAssessFunctor(vtkTable* inData, vtkDataObject* inMeta, vtkStringArray* rowNames,
311  AssessFunctor*& dfunc) override;
312 
317 
318  static const char* BasisSchemeEnumNames[NUM_BASIS_SCHEMES + 1];
319  static const char* NormalizationSchemeEnumNames[NUM_NORMALIZATION_SCHEMES + 1];
320 
321 private:
322  vtkPCAStatistics(const vtkPCAStatistics&) = delete;
323  void operator=(const vtkPCAStatistics&) = delete;
324 };
325 
326 #endif // vtkPCAStatistics_h
general representation of visualization data
dynamic, self-adjusting array of double
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition: vtkIndent.h:119
Store vtkAlgorithm input/output information.
Composite dataset that organizes datasets into blocks.
A class for multivariate linear correlation.
A class for multivariate principal component analysis.
virtual vtkTable * GetSpecifiedNormalization()
These methods allow you to set/get values used to normalize the covariance matrix before PCA.
ProjectionType
These are the enumeration values that SetBasisScheme() accepts and GetBasisScheme returns.
@ FIXED_BASIS_SIZE
Use the first N entries in the basis matrix.
@ FULL_BASIS
Use all entries in the basis matrix.
@ FIXED_BASIS_ENERGY
Use consecutive basis matrix entries whose energies sum to at least T.
virtual const char * GetNormalizationSchemeName(int scheme)
This determines how (or if) the covariance matrix cov is normalized before PCA.
virtual void SetBasisSchemeByName(const char *schemeName)
This variable controls the dimensionality of output tuples in Assess operation.
void Derive(vtkMultiBlockDataSet *) override
Execute the calculations required by the Derive option.
bool SetParameter(const char *parameter, int index, vtkVariant value) override
A convenience method (in particular for access from other applications) to set parameter values.
void GetEigenvalues(int request, vtkDoubleArray *)
Get the eigenvalues.
virtual vtkDoubleArray * CalculatePValues(vtkIdTypeArray *, vtkDoubleArray *)
Calculate p-value.
double GetEigenvalue(int i)
Get the eigenvalues.
virtual void SetNormalizationSchemeByName(const char *schemeName)
This determines how (or if) the covariance matrix cov is normalized before PCA.
void GetEigenvectors(vtkDoubleArray *eigenvectors)
Get the eigenvectors.
NormalizationType
Methods by which the covariance matrix may be normalized.
@ TRIANGLE_SPECIFIED
Normalize cov(i,j) by V(i,j) where V is supplied by the user.
@ NONE
The covariance matrix should be used as computed.
@ DIAGONAL_SPECIFIED
Normalize cov(i,j) by sqrt(V(i)*V(j)) where V is supplied by the user.
@ DIAGONAL_VARIANCE
Normalize cov(i,j) by sqrt(cov(i,i)*cov(j,j)).
double GetEigenvalue(int request, int i)
Get the eigenvalues.
virtual void SetSpecifiedNormalization(vtkTable *)
These methods allow you to set/get values used to normalize the covariance matrix before PCA.
void GetEigenvectors(int request, vtkDoubleArray *eigenvectors)
Get the eigenvectors.
void GetEigenvector(int request, int i, vtkDoubleArray *eigenvector)
Get the eigenvectors.
void GetEigenvalues(vtkDoubleArray *)
Get the eigenvalues.
int FillInputPortInformation(int port, vtkInformation *info) override
This algorithm accepts a vtkTable containing normalization values for its fourth input (port 3).
~vtkPCAStatistics() override
static vtkPCAStatistics * New()
void Assess(vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
Execute the calculations required by the Assess option.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SelectAssessFunctor(vtkTable *inData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc) override
Provide the appropriate assessment functor.
virtual const char * GetBasisSchemeName(int schemeIndex)
This variable controls the dimensionality of output tuples in Assess operation.
void Test(vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
Execute the calculations required by the Test option.
void GetEigenvector(int i, vtkDoubleArray *eigenvector)
Get the eigenvectors.
A base class for a functor that assesses data.
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:183
A atomic type representing the union of many types.
Definition: vtkVariant.h:159
@ info
Definition: vtkX3D.h:382
@ value
Definition: vtkX3D.h:226
@ port
Definition: vtkX3D.h:453
@ parameter
Definition: vtkX3D.h:449
@ index
Definition: vtkX3D.h:252