de.lmu.ifi.dbs.elki.preprocessing
Class KnnQueryBasedHiCOPreprocessor<V extends RealVector<V,?>>

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
          de.lmu.ifi.dbs.elki.preprocessing.HiCOPreprocessor<V>
              de.lmu.ifi.dbs.elki.preprocessing.KnnQueryBasedHiCOPreprocessor<V>

All Implemented Interfaces:

Loggable, Preprocessor<V>, Parameterizable

public class KnnQueryBasedHiCOPreprocessor<V extends RealVector<V,?>>
extends HiCOPreprocessor<V>

Computes the HiCO correlation dimension of objects of a certain database. The PCA is based on k nearest neighbor queries.

Author:

Elke Achtert

Field Summary

private Integer	k Holds the value of parameter k.
private IntParameter	K_PARAM Optional parameter to specify the number of nearest neighbors considered in the PCA, must be an integer greater than 0.

Fields inherited from class de.lmu.ifi.dbs.elki.preprocessing.HiCOPreprocessor

DEFAULT_PCA_CLASS, DEFAULT_PCA_DISTANCE_FUNCTION, PCA_CLASS_D, PCA_CLASS_P, PCA_DISTANCE_FUNCTION_D, PCA_DISTANCE_FUNCTION_P, pcaClassName, pcaDistanceFunction

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

KnnQueryBasedHiCOPreprocessor()
Provides a new Preprocessor that computes the correlation dimension of objects of a certain database based on a k nearest neighbor query.

Method Summary

String	description() Returns a description of the class and the required parameters.
protected List<Integer>	objectIDsForPCA(Integer id, Database<V> database, boolean verbose, boolean time) Returns the ids of the objects stored in the specified database to be considerd within the PCA for the specified object id.
String[]	setParameters(String[] args) Sets the value for the parameter k.

Methods inherited from class de.lmu.ifi.dbs.elki.preprocessing.HiCOPreprocessor

getAttributeSettings, run

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

addOption, checkGlobalParameterConstraints, deleteOption, description, description, 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, getParameters, getPossibleOptions, inlineDescription

Field Detail

K_PARAM

private final IntParameter K_PARAM

Optional parameter to specify the number of nearest neighbors considered in the PCA, must be an integer greater than 0. If this parameter is not set, k ist set to three times of the dimensionality of the database objects.

Key: -hicopreprocessor.k

Default value: three times of the dimensionality of the database objects

k

private Integer k

Holds the value of parameter k.

Constructor Detail

KnnQueryBasedHiCOPreprocessor

public KnnQueryBasedHiCOPreprocessor()

Provides a new Preprocessor that computes the correlation dimension of objects of a certain database based on a k nearest neighbor query.

Method Detail

objectIDsForPCA

protected List<Integer> objectIDsForPCA(Integer id,
                                        Database<V> database,
                                        boolean verbose,
                                        boolean time)

Description copied from class: HiCOPreprocessor

Returns the ids of the objects stored in the specified database to be considerd within the PCA for the specified object id.

Specified by:

objectIDsForPCA in class HiCOPreprocessor<V extends RealVector<V,?>>

Parameters:

id - the id of the object for which a PCA should be performed

database - the database holding the objects

verbose - flag to allow verbose messages while performing the algorithm

time - flag to request output of performance time

Returns:

the list of the object ids to be considerd within the PCA

See Also:

HiCOPreprocessor.objectIDsForPCA(Integer,Database,boolean,boolean)

setParameters

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

Sets the value for the parameter k. If k is not specified, the default value is used.

Specified by:

setParameters in interface Parameterizable

Overrides:

setParameters in class HiCOPreprocessor<V extends RealVector<V,?>>

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[])

description

public String description()

Returns a description of the class and the required parameters.

This description should be suitable for a usage description.

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()