de.lmu.ifi.dbs.elki.varianceanalysis
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.varianceanalysis.CompositeEigenPairFilter

All Implemented Interfaces:

Loggable, Parameterizable, EigenPairFilter

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 Pattern	COMMA_SPLIT A pattern defining a comma.
private List<EigenPairFilter>	filters The filters to be applied.
static String	FILTERS_D Description for parameter filters.
static String	FILTERS_P Parameter for filters.

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

Constructor Summary

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

Method Summary

String	description() Returns a description of the class and the required parameters.
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.
String[]	setParameters(String[] args) Sets the attributes of the class accordingly to the given parameters.

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable

addOption, checkGlobalParameterConstraints, deleteOption, description, description, getAttributeSettings, getParameters, getParameterValue, getPossibleOptions, inlineDescription, isSet, setParameters

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

debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, 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, getAttributeSettings, getParameters, getPossibleOptions, inlineDescription

Field Detail

COMMA_SPLIT

public static final Pattern COMMA_SPLIT

A pattern defining a comma.

FILTERS_P

public static final String FILTERS_P

Parameter for filters.

See Also:

Constant Field Values

FILTERS_D

public static final String FILTERS_D

Description for parameter filters.

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

description

public String description()

Description copied from interface: Parameterizable

Returns a description of the class and the required parameters.

This description should be suitable for a usage description as for a standalone application.

Specified by:

description in interface Parameterizable

Overrides:

description in class AbstractParameterizable

Returns:

String a description of the class and the required parameters

See Also:

Parameterizable.description()

setParameters

public String[] setParameters(String[] args)
                       throws ParameterException

Description copied from interface: Parameterizable

Sets the attributes of the class accordingly to the given parameters. Returns a new String array containing those entries of the given array that are neither expected nor used by this Parameterizable.

Specified by:

setParameters in interface Parameterizable

Overrides:

setParameters in class AbstractParameterizable

Parameters:

args - parameters to set the attributes accordingly to

Returns:

String[] an array containing the unused parameters

Throws:

ParameterException - in case of wrong parameter-setting

See Also:

Parameterizable.setParameters(String[])