edu.mines.jtk.dsp

Enum RecursiveExponentialFilter.Edges

java.lang.Object

java.lang.Enum<RecursiveExponentialFilter.Edges>

edu.mines.jtk.dsp.RecursiveExponentialFilter.Edges

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RecursiveExponentialFilter.Edges>

Enclosing class:

RecursiveExponentialFilter

public static enum RecursiveExponentialFilter.Edges
extends java.lang.Enum<RecursiveExponentialFilter.Edges>

Boundary condition used at edges of either input or output samples. All except the input-zero-slope condition yield a filter that is symmetric positive-definite (SPD).

The default boundary condition is output-zero-slope.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INPUT_ZERO_SLOPE Extrapolate input samples beyond edges with values at the edges.
INPUT_ZERO_VALUE Extrapolate input samples beyond edges with zero values.
OUTPUT_ZERO_SLOPE Constrain output values beyond edges to be constant.
OUTPUT_ZERO_VALUE Constrain output values beyond edges to be zero.

Method Summary

Methods

Modifier and Type	Method and Description
static RecursiveExponentialFilter.Edges	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RecursiveExponentialFilter.Edges[]	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

INPUT_ZERO_VALUE

public static final RecursiveExponentialFilter.Edges INPUT_ZERO_VALUE

Extrapolate input samples beyond edges with zero values. A filter with this boundary condition is SPD.

INPUT_ZERO_SLOPE

public static final RecursiveExponentialFilter.Edges INPUT_ZERO_SLOPE

Extrapolate input samples beyond edges with values at the edges. Extrapolated values will be constant, so that the slope is zero. A filter with this boundary condition is not SPD.

OUTPUT_ZERO_VALUE

public static final RecursiveExponentialFilter.Edges OUTPUT_ZERO_VALUE

Constrain output values beyond edges to be zero. Output samples near the edges will have nearly zero value. A filter with this boundary condition is SPD.

OUTPUT_ZERO_SLOPE

public static final RecursiveExponentialFilter.Edges OUTPUT_ZERO_SLOPE

Constrain output values beyond edges to be constant. Output samples near the edges will have nearly zero slope. A filter with this boundary condition (the default) is SPD.

Method Detail

values

public static RecursiveExponentialFilter.Edges[] 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 (RecursiveExponentialFilter.Edges c : RecursiveExponentialFilter.Edges.values())
    System.out.println(c);

Returns:

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

valueOf

public static RecursiveExponentialFilter.Edges 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