de.lmu.ifi.dbs.elki.algorithm.clustering.optics

Class AbstractOPTICS<O>

java.lang.Object

de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm<R>

de.lmu.ifi.dbs.elki.algorithm.AbstractDistanceBasedAlgorithm<O,ClusterOrder>

de.lmu.ifi.dbs.elki.algorithm.clustering.optics.AbstractOPTICS<O>

Type Parameters:

O - the type of DatabaseObjects handled by the algorithm

All Implemented Interfaces:

Algorithm, OPTICSTypeAlgorithm, DistanceBasedAlgorithm<O>

Direct Known Subclasses:

OPTICSHeap, OPTICSList

@Reference(authors="Mihael Ankerst, Markus M. Breunig, Hans-Peter Kriegel, J\u00f6rg Sander",
           title="OPTICS: Ordering Points to Identify the Clustering Structure",
           booktitle="Proc. ACM SIGMOD Int. Conf. on Management of Data (SIGMOD \'99)",
           url="https://doi.org/10.1145/304181.304187",
           bibkey="DBLP:conf/sigmod/AnkerstBKS99")
 @Alias(value={"OPTICS","de.lmu.ifi.dbs.elki.algorithm.clustering.OPTICS"})
public abstract class AbstractOPTICS<O>
extends AbstractDistanceBasedAlgorithm<O,ClusterOrder>
implements OPTICSTypeAlgorithm

The OPTICS algorithm for density-based hierarchical clustering.

This is the abstract base class, providing the shared parameters only.

Reference:

Mihael Ankerst, Markus M. Breunig, Hans-Peter Kriegel, Jörg Sander
OPTICS: Ordering Points to Identify the Clustering Structure
Proc. ACM SIGMOD Int. Conf. on Management of Data (SIGMOD '99)

Since:

0.7.0

Author:

Elke Achtert, Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractOPTICS.Parameterizer<O> Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
protected double	epsilon Holds the maximum distance to search for objects (performance parameter)
protected int	minpts The density threshold, in number of points.

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

ALGORITHM_ID

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

DISTANCE_FUNCTION_ID

Constructor Summary

Constructors

Constructor and Description
AbstractOPTICS(DistanceFunction<? super O> distanceFunction, double epsilon, int minpts) Constructor.

Method Summary

Modifier and Type	Method and Description
TypeInformation[]	getInputTypeRestriction() Get the input type restriction used for negotiating the data query.
int	getMinPts() Get the minpts value used.
abstract ClusterOrder	run(Database db, Relation<O> relation) Run OPTICS on the database.

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

getDistanceFunction

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

getLogger, run

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.algorithm.clustering.optics.OPTICSTypeAlgorithm

run

Field Detail

epsilon

protected double epsilon

Holds the maximum distance to search for objects (performance parameter)

minpts

protected int minpts

The density threshold, in number of points.

Constructor Detail

AbstractOPTICS

public AbstractOPTICS(DistanceFunction<? super O> distanceFunction,
                      double epsilon,
                      int minpts)

Constructor.

Parameters:

distanceFunction - Distance function

epsilon - Epsilon value

minpts - Minpts value

Method Detail

run

public abstract ClusterOrder run(Database db,
                                 Relation<O> relation)

Run OPTICS on the database.

Parameters:

db - Database

relation - Relation

Returns:

Result

getMinPts

public int getMinPts()

Description copied from interface: OPTICSTypeAlgorithm

Get the minpts value used. Needed for OPTICS Xi.

Specified by:

getMinPts in interface OPTICSTypeAlgorithm

Returns:

minpts value

getInputTypeRestriction

public TypeInformation[] getInputTypeRestriction()

Description copied from class: AbstractAlgorithm

Get the input type restriction used for negotiating the data query.

Specified by:

getInputTypeRestriction in interface Algorithm

Specified by:

getInputTypeRestriction in class AbstractAlgorithm<ClusterOrder>

Returns:

Type restriction