ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkPCAStatistics Class Reference

vtkPCAStatistics - A class for principal component analysis More...

Inheritance diagram for Kitware.VTK.vtkPCAStatistics:
[legend]
Collaboration diagram for Kitware.VTK.vtkPCAStatistics:
[legend]

List of all members.

Public Types

enum  NormalizationType {
  DIAGONAL_SPECIFIED = 2, DIAGONAL_VARIANCE = 3, NONE = 0, NUM_NORMALIZATION_SCHEMES = 4,
  TRIANGLE_SPECIFIED = 1
}
 Undocumented Block. More...
enum  ProjectionType { FIXED_BASIS_ENERGY = 2, FIXED_BASIS_SIZE = 1, FULL_BASIS = 0, NUM_BASIS_SCHEMES = 3 }
 Undocumented Block. More...

Public Member Functions

 vtkPCAStatistics (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPCAStatistics ()
 Undocumented Block.
virtual int GetBasisScheme ()
 This variable controls the dimensionality of output tuples in Assess mode. Consider the case where you have requested a PCA on D columns.
virtual string GetBasisSchemeName (int schemeIndex)
 This variable controls the dimensionality of output tuples in Assess mode. Consider the case where you have requested a PCA on D columns.
double GetEigenvalue (int request, int i)
 Get the eigenvalues. This function: void GetEigenvalues(int request, int i, vtkDoubleArray*); does all of the work. The other functions simply call this function with the appropriate parameters. These functions are not valid unless Update() has been called and the Derive option is turned on.
double GetEigenvalue (int i)
 Get the eigenvalues. This function: void GetEigenvalues(int request, int i, vtkDoubleArray*); does all of the work. The other functions simply call this function with the appropriate parameters. These functions are not valid unless Update() has been called and the Derive option is turned on.
void GetEigenvalues (int request, vtkDoubleArray arg1)
 Get the eigenvalues. This function: void GetEigenvalues(int request, int i, vtkDoubleArray*); does all of the work. The other functions simply call this function with the appropriate parameters. These functions are not valid unless Update() has been called and the Derive option is turned on.
void GetEigenvalues (vtkDoubleArray arg0)
 Get the eigenvalues. This function: void GetEigenvalues(int request, int i, vtkDoubleArray*); does all of the work. The other functions simply call this function with the appropriate parameters. These functions are not valid unless Update() has been called and the Derive option is turned on.
void GetEigenvector (int i, vtkDoubleArray eigenvector)
 Get the eigenvectors. This function: void GetEigenvectors(int request, vtkDoubleArray* eigenvectors) does all of the work. The other functions are convenience functions that call this function with default arguments. These functions are not valid unless Update() has been called and the Derive option is turned on.
void GetEigenvector (int request, int i, vtkDoubleArray eigenvector)
 Get the eigenvectors. This function: void GetEigenvectors(int request, vtkDoubleArray* eigenvectors) does all of the work. The other functions are convenience functions that call this function with default arguments. These functions are not valid unless Update() has been called and the Derive option is turned on.
void GetEigenvectors (int request, vtkDoubleArray eigenvectors)
 Get the eigenvectors. This function: void GetEigenvectors(int request, vtkDoubleArray* eigenvectors) does all of the work. The other functions are convenience functions that call this function with default arguments. These functions are not valid unless Update() has been called and the Derive option is turned on.
void GetEigenvectors (vtkDoubleArray eigenvectors)
 Get the eigenvectors. This function: void GetEigenvectors(int request, vtkDoubleArray* eigenvectors) does all of the work. The other functions are convenience functions that call this function with default arguments. These functions are not valid unless Update() has been called and the Derive option is turned on.
virtual double GetFixedBasisEnergy ()
 The minimum energy the new basis should use, as a fraction. See SetBasisScheme() for more information. When FixedBasisEnergy >= 1 (the default), the fixed basis energy scheme is equivalent to the full basis scheme.
virtual double GetFixedBasisEnergyMaxValue ()
 The minimum energy the new basis should use, as a fraction. See SetBasisScheme() for more information. When FixedBasisEnergy >= 1 (the default), the fixed basis energy scheme is equivalent to the full basis scheme.
virtual double GetFixedBasisEnergyMinValue ()
 The minimum energy the new basis should use, as a fraction. See SetBasisScheme() for more information. When FixedBasisEnergy >= 1 (the default), the fixed basis energy scheme is equivalent to the full basis scheme.
virtual int GetFixedBasisSize ()
 The number of basis vectors to use. See SetBasisScheme() for more information. When FixedBasisSize <= 0 (the default), the fixed basis size scheme is equivalent to the full basis scheme.
virtual int GetNormalizationScheme ()
 This determines how (or if) the covariance matrix cov is normalized before PCA.
virtual string GetNormalizationSchemeName (int scheme)
 This determines how (or if) the covariance matrix cov is normalized before PCA.
virtual vtkTable GetSpecifiedNormalization ()
 These methods allow you to set/get values used to normalize the covariance matrix before PCA. The normalization values apply to all requests, so you do not specify a single vector but a 3-column table.
override int IsA (string type)
 Undocumented Block.
new vtkPCAStatistics NewInstance ()
 Undocumented Block.
virtual void SetBasisScheme (int _arg)
 This variable controls the dimensionality of output tuples in Assess mode. Consider the case where you have requested a PCA on D columns.
virtual void SetBasisSchemeByName (string schemeName)
 This variable controls the dimensionality of output tuples in Assess mode. Consider the case where you have requested a PCA on D columns.
virtual void SetFixedBasisEnergy (double _arg)
 The minimum energy the new basis should use, as a fraction. See SetBasisScheme() for more information. When FixedBasisEnergy >= 1 (the default), the fixed basis energy scheme is equivalent to the full basis scheme.
virtual void SetFixedBasisSize (int _arg)
 The number of basis vectors to use. See SetBasisScheme() for more information. When FixedBasisSize <= 0 (the default), the fixed basis size scheme is equivalent to the full basis scheme.
virtual void SetNormalizationScheme (int _arg)
 This determines how (or if) the covariance matrix cov is normalized before PCA.
virtual void SetNormalizationSchemeByName (string sname)
 This determines how (or if) the covariance matrix cov is normalized before PCA.
virtual void SetSpecifiedNormalization (vtkTable arg0)
 These methods allow you to set/get values used to normalize the covariance matrix before PCA. The normalization values apply to all requests, so you do not specify a single vector but a 3-column table.

Static Public Member Functions

static new vtkPCAStatistics New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkPCAStatistics SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkPCAStatistics"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkPCAStatistics"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkPCAStatistics_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkPCAStatistics_GetBasisScheme_01 (HandleRef pThis)
static internal IntPtr vtkPCAStatistics_GetBasisSchemeName_02 (HandleRef pThis, int schemeIndex)
static internal double vtkPCAStatistics_GetEigenvalue_03 (HandleRef pThis, int request, int i)
static internal double vtkPCAStatistics_GetEigenvalue_04 (HandleRef pThis, int i)
static internal void vtkPCAStatistics_GetEigenvalues_05 (HandleRef pThis, int request, HandleRef arg1)
static internal void vtkPCAStatistics_GetEigenvalues_06 (HandleRef pThis, HandleRef arg0)
static internal void vtkPCAStatistics_GetEigenvector_07 (HandleRef pThis, int i, HandleRef eigenvector)
static internal void vtkPCAStatistics_GetEigenvector_08 (HandleRef pThis, int request, int i, HandleRef eigenvector)
static internal void vtkPCAStatistics_GetEigenvectors_09 (HandleRef pThis, int request, HandleRef eigenvectors)
static internal void vtkPCAStatistics_GetEigenvectors_10 (HandleRef pThis, HandleRef eigenvectors)
static internal double vtkPCAStatistics_GetFixedBasisEnergy_11 (HandleRef pThis)
static internal double vtkPCAStatistics_GetFixedBasisEnergyMaxValue_12 (HandleRef pThis)
static internal double vtkPCAStatistics_GetFixedBasisEnergyMinValue_13 (HandleRef pThis)
static internal int vtkPCAStatistics_GetFixedBasisSize_14 (HandleRef pThis)
static internal int vtkPCAStatistics_GetNormalizationScheme_15 (HandleRef pThis)
static internal IntPtr vtkPCAStatistics_GetNormalizationSchemeName_16 (HandleRef pThis, int scheme)
static internal IntPtr vtkPCAStatistics_GetSpecifiedNormalization_17 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkPCAStatistics_IsA_18 (HandleRef pThis, string type)
static internal int vtkPCAStatistics_IsTypeOf_19 (string type)
static internal IntPtr vtkPCAStatistics_NewInstance_21 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkPCAStatistics_SafeDownCast_22 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPCAStatistics_SetBasisScheme_23 (HandleRef pThis, int _arg)
static internal void vtkPCAStatistics_SetBasisSchemeByName_24 (HandleRef pThis, string schemeName)
static internal void vtkPCAStatistics_SetFixedBasisEnergy_25 (HandleRef pThis, double _arg)
static internal void vtkPCAStatistics_SetFixedBasisSize_26 (HandleRef pThis, int _arg)
static internal void vtkPCAStatistics_SetNormalizationScheme_27 (HandleRef pThis, int _arg)
static internal void vtkPCAStatistics_SetNormalizationSchemeByName_28 (HandleRef pThis, string sname)
static internal void vtkPCAStatistics_SetSpecifiedNormalization_29 (HandleRef pThis, HandleRef arg0)

Static Private Member Functions

static vtkPCAStatistics ()
 Automatically generated type registration mechanics.

Detailed Description

vtkPCAStatistics - A class for principal component analysis

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 computes the SVD of the covariance matrix in order to obtain its eigenvectors.

In the assess mode, the input data are

Thanks Thanks to David Thompson, Philippe Pebay and Jackson Mayo from Sandia National Laboratories for implementing this class.


Member Enumeration Documentation

Undocumented Block.

Enumerator:
DIAGONAL_SPECIFIED 

enum member

DIAGONAL_VARIANCE 

enum member

NONE 

enum member

NUM_NORMALIZATION_SCHEMES 

enum member

TRIANGLE_SPECIFIED 

enum member

Undocumented Block.

Enumerator:
FIXED_BASIS_ENERGY 

enum member

FIXED_BASIS_SIZE 

enum member

FULL_BASIS 

enum member

NUM_BASIS_SCHEMES 

enum member


Constructor & Destructor Documentation

static Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkPCAStatistics.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkMultiCorrelativeStatistics.

Reimplemented in Kitware.VTK.vtkPPCAStatistics.

This variable controls the dimensionality of output tuples in Assess mode. Consider the case where you have requested a PCA on D columns.

When set to vtkPCAStatistics::FULL_BASIS, the entire set of basis vectors is used to derive new coordinates for each tuple being assessed. In this mode, you are guaranteed to have output tuples of the same dimension as the input tuples. (That dimension is D, so there will be D additional columns added to the table for the request.)

When set to vtkPCAStatistics::FIXED_BASIS_SIZE, only the first N basis vectors are used to derive new coordinates for each tuple being assessed. In this mode, you are guaranteed to have output tuples of dimension min(N,D). You must set N prior to assessing data using the SetFixedBasisSize() method. When N < D, this turns the PCA into a projection (instead of change of basis).

When set to vtkPCAStatistics::FIXED_BASIS_ENERGY, the number of basis vectors used to derive new coordinates for each tuple will be the minimum number of columns N that satisfy

\[ \frac{\sum_{i=1}^{N} \lambda_i}{\sum_{i=1}^{D} \lambda_i} &lt; T \]

You must set T prior to assessing data using the SetFixedBasisEnergy() method. When T < 1, this turns the PCA into a projection (instead of change of basis).

By default BasisScheme is set to vtkPCAStatistics::FULL_BASIS.

virtual string Kitware.VTK.vtkPCAStatistics.GetBasisSchemeName ( int  schemeIndex) [virtual]

This variable controls the dimensionality of output tuples in Assess mode. Consider the case where you have requested a PCA on D columns.

When set to vtkPCAStatistics::FULL_BASIS, the entire set of basis vectors is used to derive new coordinates for each tuple being assessed. In this mode, you are guaranteed to have output tuples of the same dimension as the input tuples. (That dimension is D, so there will be D additional columns added to the table for the request.)

When set to vtkPCAStatistics::FIXED_BASIS_SIZE, only the first N basis vectors are used to derive new coordinates for each tuple being assessed. In this mode, you are guaranteed to have output tuples of dimension min(N,D). You must set N prior to assessing data using the SetFixedBasisSize() method. When N < D, this turns the PCA into a projection (instead of change of basis).

When set to vtkPCAStatistics::FIXED_BASIS_ENERGY, the number of basis vectors used to derive new coordinates for each tuple will be the minimum number of columns N that satisfy

\[ \frac{\sum_{i=1}^{N} \lambda_i}{\sum_{i=1}^{D} \lambda_i} &lt; T \]

You must set T prior to assessing data using the SetFixedBasisEnergy() method. When T < 1, this turns the PCA into a projection (instead of change of basis).

By default BasisScheme is set to vtkPCAStatistics::FULL_BASIS.

double Kitware.VTK.vtkPCAStatistics.GetEigenvalue ( int  request,
int  i 
)

Get the eigenvalues. This function: void GetEigenvalues(int request, int i, vtkDoubleArray*); does all of the work. The other functions simply call this function with the appropriate parameters. These functions are not valid unless Update() has been called and the Derive option is turned on.

Get the eigenvalues. This function: void GetEigenvalues(int request, int i, vtkDoubleArray*); does all of the work. The other functions simply call this function with the appropriate parameters. These functions are not valid unless Update() has been called and the Derive option is turned on.

Get the eigenvalues. This function: void GetEigenvalues(int request, int i, vtkDoubleArray*); does all of the work. The other functions simply call this function with the appropriate parameters. These functions are not valid unless Update() has been called and the Derive option is turned on.

Get the eigenvalues. This function: void GetEigenvalues(int request, int i, vtkDoubleArray*); does all of the work. The other functions simply call this function with the appropriate parameters. These functions are not valid unless Update() has been called and the Derive option is turned on.

Get the eigenvectors. This function: void GetEigenvectors(int request, vtkDoubleArray* eigenvectors) does all of the work. The other functions are convenience functions that call this function with default arguments. These functions are not valid unless Update() has been called and the Derive option is turned on.

void Kitware.VTK.vtkPCAStatistics.GetEigenvector ( int  request,
int  i,
vtkDoubleArray  eigenvector 
)

Get the eigenvectors. This function: void GetEigenvectors(int request, vtkDoubleArray* eigenvectors) does all of the work. The other functions are convenience functions that call this function with default arguments. These functions are not valid unless Update() has been called and the Derive option is turned on.

void Kitware.VTK.vtkPCAStatistics.GetEigenvectors ( int  request,
vtkDoubleArray  eigenvectors 
)

Get the eigenvectors. This function: void GetEigenvectors(int request, vtkDoubleArray* eigenvectors) does all of the work. The other functions are convenience functions that call this function with default arguments. These functions are not valid unless Update() has been called and the Derive option is turned on.

Get the eigenvectors. This function: void GetEigenvectors(int request, vtkDoubleArray* eigenvectors) does all of the work. The other functions are convenience functions that call this function with default arguments. These functions are not valid unless Update() has been called and the Derive option is turned on.

The minimum energy the new basis should use, as a fraction. See SetBasisScheme() for more information. When FixedBasisEnergy >= 1 (the default), the fixed basis energy scheme is equivalent to the full basis scheme.

The minimum energy the new basis should use, as a fraction. See SetBasisScheme() for more information. When FixedBasisEnergy >= 1 (the default), the fixed basis energy scheme is equivalent to the full basis scheme.

The minimum energy the new basis should use, as a fraction. See SetBasisScheme() for more information. When FixedBasisEnergy >= 1 (the default), the fixed basis energy scheme is equivalent to the full basis scheme.

The number of basis vectors to use. See SetBasisScheme() for more information. When FixedBasisSize <= 0 (the default), the fixed basis size scheme is equivalent to the full basis scheme.

This determines how (or if) the covariance matrix cov is normalized before PCA.

When set to NONE, no normalization is performed. This is the default.

When set to TRIANGLE_SPECIFIED, each entry cov(i,j) is divided by V(i,j). The list V of normalization factors must be set using the SetNormalization method before the filter is executed.

When set to DIAGONAL_SPECIFIED, each entry cov(i,j) is divided by sqrt(V(i)*V(j)). The list V of normalization factors must be set using the SetNormalization method before the filter is executed.

When set to DIAGONAL_VARIANCE, each entry cov(i,j) is divided by sqrt(cov(i,i)*cov(j,j)). <b>Warning</b>: Although this is accepted practice in some fields, some people think you should not turn this option on unless there is a good physically-based reason for doing so. Much better instead to determine how component magnitudes should be compared using physical reasoning and use DIAGONAL_SPECIFIED, TRIANGLE_SPECIFIED, or perform some pre-processing to shift and scale input data columns appropriately than to expect magical results from a shady normalization hack.

virtual string Kitware.VTK.vtkPCAStatistics.GetNormalizationSchemeName ( int  scheme) [virtual]

This determines how (or if) the covariance matrix cov is normalized before PCA.

When set to NONE, no normalization is performed. This is the default.

When set to TRIANGLE_SPECIFIED, each entry cov(i,j) is divided by V(i,j). The list V of normalization factors must be set using the SetNormalization method before the filter is executed.

When set to DIAGONAL_SPECIFIED, each entry cov(i,j) is divided by sqrt(V(i)*V(j)). The list V of normalization factors must be set using the SetNormalization method before the filter is executed.

When set to DIAGONAL_VARIANCE, each entry cov(i,j) is divided by sqrt(cov(i,i)*cov(j,j)). <b>Warning</b>: Although this is accepted practice in some fields, some people think you should not turn this option on unless there is a good physically-based reason for doing so. Much better instead to determine how component magnitudes should be compared using physical reasoning and use DIAGONAL_SPECIFIED, TRIANGLE_SPECIFIED, or perform some pre-processing to shift and scale input data columns appropriately than to expect magical results from a shady normalization hack.

These methods allow you to set/get values used to normalize the covariance matrix before PCA. The normalization values apply to all requests, so you do not specify a single vector but a 3-column table.

The first two columns contain the names of columns from input 0 and the third column contains the value to normalize the corresponding entry in the covariance matrix. The table must always have 3 columns even when the NormalizationScheme is DIAGONAL_SPECIFIED. When only diagonal entries are to be used, only table rows where the first two columns are identical to one another will be employed. If there are multiple rows specifying different values for the same pair of columns, the entry nearest the bottom of the table takes precedence.

These functions are actually convenience methods that set/get the third input of the filter. Because the table is the third input, you may use other filters to produce a table of normalizations and have the pipeline take care of updates.

Any missing entries will be set to 1.0 and a warning issued. An error will occur if the third input to the filter is not set and the NormalizationScheme is DIAGONAL_SPECIFIED or TRIANGLE_SPECIFIED.

Here is the call graph for this function:

override int Kitware.VTK.vtkPCAStatistics.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkMultiCorrelativeStatistics.

Reimplemented in Kitware.VTK.vtkPPCAStatistics.

static new int Kitware.VTK.vtkPCAStatistics.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkMultiCorrelativeStatistics.

Reimplemented in Kitware.VTK.vtkPPCAStatistics.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkMultiCorrelativeStatistics.

Reimplemented in Kitware.VTK.vtkPPCAStatistics.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkMultiCorrelativeStatistics.

Reimplemented in Kitware.VTK.vtkPPCAStatistics.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkMultiCorrelativeStatistics.

Reimplemented in Kitware.VTK.vtkPPCAStatistics.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkPCAStatistics.SetBasisScheme ( int  _arg) [virtual]

This variable controls the dimensionality of output tuples in Assess mode. Consider the case where you have requested a PCA on D columns.

When set to vtkPCAStatistics::FULL_BASIS, the entire set of basis vectors is used to derive new coordinates for each tuple being assessed. In this mode, you are guaranteed to have output tuples of the same dimension as the input tuples. (That dimension is D, so there will be D additional columns added to the table for the request.)

When set to vtkPCAStatistics::FIXED_BASIS_SIZE, only the first N basis vectors are used to derive new coordinates for each tuple being assessed. In this mode, you are guaranteed to have output tuples of dimension min(N,D). You must set N prior to assessing data using the SetFixedBasisSize() method. When N < D, this turns the PCA into a projection (instead of change of basis).

When set to vtkPCAStatistics::FIXED_BASIS_ENERGY, the number of basis vectors used to derive new coordinates for each tuple will be the minimum number of columns N that satisfy

\[ \frac{\sum_{i=1}^{N} \lambda_i}{\sum_{i=1}^{D} \lambda_i} &lt; T \]

You must set T prior to assessing data using the SetFixedBasisEnergy() method. When T < 1, this turns the PCA into a projection (instead of change of basis).

By default BasisScheme is set to vtkPCAStatistics::FULL_BASIS.

virtual void Kitware.VTK.vtkPCAStatistics.SetBasisSchemeByName ( string  schemeName) [virtual]

This variable controls the dimensionality of output tuples in Assess mode. Consider the case where you have requested a PCA on D columns.

When set to vtkPCAStatistics::FULL_BASIS, the entire set of basis vectors is used to derive new coordinates for each tuple being assessed. In this mode, you are guaranteed to have output tuples of the same dimension as the input tuples. (That dimension is D, so there will be D additional columns added to the table for the request.)

When set to vtkPCAStatistics::FIXED_BASIS_SIZE, only the first N basis vectors are used to derive new coordinates for each tuple being assessed. In this mode, you are guaranteed to have output tuples of dimension min(N,D). You must set N prior to assessing data using the SetFixedBasisSize() method. When N < D, this turns the PCA into a projection (instead of change of basis).

When set to vtkPCAStatistics::FIXED_BASIS_ENERGY, the number of basis vectors used to derive new coordinates for each tuple will be the minimum number of columns N that satisfy

\[ \frac{\sum_{i=1}^{N} \lambda_i}{\sum_{i=1}^{D} \lambda_i} &lt; T \]

You must set T prior to assessing data using the SetFixedBasisEnergy() method. When T < 1, this turns the PCA into a projection (instead of change of basis).

By default BasisScheme is set to vtkPCAStatistics::FULL_BASIS.

virtual void Kitware.VTK.vtkPCAStatistics.SetFixedBasisEnergy ( double  _arg) [virtual]

The minimum energy the new basis should use, as a fraction. See SetBasisScheme() for more information. When FixedBasisEnergy >= 1 (the default), the fixed basis energy scheme is equivalent to the full basis scheme.

virtual void Kitware.VTK.vtkPCAStatistics.SetFixedBasisSize ( int  _arg) [virtual]

The number of basis vectors to use. See SetBasisScheme() for more information. When FixedBasisSize <= 0 (the default), the fixed basis size scheme is equivalent to the full basis scheme.

virtual void Kitware.VTK.vtkPCAStatistics.SetNormalizationScheme ( int  _arg) [virtual]

This determines how (or if) the covariance matrix cov is normalized before PCA.

When set to NONE, no normalization is performed. This is the default.

When set to TRIANGLE_SPECIFIED, each entry cov(i,j) is divided by V(i,j). The list V of normalization factors must be set using the SetNormalization method before the filter is executed.

When set to DIAGONAL_SPECIFIED, each entry cov(i,j) is divided by sqrt(V(i)*V(j)). The list V of normalization factors must be set using the SetNormalization method before the filter is executed.

When set to DIAGONAL_VARIANCE, each entry cov(i,j) is divided by sqrt(cov(i,i)*cov(j,j)). <b>Warning</b>: Although this is accepted practice in some fields, some people think you should not turn this option on unless there is a good physically-based reason for doing so. Much better instead to determine how component magnitudes should be compared using physical reasoning and use DIAGONAL_SPECIFIED, TRIANGLE_SPECIFIED, or perform some pre-processing to shift and scale input data columns appropriately than to expect magical results from a shady normalization hack.

virtual void Kitware.VTK.vtkPCAStatistics.SetNormalizationSchemeByName ( string  sname) [virtual]

This determines how (or if) the covariance matrix cov is normalized before PCA.

When set to NONE, no normalization is performed. This is the default.

When set to TRIANGLE_SPECIFIED, each entry cov(i,j) is divided by V(i,j). The list V of normalization factors must be set using the SetNormalization method before the filter is executed.

When set to DIAGONAL_SPECIFIED, each entry cov(i,j) is divided by sqrt(V(i)*V(j)). The list V of normalization factors must be set using the SetNormalization method before the filter is executed.

When set to DIAGONAL_VARIANCE, each entry cov(i,j) is divided by sqrt(cov(i,i)*cov(j,j)). <b>Warning</b>: Although this is accepted practice in some fields, some people think you should not turn this option on unless there is a good physically-based reason for doing so. Much better instead to determine how component magnitudes should be compared using physical reasoning and use DIAGONAL_SPECIFIED, TRIANGLE_SPECIFIED, or perform some pre-processing to shift and scale input data columns appropriately than to expect magical results from a shady normalization hack.

These methods allow you to set/get values used to normalize the covariance matrix before PCA. The normalization values apply to all requests, so you do not specify a single vector but a 3-column table.

The first two columns contain the names of columns from input 0 and the third column contains the value to normalize the corresponding entry in the covariance matrix. The table must always have 3 columns even when the NormalizationScheme is DIAGONAL_SPECIFIED. When only diagonal entries are to be used, only table rows where the first two columns are identical to one another will be employed. If there are multiple rows specifying different values for the same pair of columns, the entry nearest the bottom of the table takes precedence.

These functions are actually convenience methods that set/get the third input of the filter. Because the table is the third input, you may use other filters to produce a table of normalizations and have the pipeline take care of updates.

Any missing entries will be set to 1.0 and a warning issued. An error will occur if the third input to the filter is not set and the NormalizationScheme is DIAGONAL_SPECIFIED or TRIANGLE_SPECIFIED.

static internal int Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetBasisScheme_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetBasisSchemeName_02 ( HandleRef  pThis,
int  schemeIndex 
) [private]
static internal double Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetEigenvalue_03 ( HandleRef  pThis,
int  request,
int  i 
) [private]
static internal double Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetEigenvalue_04 ( HandleRef  pThis,
int  i 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetEigenvalues_05 ( HandleRef  pThis,
int  request,
HandleRef  arg1 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetEigenvalues_06 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetEigenvector_07 ( HandleRef  pThis,
int  i,
HandleRef  eigenvector 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetEigenvector_08 ( HandleRef  pThis,
int  request,
int  i,
HandleRef  eigenvector 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetEigenvectors_09 ( HandleRef  pThis,
int  request,
HandleRef  eigenvectors 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetEigenvectors_10 ( HandleRef  pThis,
HandleRef  eigenvectors 
) [private]
static internal double Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetFixedBasisEnergy_11 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetFixedBasisEnergyMaxValue_12 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetFixedBasisEnergyMinValue_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetFixedBasisSize_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetNormalizationScheme_15 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetNormalizationSchemeName_16 ( HandleRef  pThis,
int  scheme 
) [private]
static internal IntPtr Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_GetSpecifiedNormalization_17 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_IsA_18 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_IsTypeOf_19 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_NewInstance_21 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_SafeDownCast_22 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_SetBasisScheme_23 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_SetBasisSchemeByName_24 ( HandleRef  pThis,
string  schemeName 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_SetFixedBasisEnergy_25 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_SetFixedBasisSize_26 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_SetNormalizationScheme_27 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_SetNormalizationSchemeByName_28 ( HandleRef  pThis,
string  sname 
) [private]
static internal void Kitware.VTK.vtkPCAStatistics.vtkPCAStatistics_SetSpecifiedNormalization_29 ( HandleRef  pThis,
HandleRef  arg0 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkPCAStatistics.MRClassNameKey = "16vtkPCAStatistics" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkMultiCorrelativeStatistics.

Reimplemented in Kitware.VTK.vtkPPCAStatistics.

new const string Kitware.VTK.vtkPCAStatistics.MRFullTypeName = "Kitware.VTK.vtkPCAStatistics"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkMultiCorrelativeStatistics.

Reimplemented in Kitware.VTK.vtkPPCAStatistics.


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