vtkPCAStatistics.h

Go to the documentation of this file.

/*=========================================================================
 
Program:   Visualization Toolkit
Module:    vtkPCAStatistics.h
 
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2010 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
  -------------------------------------------------------------------------*/
#ifndef vtkPCAStatistics_h
#define vtkPCAStatistics_h
 
#include "vtkFiltersStatisticsModule.h" // For export macro
#include "vtkMultiCorrelativeStatistics.h"
 
class vtkDoubleArray;
class vtkIdTypeArray;
 
class VTKFILTERSSTATISTICS_EXPORT vtkPCAStatistics : public vtkMultiCorrelativeStatistics
{
public:
  vtkTypeMacro(vtkPCAStatistics, vtkMultiCorrelativeStatistics);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkPCAStatistics* New();
 
  enum NormalizationType
  {
    NONE,               
    TRIANGLE_SPECIFIED, 
    DIAGONAL_SPECIFIED, 
    DIAGONAL_VARIANCE,  
    NUM_NORMALIZATION_SCHEMES 
  };
 
  enum ProjectionType
  {
    FULL_BASIS,         
    FIXED_BASIS_SIZE,   
    FIXED_BASIS_ENERGY, 
    NUM_BASIS_SCHEMES   
  };
 
 
  vtkSetMacro(NormalizationScheme, int);
  vtkGetMacro(NormalizationScheme, int);
  virtual void SetNormalizationSchemeByName(const char* schemeName);
  virtual const char* GetNormalizationSchemeName(int scheme);
 
 
  virtual vtkTable* GetSpecifiedNormalization();
  virtual void SetSpecifiedNormalization(vtkTable*);
 
 
  void GetEigenvalues(int request, vtkDoubleArray*);
  void GetEigenvalues(vtkDoubleArray*);
  double GetEigenvalue(int request, int i);
  double GetEigenvalue(int i);
 
 
  void GetEigenvectors(int request, vtkDoubleArray* eigenvectors);
  void GetEigenvectors(vtkDoubleArray* eigenvectors);
  void GetEigenvector(int i, vtkDoubleArray* eigenvector);
  void GetEigenvector(int request, int i, vtkDoubleArray* eigenvector);
 
 
  vtkSetMacro(BasisScheme, int);
  vtkGetMacro(BasisScheme, int);
  virtual const char* GetBasisSchemeName(int schemeIndex);
  virtual void SetBasisSchemeByName(const char* schemeName);
 
 
  vtkSetMacro(FixedBasisSize, int);
  vtkGetMacro(FixedBasisSize, int);
 
 
  vtkSetClampMacro(FixedBasisEnergy, double, 0., 1.);
  vtkGetMacro(FixedBasisEnergy, double);
 
  bool SetParameter(const char* parameter, int index, vtkVariant value) override;
 
protected:
  vtkPCAStatistics();
  ~vtkPCAStatistics() override;
 
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  void Derive(vtkMultiBlockDataSet*) override;
 
  void Test(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override;
 
  void Assess(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override;
 
  virtual vtkDoubleArray* CalculatePValues(vtkIdTypeArray*, vtkDoubleArray*);
 
  void SelectAssessFunctor(vtkTable* inData, vtkDataObject* inMeta, vtkStringArray* rowNames,
    AssessFunctor*& dfunc) override;
 
  int NormalizationScheme;
  int BasisScheme;
  int FixedBasisSize;
  double FixedBasisEnergy;
 
  static const char* BasisSchemeEnumNames[NUM_BASIS_SCHEMES + 1];
  static const char* NormalizationSchemeEnumNames[NUM_NORMALIZATION_SCHEMES + 1];
 
private:
  vtkPCAStatistics(const vtkPCAStatistics&) = delete;
  void operator=(const vtkPCAStatistics&) = delete;
};
 
#endif // vtkPCAStatistics_h