Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

de.lmu.ifi.dbs.elki.distance.distancefunction.timeseries
Class DTWDistanceFunction<V extends NumberVector<V,?>>

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
          extended by de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction<O,D>
              extended by de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDistanceFunction<O,DoubleDistance>
                  extended by de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDoubleDistanceFunction<V>
                      extended by de.lmu.ifi.dbs.elki.distance.distancefunction.timeseries.AbstractEditDistanceFunction<V>
                          extended by de.lmu.ifi.dbs.elki.distance.distancefunction.timeseries.DTWDistanceFunction<V>
Type Parameters:
V - the type of NumberVector to compute the distances in between
All Implemented Interfaces:
DistanceFunction<V,DoubleDistance>, MeasurementFunction<V,DoubleDistance>, Parameterizable

public class DTWDistanceFunction<V extends NumberVector<V,?>>
extends AbstractEditDistanceFunction<V>

Provides the Dynamic Time Warping distance for NumberVectors.

Author:
Thomas Bernecker

Nested Class Summary
 
Nested classes/interfaces inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.timeseries.AbstractEditDistanceFunction
AbstractEditDistanceFunction.Step
 
Field Summary
 
Fields inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.timeseries.AbstractEditDistanceFunction
bandSize, BANDSIZE_ID, BANDSIZE_PARAM
 
Fields inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction
INFINITY_PATTERN
 
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
DTWDistanceFunction()
          Provides a Dynamic Time Warping distance function that can compute the Dynamic Time Warping distance (that is a DoubleDistance) for NumberVectors.
 
Method Summary
 DoubleDistance distance(V v1, V v2)
          Provides the Dynamic Time Warping distance between the given two vectors.
 String shortDescription()
          Returns the required input pattern.
 
Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.timeseries.AbstractEditDistanceFunction
setParameters
 
Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDoubleDistanceFunction
infiniteDistance, nullDistance, undefinedDistance, valueOf
 
Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDistanceFunction
distance, distance, isInfiniteDistance, isNullDistance, isUndefinedDistance
 
Methods inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction
getDatabase, matches, requiredInputPattern, setDatabase, setRequiredInputPattern
 
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
addOption, addParameterizable, addParameterizable, checkGlobalParameterConstraints, collectOptions, getAttributeSettings, getParameters, rememberParametersExcept, removeOption, removeParameterizable
 
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.distance.MeasurementFunction
requiredInputPattern, setDatabase
 
Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable
checkGlobalParameterConstraints, collectOptions, getParameters
 

Constructor Detail

DTWDistanceFunction

public DTWDistanceFunction()
Provides a Dynamic Time Warping distance function that can compute the Dynamic Time Warping distance (that is a DoubleDistance) for NumberVectors.

Method Detail

distance

public DoubleDistance distance(V v1,
                               V v2)
Provides the Dynamic Time Warping distance between the given two vectors.

Parameters:
v1 - first DatabaseObject
v2 - second DatabaseObject
Returns:
the Dynamic Time Warping distance between the given two vectors as an instance of DoubleDistance.

shortDescription

public String shortDescription()
Description copied from class: AbstractMeasurementFunction
Returns the required input pattern.

Specified by:
shortDescription in interface Parameterizable
Overrides:
shortDescription in class AbstractMeasurementFunction<V extends NumberVector<V,?>,DoubleDistance>
Returns:
Description of the class

Release 0.2 (2009-07-06_1820)