edu.mines.jtk.dsp

Enum DynamicWarping.ErrorExtrapolation

java.lang.Object

java.lang.Enum<DynamicWarping.ErrorExtrapolation>

edu.mines.jtk.dsp.DynamicWarping.ErrorExtrapolation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DynamicWarping.ErrorExtrapolation>

Enclosing class:

DynamicWarping

public static enum DynamicWarping.ErrorExtrapolation
extends java.lang.Enum<DynamicWarping.ErrorExtrapolation>

The method used to extrapolate alignment errors. Alignment errors |f[i]-g[i+l]| cannot be computed for indices i and lags l for which the sum i+l is out of bounds. For such indices and lags, errors are missing and must be extrapolated.

The extrapolation methods provided are designed to work best in the case where errors are low for one particular lag l, that is, when the sequences f and g are related by a constant shift.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVERAGE For each lag, extrapolate alignment errors using the average of all errors not missing for that lag.
NEAREST For each lag, extrapolate alignment errors using the nearest error not missing for that lag.
REFLECT For each lag, extrapolate alignment errors using a reflection of nearby errors not missing for that lag.

Method Summary

Methods

Modifier and Type	Method and Description
static DynamicWarping.ErrorExtrapolation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DynamicWarping.ErrorExtrapolation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEAREST

public static final DynamicWarping.ErrorExtrapolation NEAREST

For each lag, extrapolate alignment errors using the nearest error not missing for that lag.

This is the default extrapolation method.

AVERAGE

public static final DynamicWarping.ErrorExtrapolation AVERAGE

For each lag, extrapolate alignment errors using the average of all errors not missing for that lag.

REFLECT

public static final DynamicWarping.ErrorExtrapolation REFLECT

For each lag, extrapolate alignment errors using a reflection of nearby errors not missing for that lag.

Method Detail

values

public static DynamicWarping.ErrorExtrapolation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DynamicWarping.ErrorExtrapolation c : DynamicWarping.ErrorExtrapolation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DynamicWarping.ErrorExtrapolation valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null