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

java.lang.Object
  de.lmu.ifi.dbs.elki.math.linearalgebra.pca.FirstNEigenPairFilter

All Implemented Interfaces:

EigenPairFilter, InspectionUtilFrequentlyScanned, Parameterizable

@Title(value="First n Eigenpair filter")
@Description(value="Sorts the eigenpairs in decending order of their eigenvalues and marks the first n eigenpairs as strong eigenpairs.")
public class FirstNEigenPairFilter
extends Object
implements EigenPairFilter

The FirstNEigenPairFilter marks the n highest eigenpairs as strong eigenpairs, where n is a user specified number.

Nested Class Summary

static class

FirstNEigenPairFilter.Parameterizer Parameterization class.

Field Summary

static OptionID	EIGENPAIR_FILTER_N Paremeter n
private static Logging	logger The logger for this class.
private int	n The threshold for strong eigenvectors: n eigenvectors with the n highest eigenvalues are marked as strong eigenvectors.

Constructor Summary

FirstNEigenPairFilter(int n)
Constructor.

Method Summary

FilteredEigenPairs

filter(SortedEigenPairs eigenPairs) Filters the specified eigenpairs into strong and weak eigenpairs, where strong eigenpairs having high variances and weak eigenpairs having small variances.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logging logger

The logger for this class.

EIGENPAIR_FILTER_N

public static final OptionID EIGENPAIR_FILTER_N

Paremeter n

n

private int n

The threshold for strong eigenvectors: n eigenvectors with the n highest eigenvalues are marked as strong eigenvectors.

Constructor Detail

FirstNEigenPairFilter

public FirstNEigenPairFilter(int n)

Constructor.

Parameters:

n -

Method Detail

filter

public FilteredEigenPairs filter(SortedEigenPairs eigenPairs)

Description copied from interface: EigenPairFilter

Filters the specified eigenpairs into strong and weak eigenpairs, where strong eigenpairs having high variances and weak eigenpairs having small variances.

Specified by:

filter in interface EigenPairFilter

Parameters:

eigenPairs - the eigenPairs (i.e. the eigenvectors and

Returns:

the filtered eigenpairs