de.lmu.ifi.dbs.elki.math.linearalgebra.pca

Class PCAFilteredRunner

java.lang.Object

de.lmu.ifi.dbs.elki.math.linearalgebra.pca.PCARunner

de.lmu.ifi.dbs.elki.math.linearalgebra.pca.PCAFilteredRunner

Direct Known Subclasses:

PCAFilteredAutotuningRunner

public class PCAFilteredRunner
extends PCARunner

PCA runner that will do dimensionality reduction. PCA is computed as with the regular runner, but afterwards, an EigenPairFilter is applied.

Since:

0.2

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PCAFilteredRunner.Parameterizer Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
private double	big Holds the value of PCAFilteredRunner.Parameterizer.BIG_ID.
private EigenPairFilter	eigenPairFilter Holds the instance of the EigenPairFilter specified by PCAFilteredRunner.Parameterizer.PCA_EIGENPAIR_FILTER.
private double	small Holds the value of PCAFilteredRunner.Parameterizer.SMALL_ID.

Fields inherited from class de.lmu.ifi.dbs.elki.math.linearalgebra.pca.PCARunner

covarianceMatrixBuilder

Constructor Summary

Constructors

Constructor and Description
PCAFilteredRunner(CovarianceMatrixBuilder covarianceMatrixBuilder, EigenPairFilter eigenPairFilter, double big, double small) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected EigenPairFilter	getEigenPairFilter() Retrieve the EigenPairFilter to be used.
PCAFilteredResult	processCovarMatrix(Matrix covarMatrix) Process an existing Covariance Matrix.
PCAFilteredResult	processEVD(EigenvalueDecomposition evd) Process an existing eigenvalue decomposition.
PCAFilteredResult	processIds(DBIDs ids, Relation<? extends NumberVector> database) Run PCA on a collection of database IDs.
PCAFilteredResult	processQueryResult(DoubleDBIDList results, Relation<? extends NumberVector> database) Run PCA on a QueryResult Collection.

Methods inherited from class de.lmu.ifi.dbs.elki.math.linearalgebra.pca.PCARunner

getCovarianceMatrixBuilder, processDatabase, setCovarianceMatrixBuilder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

eigenPairFilter

private EigenPairFilter eigenPairFilter

Holds the instance of the EigenPairFilter specified by PCAFilteredRunner.Parameterizer.PCA_EIGENPAIR_FILTER.

big

private double big

Holds the value of PCAFilteredRunner.Parameterizer.BIG_ID.

small

private double small

Holds the value of PCAFilteredRunner.Parameterizer.SMALL_ID.

Constructor Detail

PCAFilteredRunner

public PCAFilteredRunner(CovarianceMatrixBuilder covarianceMatrixBuilder,
                 EigenPairFilter eigenPairFilter,
                 double big,
                 double small)

Constructor.

Parameters:

covarianceMatrixBuilder - Covariance matrix builder

eigenPairFilter - Eigen pair filter

big - Replacement for large eigenvalues

small - Replacement for small eigenvalues

Method Detail

processIds

public PCAFilteredResult processIds(DBIDs ids,
                           Relation<? extends NumberVector> database)

Run PCA on a collection of database IDs.

Overrides:

processIds in class PCARunner

Parameters:

ids - a collection of ids

database - the database used

Returns:

PCA result

processQueryResult

public PCAFilteredResult processQueryResult(DoubleDBIDList results,
                                   Relation<? extends NumberVector> database)

Run PCA on a QueryResult Collection.

Overrides:

processQueryResult in class PCARunner

Parameters:

results - a collection of QueryResults

database - the database used

Returns:

PCA result

processCovarMatrix

public PCAFilteredResult processCovarMatrix(Matrix covarMatrix)

Process an existing Covariance Matrix.

Overrides:

processCovarMatrix in class PCARunner

Parameters:

covarMatrix - the matrix used for performing PCA

Returns:

Filtered result

processEVD

public PCAFilteredResult processEVD(EigenvalueDecomposition evd)

Process an existing eigenvalue decomposition.

Overrides:

processEVD in class PCARunner

Parameters:

evd - eigenvalue decomposition to use

Returns:

filtered result

getEigenPairFilter

protected EigenPairFilter getEigenPairFilter()

Retrieve the EigenPairFilter to be used. For derived PCA Runners

Returns:

eigenpair filter configured.