uk.ac.starlink.ttools.calc

Enum SchlegelCalculator.Statistic

java.lang.Object

java.lang.Enum<SchlegelCalculator.Statistic>

uk.ac.starlink.ttools.calc.SchlegelCalculator.Statistic

All Implemented Interfaces:

Serializable, Comparable<SchlegelCalculator.Statistic>

Enclosing class:

SchlegelCalculator

public static enum SchlegelCalculator.Statistic
extends Enum<SchlegelCalculator.Statistic>

Enumerates statistics available from the IPAC dust service.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAX Maximum value.
MEAN Mean value.
MIN Minimum value.
REF_PIXEL Value at reference pixel.
STD Standard deviation.

Method Summary

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

MEAN

public static final SchlegelCalculator.Statistic MEAN

Mean value.

REF_PIXEL

public static final SchlegelCalculator.Statistic REF_PIXEL

Value at reference pixel.

STD

public static final SchlegelCalculator.Statistic STD

Standard deviation.

MAX

public static final SchlegelCalculator.Statistic MAX

Maximum value.

MIN

public static final SchlegelCalculator.Statistic MIN

Minimum value.

Method Detail

values

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

Returns:

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

valueOf

public static SchlegelCalculator.Statistic valueOf(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:

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

NullPointerException - if the argument is null