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

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

All Implemented Interfaces:

EigenPairFilter, 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 AbstractLoggable
implements EigenPairFilter, Parameterizable

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

Author:

Elke Achtert

Field Summary

static OptionID	EIGENPAIR_FILTER_N OptionID for N_PARAM
private double	n The threshold for strong eigenvectors: n eigenvectors with the n highest eigenvalues are marked as strong eigenvectors.
private IntParameter	N_PARAM Parameter n.

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug, logger

Constructor Summary

FirstNEigenPairFilter(Parameterization config)
Constructor, adhering to Parameterizable

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 de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, progress, verbose, warning

Methods inherited from class java.lang.Object

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

Field Detail

EIGENPAIR_FILTER_N

public static final OptionID EIGENPAIR_FILTER_N

OptionID for N_PARAM

N_PARAM

private final IntParameter N_PARAM

Parameter n.

n

private double n

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

Constructor Detail

FirstNEigenPairFilter

public FirstNEigenPairFilter(Parameterization config)

Constructor, adhering to Parameterizable

Parameters:

config - Parameterization

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