de.lmu.ifi.dbs.elki.algorithm

Class KNNDistancesSampler<O>

java.lang.Object

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

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

de.lmu.ifi.dbs.elki.algorithm.KNNDistancesSampler<O>

Type Parameters:

O - the type of objects handled by this Algorithm

All Implemented Interfaces:

Algorithm, DistanceBasedAlgorithm<O>

@Title(value="KNN-Distance-Order")
@Description(value="Assesses the knn distances for a specified k and orders them.")
public class KNNDistancesSampler<O>
extends AbstractDistanceBasedAlgorithm<O,KNNDistancesSampler.KNNDistanceOrderResult>

Provides an order of the kNN-distances for all objects within the database. This class can be used to estimate parameters for other algorithms, such as estimating the epsilon parameter for DBSCAN: set k to minPts-1, and then choose a percentile from the sample as epsilon, or plot the result as a graph and look for a bend or knee in this plot.

Author:

Arthur Zimek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KNNDistancesSampler.KNNDistanceOrderResult Curve result for a list containing the knn distances.
static class	KNNDistancesSampler.Parameterizer<O> Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	k Parameter k.
private static Logging	LOG The logger for this class.
private RandomFactory	rnd Random number seeding.
protected double	sample Sampling percentage.

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

DISTANCE_FUNCTION_ID

Constructor Summary

Constructors

Constructor and Description
KNNDistancesSampler(DistanceFunction<? super O> distanceFunction, int k, double sample, RandomFactory rnd) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
TypeInformation[]	getInputTypeRestriction() Get the input type restriction used for negotiating the data query.
protected Logging	getLogger() Get the (STATIC) logger for this class.
KNNDistancesSampler.KNNDistanceOrderResult	run(Database database, Relation<O> relation) Provides an order of the kNN-distances for all objects within the specified database.

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

getDistanceFunction

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

makeParameterDistanceFunction, 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.Algorithm

run

Field Detail

LOG

private static final Logging LOG

The logger for this class.

k

protected int k

Parameter k.

sample

protected double sample

Sampling percentage.

rnd

private RandomFactory rnd

Random number seeding.

Constructor Detail

KNNDistancesSampler

public KNNDistancesSampler(DistanceFunction<? super O> distanceFunction,
                   int k,
                   double sample,
                   RandomFactory rnd)

Constructor.

Parameters:

distanceFunction - Distance function

k - k Parameter

sample - Sampling rate, or sample size (when > 1)

rnd - Random source.

Method Detail

run

public KNNDistancesSampler.KNNDistanceOrderResult run(Database database,
                                             Relation<O> relation)

Provides an order of the kNN-distances for all objects within the specified database.

Parameters:

database - Database

relation - Relation

Returns:

Result

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<KNNDistancesSampler.KNNDistanceOrderResult>

Returns:

Type restriction

getLogger

protected Logging getLogger()

Description copied from class: AbstractAlgorithm

Get the (STATIC) logger for this class.

Specified by:

getLogger in class AbstractAlgorithm<KNNDistancesSampler.KNNDistanceOrderResult>

Returns:

the static logger