edu.mines.jtk.dsp
Enum LocalDiffusionKernel.Stencil

java.lang.Object
  java.lang.Enum<LocalDiffusionKernel.Stencil>
      edu.mines.jtk.dsp.LocalDiffusionKernel.Stencil

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LocalDiffusionKernel.Stencil>

Enclosing class:

LocalDiffusionKernel

public static enum LocalDiffusionKernel.Stencil
extends java.lang.Enum<LocalDiffusionKernel.Stencil>

The stencil used in finite-difference approximation of derivatives. In each stencil name, the first digit equals the number of samples used in the direction of the derivative, and the second digit equals the number of samples in the orthogonal direction. Names correspond to 2D stencils, but each has a natural 3D extension.

Note that the stencil implied by G'DG is larger than that used to approximate the derivatives in G. For example, a 2x2 derivative approximation implies a 3x3 stencil for G'DG.

Enum Constant Summary

D22
A 2x2 stencil.

D24
A 2x4 stencil.

D33
A 3x3 stencil.

D71
A 7x1 stencil.

D91
A 9x1 stencil.

Method Summary

static LocalDiffusionKernel.Stencil	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LocalDiffusionKernel.Stencil[]	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

D22

public static final LocalDiffusionKernel.Stencil D22

A 2x2 stencil. The 2D version has 4 non-zero coefficients. The 3D version has 8 non-zero coefficients. This stencil is the default.

D24

public static final LocalDiffusionKernel.Stencil D24

A 2x4 stencil. The 2D version has 8 non-zero coefficients. The 3D version has 24 non-zero coefficients. The 3D version is not yet implemented.

D33

public static final LocalDiffusionKernel.Stencil D33

A 3x3 stencil. The 2D version has 6 non-zero coefficients. The 3D version has 18 non-zero coefficients.

D71

public static final LocalDiffusionKernel.Stencil D71

A 7x1 stencil. Both 2D and 3D versions have 6 non-zero coefficients.

D91

public static final LocalDiffusionKernel.Stencil D91

A 9x1 stencil. Both 2D and 3D versions have 8 non-zero coefficients. The 3D version is not yet implemented.

Method Detail

values

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

Returns:

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

valueOf

public static LocalDiffusionKernel.Stencil 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