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

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

All Implemented Interfaces:

EigenPairFilter, InspectionUtilFrequentlyScanned, Parameterizable

@Title(value="Limit-based Eigenpair Filter")
@Description(value="Filters all eigenpairs, which are lower than a given value.")
public class LimitEigenPairFilter
extends Object
implements EigenPairFilter

The LimitEigenPairFilter marks all eigenpairs having an (absolute) eigenvalue below the specified threshold (relative or absolute) as weak eigenpairs, the others are marked as strong eigenpairs.

Nested Class Summary

static class

LimitEigenPairFilter.Parameterizer Parameterization class.

Field Summary

private boolean	absolute Indicates whether delta is an absolute or a relative value.
static double	DEFAULT_DELTA The default value for delta.
private double	delta Threshold for strong eigenpairs, can be absolute or relative.
static OptionID	EIGENPAIR_FILTER_ABSOLUTE "absolute" Flag
static OptionID	EIGENPAIR_FILTER_DELTA Parameter delta
private static Logging	logger The logger for this class.

Constructor Summary

LimitEigenPairFilter(double delta, boolean absolute)
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_ABSOLUTE

public static final OptionID EIGENPAIR_FILTER_ABSOLUTE

"absolute" Flag

EIGENPAIR_FILTER_DELTA

public static final OptionID EIGENPAIR_FILTER_DELTA

Parameter delta

DEFAULT_DELTA

public static final double DEFAULT_DELTA

The default value for delta.

See Also:

Constant Field Values

delta

private double delta

Threshold for strong eigenpairs, can be absolute or relative.

absolute

private boolean absolute

Indicates whether delta is an absolute or a relative value.

Constructor Detail

LimitEigenPairFilter

public LimitEigenPairFilter(double delta,
                            boolean absolute)

Constructor.

Parameters:

delta -

absolute -

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