de.lmu.ifi.dbs.elki.index.preprocessed.knn

Class MetricalIndexApproximationMaterializeKNNPreprocessor<O extends NumberVector<?>,D extends Distance<D>,N extends Node<E>,E extends MTreeEntry>

java.lang.Object

de.lmu.ifi.dbs.elki.index.AbstractIndex<O>

de.lmu.ifi.dbs.elki.index.preprocessed.AbstractPreprocessorIndex<O,T>

de.lmu.ifi.dbs.elki.index.preprocessed.knn.AbstractMaterializeKNNPreprocessor<O,D,KNNList<D>>

de.lmu.ifi.dbs.elki.index.preprocessed.knn.MetricalIndexApproximationMaterializeKNNPreprocessor<O,D,N,E>

Type Parameters:

O - the type of database objects the preprocessor can be applied to

D - the type of distance the used distance function will return

N - the type of spatial nodes in the spatial index

E - the type of spatial entries in the spatial index

All Implemented Interfaces:

Index, KNNIndex<O>, Result

@Title(value="Spatial Approximation Materialize kNN Preprocessor")
@Description(value="Caterializes the (approximate) k nearest neighbors of objects of a database using a spatial approximation.")
public class MetricalIndexApproximationMaterializeKNNPreprocessor<O extends NumberVector<?>,D extends Distance<D>,N extends Node<E>,E extends MTreeEntry>
extends AbstractMaterializeKNNPreprocessor<O,D,KNNList<D>>

A preprocessor for annotation of the k nearest neighbors (and their distances) to each database object. Used for example by LOF. TODO correct handling of datastore events

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricalIndexApproximationMaterializeKNNPreprocessor.Factory<O extends NumberVector<?>,D extends Distance<D>,N extends Node<E>,E extends MTreeEntry> The parameterizable factory.

Field Summary

Fields

Modifier and Type	Field and Description
private static Logging	LOG Logger to use

Fields inherited from class de.lmu.ifi.dbs.elki.index.preprocessed.knn.AbstractMaterializeKNNPreprocessor

distanceFunction, distanceQuery, k

Fields inherited from class de.lmu.ifi.dbs.elki.index.preprocessed.AbstractPreprocessorIndex

storage

Fields inherited from class de.lmu.ifi.dbs.elki.index.AbstractIndex

relation

Constructor Summary

Constructors

Constructor and Description
MetricalIndexApproximationMaterializeKNNPreprocessor(Relation<O> relation, DistanceFunction<? super O,D> distanceFunction, int k) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected Logging	getLogger() Get the classes static logger.
String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
private MetricalIndexTree<O,D,N,E>	getMetricalIndex(Relation<O> relation) Do some (limited) type checking, then cast the database into a spatial database.
String	getShortName() A short name for the result, useful for file names.
void	logStatistics() Send statistics to the logger, if enabled.
protected void	preprocess() Perform the preprocessing step.

Methods inherited from class de.lmu.ifi.dbs.elki.index.preprocessed.knn.AbstractMaterializeKNNPreprocessor

createStorage, get, getDistanceFactory, getDistanceQuery, getK, getKNNQuery, initialize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final Logging LOG

Logger to use

Constructor Detail

MetricalIndexApproximationMaterializeKNNPreprocessor

public MetricalIndexApproximationMaterializeKNNPreprocessor(Relation<O> relation,
                                                    DistanceFunction<? super O,D> distanceFunction,
                                                    int k)

Constructor

Parameters:

relation - Relation to preprocess

distanceFunction - the distance function to use

k - query k

Method Detail

preprocess

protected void preprocess()

Description copied from class: AbstractMaterializeKNNPreprocessor

Perform the preprocessing step.

Specified by:

preprocess in class AbstractMaterializeKNNPreprocessor<O extends NumberVector<?>,D extends Distance<D>,KNNList<D extends Distance<D>>>

getMetricalIndex

private MetricalIndexTree<O,D,N,E> getMetricalIndex(Relation<O> relation)
                                                                                                                            throws IllegalStateException

Do some (limited) type checking, then cast the database into a spatial database.

Parameters:

relation - Database

Returns:

Metrical index

Throws:

IllegalStateException - when the cast fails.

getLongName

public String getLongName()

Description copied from interface: Result

A "pretty" name for the result, for use in titles, captions and menus.

Specified by:

getLongName in interface Result

Specified by:

getLongName in class AbstractIndex<O extends NumberVector<?>>

Returns:

result name

getShortName

public String getShortName()

Description copied from interface: Result

A short name for the result, useful for file names.

Specified by:

getShortName in interface Result

Specified by:

getShortName in class AbstractIndex<O extends NumberVector<?>>

Returns:

result name

getLogger

protected Logging getLogger()

Description copied from class: AbstractPreprocessorIndex

Get the classes static logger.

Specified by:

getLogger in class AbstractPreprocessorIndex<O extends NumberVector<?>,KNNList<D extends Distance<D>>>

Returns:

Logger

logStatistics

public void logStatistics()

Description copied from interface: Index

Send statistics to the logger, if enabled. Note: you must have set the logging level appropriately before initializing the index! Otherwise, the index might not have collected the desired statistics.