Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

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

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
          extended by 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

Field Summary
static OptionID EIGENPAIR_FILTER_COMPOSITE_LIST
          OptionID for FILTERS_PARAM
private  List<EigenPairFilter> filters
          The filters to be applied.
private  ClassListParameter<EigenPairFilter> FILTERS_PARAM
           
 
Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
optionHandler
 
Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable
debug, logger
 
Constructor Summary
CompositeEigenPairFilter()
          Provides a new EigenPairFilter that builds a chain of user specified eigenpair filters.
 
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.
 List<String> setParameters(List<String> args)
          Calls the super method and instantiates filters according to the value of parameter FILTERS_PARAM.
 String shortDescription()
          Returns a short description of the class.
 
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
addOption, addParameterizable, addParameterizable, checkGlobalParameterConstraints, collectOptions, getAttributeSettings, getParameters, rememberParametersExcept, removeOption, removeParameterizable
 
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
 
Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable
checkGlobalParameterConstraints, collectOptions, getParameters
 

Field Detail

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.

Constructor Detail

CompositeEigenPairFilter

public CompositeEigenPairFilter()
Provides a new EigenPairFilter that builds a chain of user specified eigenpair filters.

Method Detail

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

Release 0.2 (2009-07-06_1820)