Click or drag to resize
Accord.NET (logo)

BasePrincipalComponentAnalysis Class

Base class for Principal Component Analyses (PCA and KPCA).
Inheritance Hierarchy
SystemObject
  Accord.MachineLearningTransformBaseDouble, Double
    Accord.MachineLearningMultipleTransformBaseDouble, Double
      Accord.Statistics.Analysis.BaseBasePrincipalComponentAnalysis
        Accord.Statistics.AnalysisKernelPrincipalComponentAnalysis
        Accord.Statistics.AnalysisPrincipalComponentAnalysis

Namespace:  Accord.Statistics.Analysis.Base
Assembly:  Accord.Statistics (in Accord.Statistics.dll) Version: 3.8.0
Syntax
[SerializableAttribute]
public abstract class BasePrincipalComponentAnalysis : MultipleTransformBase<double[], double>
Request Example View Source

The BasePrincipalComponentAnalysis type exposes the following members.

Constructors
  NameDescription
Public methodBasePrincipalComponentAnalysis
Initializes a new instance of the BasePrincipalComponentAnalysis class.
Top
Properties
  NameDescription
Public propertyComponentMatrix Obsolete.
Gets a matrix whose columns contain the principal components. Also known as the Eigenvectors or loadings matrix.
Public propertyComponentProportions
The respective role each component plays in the data set.
Public propertyComponents
Gets the Principal Components in a object-oriented structure.
Public propertyComponentVectors
Gets a matrix whose columns contain the principal components. Also known as the Eigenvectors or loadings matrix.
Public propertyCumulativeProportions
The cumulative distribution of the components proportion role. Also known as the cumulative energy of the principal components.
Public propertyEigenvalues
Provides access to the Eigenvalues stored during the analysis.
Public propertyExplainedVariance
Gets or sets the amount of explained variance that should be generated by this model. This value will alter the NumberOfOutputs that can be generated by this model.
Public propertyMaximumNumberOfOutputs
Gets the maximum number of outputs (dimensionality of the output vectors) that can be generated by this model.
Public propertyMeans
Gets the column mean of the source data given at method construction.
Public propertyMethod
Gets or sets the method used by this analysis.
Public propertyNumberOfInputs
Gets the number of inputs accepted by the model.
(Inherited from TransformBaseTInput, TOutput.)
Public propertyNumberOfOutputs
Gets or sets the number of outputs (dimensionality of the output vectors) that should be generated by this model.
Public propertyOverwrite
Gets or sets whether calculations will be performed overwriting data in the original source matrix, using less memory.
Public propertyResult Obsolete.
Gets the resulting projection of the source data given on the creation of the analysis into the space spawned by principal components.
Public propertySingularValues
Provides access to the Singular Values stored during the analysis. If a covariance method is chosen, then it will contain an empty vector.
Public propertySource Obsolete.
Returns the original data supplied to the analysis.
Public propertyStandardDeviations
Gets the column standard deviations of the source data given at method construction.
Public propertyToken
Gets or sets a cancellation token that can be used to cancel the algorithm while it is running.
Public propertyWhiten
Gets or sets whether the transformation result should be whitened (have unit standard deviation) before it is returned.
Top
Methods
  NameDescription
Protected methodCreateComponents
Creates additional information about principal components.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNumberOfComponents
Returns the minimal number of principal components required to represent a given percentile of the data.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTransform(TInput)
Applies the transformation to a set of input vectors, producing an associated set of output vectors.
(Inherited from MultipleTransformBaseTInput, TOutput.)
Public methodTransform(Double) Obsolete.
Obsolete.
Public methodTransform(Double)
Applies the transformation to an input, producing an associated output.
(Overrides MultipleTransformBaseTInput, TOutputTransform(TInput).)
Public methodTransform(TInput, TOutput)
Applies the transformation to an input, producing an associated output.
(Inherited from MultipleTransformBaseTInput, TOutput.)
Public methodTransform(Double, Int32) Obsolete.
Projects a given matrix into principal component space.
Public methodTransform(Double, Double)
Applies the transformation to an input, producing an associated output.
(Overrides MultipleTransformBaseTInput, TOutputTransform(TInput, TOutput).)
Public methodTransform(Double, Int32) Obsolete.
Projects a given matrix into principal component space.
Public methodTransform(Double, Int32) Obsolete.
Projects a given matrix into principal component space.
Top
Fields
  NameDescription
Protected fieldarray
Obsolete
Protected fieldcovarianceMatrix
Obsolete
Protected fieldonlyCovarianceMatrixAvailable
Obsolete
Protected fieldresult
Obsolete
Protected fieldsaveResult
Obsolete
Protected fieldsource
Obsolete
Top
Extension Methods
  NameDescription
Public Extension MethodHasMethod
Checks whether an object implements a method with the given name.
(Defined by ExtensionMethods.)
Public Extension MethodIsEqual
Compares two objects for equality, performing an elementwise comparison if the elements are vectors or matrices.
(Defined by Matrix.)
Public Extension MethodTo(Type)Overloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Public Extension MethodToTOverloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Top
See Also