VTK  9.0.3
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  -------------------------------------------------------------------------*/
53 #ifndef vtkPCAStatistics_h
54 #define vtkPCAStatistics_h
55 
56 #include "vtkFiltersStatisticsModule.h" // For export macro
58 
59 class vtkDoubleArray;
60 class vtkIdTypeArray;
61 
62 class VTKFILTERSSTATISTICS_EXPORT vtkPCAStatistics : public vtkMultiCorrelativeStatistics
63 {
64 public:
66  void PrintSelf(ostream& os, vtkIndent indent) override;
67  static vtkPCAStatistics* New();
68 
73  {
74  NONE,
78  NUM_NORMALIZATION_SCHEMES
79  };
80 
85  {
89  NUM_BASIS_SCHEMES
90  };
91 
93 
115  vtkSetMacro(NormalizationScheme, int);
116  vtkGetMacro(NormalizationScheme, int);
117  virtual void SetNormalizationSchemeByName(const char* sname);
118  virtual const char* GetNormalizationSchemeName(int scheme);
120 
122 
149 
151 
159  void GetEigenvalues(int request, vtkDoubleArray*);
161  double GetEigenvalue(int request, int i);
162  double GetEigenvalue(int i);
164 
166 
176  void GetEigenvectors(int request, vtkDoubleArray* eigenvectors);
177  void GetEigenvectors(vtkDoubleArray* eigenvectors);
178  void GetEigenvector(int i, vtkDoubleArray* eigenvector);
179  void GetEigenvector(int request, int i, vtkDoubleArray* eigenvector);
181 
183 
210  vtkSetMacro(BasisScheme, int);
211  vtkGetMacro(BasisScheme, int);
212  virtual const char* GetBasisSchemeName(int schemeIndex);
213  virtual void SetBasisSchemeByName(const char* schemeName);
215 
217 
222  vtkSetMacro(FixedBasisSize, int);
223  vtkGetMacro(FixedBasisSize, int);
225 
227 
232  vtkSetClampMacro(FixedBasisEnergy, double, 0., 1.);
233  vtkGetMacro(FixedBasisEnergy, double);
235 
241  bool SetParameter(const char* parameter, int index, vtkVariant value) override;
242 
243 protected:
245  ~vtkPCAStatistics() override;
246 
253 
257  void Derive(vtkMultiBlockDataSet*) override;
258 
263 
268 
274 
278  void SelectAssessFunctor(vtkTable* inData, vtkDataObject* inMeta, vtkStringArray* rowNames,
279  AssessFunctor*& dfunc) override;
280 
285 
286  static const char* BasisSchemeEnumNames[NUM_BASIS_SCHEMES + 1];
287  static const char* NormalizationSchemeEnumNames[NUM_NORMALIZATION_SCHEMES + 1];
288 
289 private:
290  vtkPCAStatistics(const vtkPCAStatistics&) = delete;
291  void operator=(const vtkPCAStatistics&) = delete;
292 };
293 
294 #endif // vtkPCAStatistics_h
general representation of visualization data
Definition: vtkDataObject.h:60
dynamic, self-adjusting array of double
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition: vtkIndent.h:34
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)
virtual void SetBasisSchemeByName(const char *schemeName)
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)
void GetEigenvectors(vtkDoubleArray *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)
virtual void SetSpecifiedNormalization(vtkTable *)
void GetEigenvectors(int request, vtkDoubleArray *eigenvectors)
Get the eigenvectors.
void GetEigenvector(int request, int i, vtkDoubleArray *eigenvector)
void GetEigenvalues(vtkDoubleArray *)
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)
void Test(vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
Execute the calculations required by the Test option.
virtual void SetNormalizationSchemeByName(const char *sname)
void GetEigenvector(int i, vtkDoubleArray *eigenvector)
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:63
A atomic type representing the union of many types.
Definition: vtkVariant.h:66
@ 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