de.lmu.ifi.dbs.elki.algorithm.outlier
Class LOCI<O extends DatabaseObject,D extends NumberDistance<D,?>>

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
          de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm<O,R>
              de.lmu.ifi.dbs.elki.algorithm.DistanceBasedAlgorithm<O,D,MultiResult>
                  de.lmu.ifi.dbs.elki.algorithm.outlier.LOCI<O,D>

Type Parameters:

O -

All Implemented Interfaces:

Algorithm<O,MultiResult>, Parameterizable

public class LOCI<O extends DatabaseObject,D extends NumberDistance<D,?>>
extends DistanceBasedAlgorithm<O,D,MultiResult>

Fast Outlier Detection Using the "Local Correlation Integral". Exact implementation only, not aLOCI. Outlier detection using multiple epsilon neighborhoods. Based on: S. Papadimitriou, H. Kitagawa, P. B. Gibbons and C. Faloutsos: LOCI: Fast Outlier Detection Using the Local Correlation Integral. In: Proc. 19th IEEE Int. Conf. on Data Engineering (ICDE '03), Bangalore, India, 2003.

Author:

Erich Schubert

Field Summary

private double	alpha Holds the value of ALPHA_PARAM.
static OptionID	ALPHA_ID OptionID for ALPHA_PARAM
private DoubleParameter	ALPHA_PARAM Parameter to specify the averaging neighborhood scaling Key: -loci.alpha Default: 0.5
static AssociationID<List<CPair<Double,Integer>>>	LOCI_CRITICALDIST The LOCI critical distances of an object.
static AssociationID<Double>	LOCI_MDEF_CRITICAL_RADIUS The LOCI MDEF / SigmaMDEF maximum values radius
static AssociationID<Double>	LOCI_MDEF_NORM The LOCI MDEF / SigmaMDEF maximum value (normalized MDEF)
private double	nmin Holds the value of NMIN_PARAM.
static OptionID	NMIN_ID OptionID for NMIN_PARAM
private IntParameter	NMIN_PARAM Parameter to specify the minimum neighborhood size Key: -loci.nmin Default: 20
(package private) MultiResult	result Provides the result of the algorithm.
private String	rmax Holds the value of RMAX_PARAM.
static OptionID	RMAX_ID OptionID for RMAX_PARAM
private PatternParameter	RMAX_PARAM Parameter to specify the maximum radius of the neighborhood to be considered, must be suitable to the distance function specified.

Fields inherited from class de.lmu.ifi.dbs.elki.algorithm.DistanceBasedAlgorithm

DISTANCE_FUNCTION_ID, DISTANCE_FUNCTION_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

LOCI()
Constructor, adding options to option handler.

Method Summary

Description	getDescription() Get algorithm description.
MultiResult	getResult() Return result.
protected MultiResult	runInTime(Database<O> database) Runs the algorithm in the timed evaluation part.
List<String>	setParameters(List<String> args) Calls the super method and sets additionally the values of the parameter RMAX_PARAM, NMIN_PARAM and ALPHA_PARAM

Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.DistanceBasedAlgorithm

getDistanceFunction

Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm

isTime, isVerbose, run, setTime, setVerbose

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

addOption, addParameterizable, addParameterizable, checkGlobalParameterConstraints, collectOptions, getAttributeSettings, getParameters, rememberParametersExcept, removeOption, removeParameterizable, shortDescription

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, shortDescription

Field Detail

RMAX_ID

public static final OptionID RMAX_ID

OptionID for RMAX_PARAM

NMIN_ID

public static final OptionID NMIN_ID

OptionID for NMIN_PARAM

ALPHA_ID

public static final OptionID ALPHA_ID

OptionID for ALPHA_PARAM

RMAX_PARAM

private final PatternParameter RMAX_PARAM

Parameter to specify the maximum radius of the neighborhood to be considered, must be suitable to the distance function specified.

Key: -loci.rmax

rmax

private String rmax

Holds the value of RMAX_PARAM.

NMIN_PARAM

private final IntParameter NMIN_PARAM

Parameter to specify the minimum neighborhood size

Key: -loci.nmin

Default: 20

nmin

private double nmin

Holds the value of NMIN_PARAM.

ALPHA_PARAM

private final DoubleParameter ALPHA_PARAM

Parameter to specify the averaging neighborhood scaling

Key: -loci.alpha

Default: 0.5

alpha

private double alpha

Holds the value of ALPHA_PARAM.

result

MultiResult result

Provides the result of the algorithm.

LOCI_CRITICALDIST

public static final AssociationID<List<CPair<Double,Integer>>> LOCI_CRITICALDIST

The LOCI critical distances of an object.

LOCI_MDEF_CRITICAL_RADIUS

public static final AssociationID<Double> LOCI_MDEF_CRITICAL_RADIUS

The LOCI MDEF / SigmaMDEF maximum values radius

LOCI_MDEF_NORM

public static final AssociationID<Double> LOCI_MDEF_NORM

The LOCI MDEF / SigmaMDEF maximum value (normalized MDEF)

Constructor Detail

LOCI

public LOCI()

Constructor, adding options to option handler.

Method Detail

setParameters

public List<String> setParameters(List<String> args)
                           throws ParameterException

Calls the super method and sets additionally the values of the parameter RMAX_PARAM, NMIN_PARAM and ALPHA_PARAM

Specified by:

setParameters in interface Parameterizable

Overrides:

setParameters in class DistanceBasedAlgorithm<O extends DatabaseObject,D extends NumberDistance<D,?>,MultiResult>

Parameters:

args - parameters to set the attributes accordingly to

Returns:

a list containing the unused parameters

Throws:

ParameterException - in case of wrong parameter-setting

runInTime

protected MultiResult runInTime(Database<O> database)
                         throws IllegalStateException

Runs the algorithm in the timed evaluation part.

Specified by:

runInTime in class AbstractAlgorithm<O extends DatabaseObject,MultiResult>

Parameters:

database - the database to run the algorithm on

Returns:

the Result computed by this algorithm

Throws:

IllegalStateException - if the algorithm has not been initialized properly (e.g. the setParameters(String[]) method has been failed to be called).

getDescription

public Description getDescription()

Get algorithm description.

Returns:

a description of the algorithm

getResult

public MultiResult getResult()

Return result.

Returns:

the result of the algorithm