edu.mines.jtk.mosaic
Enum SequenceView.Zero

java.lang.Object
  java.lang.Enum<SequenceView.Zero>
      edu.mines.jtk.mosaic.SequenceView.Zero

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SequenceView.Zero>

Enclosing class:

SequenceView

public static enum SequenceView.Zero
extends java.lang.Enum<SequenceView.Zero>

The visibility of function value zero in the view. To understand these options, define fmin and fmax to be the minimum and maximum function values, respectively. Then, ...

If NORMAL, the values fmax and fmin correspond to the top and bottom of the view, respectively. Depending on those values, the function value zero may or may not be displayed.

If ALWAYS, the function value zero will always be displayed. If fmin <= 0 <= fmax, then this options behaves like NORMAL. If 0 < fmin, then value zero corresponds to the bottom of the view. If fmax < 0, then value zero corresponds to the top of the view. This option is the default.

If MIDDLE, the function value zero corresponds to the middle of the the view, halfway between the top and bottom. The function values ftop and -ftop correspond to the top and bottom of the view, respectively, where ftop is the maximum of the absolute values of fmin and fmax.

Enum Constant Summary

ALWAYS

MIDDLE

NORMAL

Method Summary

static SequenceView.Zero	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SequenceView.Zero[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final SequenceView.Zero NORMAL

ALWAYS

public static final SequenceView.Zero ALWAYS

MIDDLE

public static final SequenceView.Zero MIDDLE

Method Detail

values

public static final SequenceView.Zero[] values()

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

for(SequenceView.Zero c : SequenceView.Zero.values())
        System.out.println(c);

Returns:

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

valueOf

public static SequenceView.Zero 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