Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

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

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.preprocessing.HiCOPreprocessor<V>
              extended by de.lmu.ifi.dbs.elki.preprocessing.RangeQueryBasedHiCOPreprocessor<V>
Type Parameters:
V - Vector type
All Implemented Interfaces:
Preprocessor<V>, Parameterizable

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

Computes the HiCO correlation dimension of objects of a certain database. The PCA is based on epsilon range queries.

Author:
Elke Achtert

Field Summary
protected  String epsilon
          Epsilon.
static OptionID EPSILON_ID
          OptionID for EPSILON_PARAM
protected  PatternParameter EPSILON_PARAM
          Parameter to specify the epsilon used in the preprocessor Key: -preprocessor.epsilon
 
Fields inherited from class de.lmu.ifi.dbs.elki.preprocessing.HiCOPreprocessor
DEFAULT_PCA_DISTANCE_FUNCTION, PCA_DISTANCE_ID, PCA_DISTANCE_PARAM, 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, logger
 
Constructor Summary
RangeQueryBasedHiCOPreprocessor()
          Provides a new Preprocessor that computes the correlation dimension of objects of a certain database based on a range query.
 
Method Summary
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 considered within the PCA for the specified object id.
protected  List<DistanceResultPair<DoubleDistance>> resultsForPCA(Integer id, Database<V> database, boolean verbose, boolean time)
          Returns the ids of the objects and distances stored in the specified database to be considered within the PCA for the specified object id.
 List<String> setParameters(List<String> args)
          Sets the value for the required parameter k.
 String shortDescription()
          Returns a description of the class and the required parameters.
 
Methods inherited from class de.lmu.ifi.dbs.elki.preprocessing.HiCOPreprocessor
run
 
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

EPSILON_ID

public static final OptionID EPSILON_ID
OptionID for EPSILON_PARAM


EPSILON_PARAM

protected final PatternParameter EPSILON_PARAM
Parameter to specify the epsilon used in the preprocessor Key: -preprocessor.epsilon


epsilon

protected String epsilon
Epsilon.

Constructor Detail

RangeQueryBasedHiCOPreprocessor

public RangeQueryBasedHiCOPreprocessor()
Provides a new Preprocessor that computes the correlation dimension of objects of a certain database based on a range 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 considered 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 considered within the PCA

resultsForPCA

protected List<DistanceResultPair<DoubleDistance>> resultsForPCA(Integer id,
                                                                 Database<V> database,
                                                                 boolean verbose,
                                                                 boolean time)
Description copied from class: HiCOPreprocessor
Returns the ids of the objects and distances stored in the specified database to be considered within the PCA for the specified object id.

Specified by:
resultsForPCA 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 considered within the PCA

setParameters

public List<String> setParameters(List<String> args)
                           throws ParameterException
Sets the value for the required parameter k.

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:
a list containing the unused parameters
Throws:
ParameterException - in case of wrong parameter-setting

shortDescription

public String shortDescription()
Returns a description of the class and the required parameters.

This description should be suitable for a usage description.

Specified by:
shortDescription in interface Parameterizable
Overrides:
shortDescription in class AbstractParameterizable
Returns:
String a description of the class and the required parameters

Release 0.2 (2009-07-06_1820)