Skip to content
Snippets Groups Projects
Commit 2e2a64e6 authored by Philippe Pébay's avatar Philippe Pébay
Browse files

Updated PCA documentation

Change-Id: I5970870d8d2eb04789f03bb2c13268bf4d241e6e
parent e3a7fc59
No related branches found
No related tags found
No related merge requests found
......@@ -17,15 +17,15 @@ PURPOSE. See the above copyright notice for more information.
Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
// .NAME vtkPCAStatistics - A class for principal component analysis
// .NAME vtkPCAStatistics - A class for multivariate principal component analysis
//
// .SECTION Description
// This class derives from the multi-correlative statistics algorithm and
// uses the covariance matrix and Cholesky decomposition computed by it.
// However, when it finalizes the statistics in Learn mode, the PCA class
// However, when it finalizes the statistics in learn operation, the PCA class
// computes the SVD of the covariance matrix in order to obtain its eigenvectors.
//
// In the assess mode, the input data are
// In the assess operation, the input data are
// - projected into the basis defined by the eigenvectors,
// - the energy associated with each datum is computed,
// - or some combination thereof.
......@@ -34,10 +34,12 @@ PURPOSE. See the above copyright notice for more information.
// projection into a lower-dimensional state while minimizing (in a
// least squares sense) the projection error.
//
// In the test operation, a Jarque-Bera-Srivastava test of n-d normality is performed.
//
// .SECTION Thanks
// Thanks to David Thompson, Philippe Pebay and Jackson Mayo from
// Sandia National Laboratories for implementing this class.
// Updated by Philippe Pebay, Kitware SAS 2012
#ifndef __vtkPCAStatistics_h
#define __vtkPCAStatistics_h
......@@ -152,7 +154,7 @@ public:
void GetEigenvector(int request, int i, vtkDoubleArray* eigenvector);
// Description:
// This variable controls the dimensionality of output tuples in Assess mode.
// This variable controls the dimensionality of output tuples in Assess operation.
// Consider the case where you have requested a PCA on D columns.
//
// When set to vtkPCAStatistics::FULL_BASIS, the entire set of basis vectors
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment