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

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
          de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction<O,D>
              de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDistanceFunction<O,DoubleDistance>
                  de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDoubleDistanceFunction<V>
                      de.lmu.ifi.dbs.elki.distance.distancefunction.timeseries.AbstractEditDistanceFunction<V>
                          de.lmu.ifi.dbs.elki.distance.distancefunction.timeseries.ERPDistanceFunction<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 ERPDistanceFunction<V extends NumberVector<V,?>>
extends AbstractEditDistanceFunction<V>

Provides the Edit Distance With Real Penalty 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

private double	g Keeps the currently set g.
static OptionID	G_ID OptionID for G_PARAM
private DoubleParameter	G_PARAM G parameter

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

ERPDistanceFunction()
Provides a Edit Distance With Real Penalty 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 Edit Distance With Real Penalty distance between the given two vectors.
List<String>	setParameters(List<String> args) Grabs all specified options from the option handler.
String	shortDescription() Returns the required input pattern.

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

Field Detail

G_ID

public static final OptionID G_ID

OptionID for G_PARAM

G_PARAM

private final DoubleParameter G_PARAM

G parameter

g

private double g

Keeps the currently set g.

Constructor Detail

ERPDistanceFunction

public ERPDistanceFunction()

Provides a Edit Distance With Real Penalty 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 Edit Distance With Real Penalty distance between the given two vectors.

Parameters:

v1 - first DatabaseObject

v2 - second DatabaseObject

Returns:

the Edit Distance With Real Penalty 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

setParameters

public List<String> setParameters(List<String> args)
                           throws ParameterException

Description copied from class: AbstractParameterizable

Grabs all specified options from the option handler. Any extending class should call this method first and return the returned array without further changes, but after setting further required parameters. An example for overwriting this method taking advantage from the previously (in superclasses) defined options would be:

 {
   List remainingParameters = super.setParameters(args);
   // set parameters for your class
   // for example like this:
   if(isSet(MY_PARAM_VALUE_PARAM))
   {
      myParamValue = getParameterValue(MY_PARAM_VALUE_PARAM);
   }
   .
   .
   .
   return remainingParameters;
   // or in case of attributes requesting parameters themselves
   // return parameterizableAttribbute.setParameters(remainingParameters);
 }
 

Specified by:

setParameters in interface Parameterizable

Overrides:

setParameters in class AbstractEditDistanceFunction<V extends NumberVector<V,?>>

Parameters:

args - parameters to set the attributes accordingly to

Returns:

a list containing the unused parameters

Throws:

ParameterException - in case of wrong parameter-setting