de.lmu.ifi.dbs.elki.math.linearalgebra.pca
Class CompositeEigenPairFilter
java.lang.Object
de.lmu.ifi.dbs.elki.logging.AbstractLoggable
de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
de.lmu.ifi.dbs.elki.math.linearalgebra.pca.CompositeEigenPairFilter
- All Implemented Interfaces:
- EigenPairFilter, Parameterizable
public class CompositeEigenPairFilter
- extends AbstractParameterizable
- implements EigenPairFilter
The CompositeEigenPairFilter
can be used to build a chain of
eigenpair filters.
- Author:
- Elke Achtert
Constructor Summary |
CompositeEigenPairFilter()
Provides a new EigenPairFilter that builds a chain of user specified
eigenpair filters. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
EIGENPAIR_FILTER_COMPOSITE_LIST
public static final OptionID EIGENPAIR_FILTER_COMPOSITE_LIST
- OptionID for
FILTERS_PARAM
FILTERS_PARAM
private final ClassListParameter<EigenPairFilter> FILTERS_PARAM
filters
private List<EigenPairFilter> filters
- The filters to be applied.
CompositeEigenPairFilter
public CompositeEigenPairFilter()
- Provides a new EigenPairFilter that builds a chain of user specified
eigenpair filters.
filter
public 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.
- Specified by:
filter
in interface EigenPairFilter
- Parameters:
eigenPairs
- the eigenPairs (i.e. the eigenvectors and
- Returns:
- the filtered eigenpairs
shortDescription
public String shortDescription()
- Description copied from class:
AbstractParameterizable
- Returns a short description of the class.
- Specified by:
shortDescription
in interface Parameterizable
- Overrides:
shortDescription
in class AbstractParameterizable
- Returns:
- Description of the class
setParameters
public List<String> setParameters(List<String> args)
throws ParameterException
- Calls the super method and instantiates
filters
according to the
value of parameter FILTERS_PARAM
. The remaining parameters are
passed to each instance of filters
.
- Specified by:
setParameters
in interface Parameterizable
- Overrides:
setParameters
in class AbstractParameterizable
- Parameters:
args
- parameters to set the attributes accordingly to
- Returns:
- a list containing the unused parameters
- Throws:
ParameterException
- in case of wrong parameter-setting