de.lmu.ifi.dbs.elki.distance.distancefunction.correlation
Class PCABasedCorrelationDistanceFunction

java.lang.Object
  de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDatabaseDistanceFunction<O,D>
      de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractIndexBasedDistanceFunction<NumberVector<?,?>,FilteredLocalPCAIndex<NumberVector<?,?>>,PCACorrelationDistance>
          de.lmu.ifi.dbs.elki.distance.distancefunction.correlation.PCABasedCorrelationDistanceFunction

All Implemented Interfaces:

DistanceFunction<NumberVector<?,?>,PCACorrelationDistance>, FilteredLocalPCABasedDistanceFunction<NumberVector<?,?>,FilteredLocalPCAIndex<NumberVector<?,?>>,PCACorrelationDistance>, IndexBasedDistanceFunction<NumberVector<?,?>,PCACorrelationDistance>, InspectionUtilFrequentlyScanned, Parameterizable

public class PCABasedCorrelationDistanceFunction
extends AbstractIndexBasedDistanceFunction<NumberVector<?,?>,FilteredLocalPCAIndex<NumberVector<?,?>>,PCACorrelationDistance>
implements FilteredLocalPCABasedDistanceFunction<NumberVector<?,?>,FilteredLocalPCAIndex<NumberVector<?,?>>,PCACorrelationDistance>

Provides the correlation distance for real valued vectors.

Nested Class Summary

static class	PCABasedCorrelationDistanceFunction.Instance<V extends NumberVector<?,?>> The actual instance bound to a particular database.
static class	PCABasedCorrelationDistanceFunction.Parameterizer Parameterization class.

Field Summary

private double	delta Holds the value of DELTA_ID.
static OptionID	DELTA_ID Parameter to specify the threshold of a distance between a vector q and a given space that indicates that q adds a new dimension to the space, must be a double equal to or greater than 0.
(package private) static Logging	logger Logger for debug.

Fields inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractIndexBasedDistanceFunction

indexFactory

Fields inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.IndexBasedDistanceFunction

INDEX_ID

Constructor Summary

PCABasedCorrelationDistanceFunction(IndexFactory<NumberVector<?,?>,FilteredLocalPCAIndex<NumberVector<?,?>>> indexFactory, double delta)
Constructor

Method Summary

boolean	equals(Object obj)
PCACorrelationDistance	getDistanceFactory() Method to get the distance functions factory.
<T extends NumberVector<?,?>> PCABasedCorrelationDistanceFunction.Instance<T>	instantiate(Relation<T> database) Instantiate with a database to get the actual distance query.

Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractIndexBasedDistanceFunction

getInputTypeRestriction, isMetric, isSymmetric

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.DistanceFunction

getInputTypeRestriction, isMetric, isSymmetric

Field Detail

logger

static Logging logger

Logger for debug.

DELTA_ID

public static final OptionID DELTA_ID

Parameter to specify the threshold of a distance between a vector q and a given space that indicates that q adds a new dimension to the space, must be a double equal to or greater than 0.

Default value: 0.25

Key: -pcabasedcorrelationdf.delta

delta

private double delta

Holds the value of DELTA_ID.

Constructor Detail

PCABasedCorrelationDistanceFunction

public PCABasedCorrelationDistanceFunction(IndexFactory<NumberVector<?,?>,FilteredLocalPCAIndex<NumberVector<?,?>>> indexFactory,
                                           double delta)

Constructor

Parameters:

indexFactory - index factory

delta - Delta parameter

Method Detail

getDistanceFactory

public PCACorrelationDistance getDistanceFactory()

Description copied from interface: DistanceFunction

Method to get the distance functions factory.

Specified by:

getDistanceFactory in interface DistanceFunction<NumberVector<?,?>,PCACorrelationDistance>

Specified by:

getDistanceFactory in class AbstractDatabaseDistanceFunction<NumberVector<?,?>,PCACorrelationDistance>

Returns:

Factory for distance objects

instantiate

public <T extends NumberVector<?,?>> PCABasedCorrelationDistanceFunction.Instance<T> instantiate(Relation<T> database)

Description copied from interface: FilteredLocalPCABasedDistanceFunction

Instantiate with a database to get the actual distance query.

Specified by:

instantiate in interface DistanceFunction<NumberVector<?,?>,PCACorrelationDistance>

Specified by:

instantiate in interface FilteredLocalPCABasedDistanceFunction<NumberVector<?,?>,FilteredLocalPCAIndex<NumberVector<?,?>>,PCACorrelationDistance>

Parameters:

database - The representation to use

Returns:

Actual distance query.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object