com.xinapse.multisliceimage.Analyze
Enum TUnits

java.lang.Object
  java.lang.Enum<TUnits>
      com.xinapse.multisliceimage.Analyze.TUnits

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TUnits>

public enum TUnits
extends java.lang.Enum<TUnits>

This class represents the NIFTI units of time.

Enum Constant Summary

HERTZ
Time units of Hertz.

MSEC
Time units of milli seconds.

PPM
Time units of Hertz.

SEC
Time units of seconds.

UNKNOWN
Unknown time units; assume seconds by default.

USEC
Time units of micro seconds.

Method Summary

static void	main(java.lang.String[] args) Run a self-test on the TUnits class.
java.lang.String	toString() Returns a string describing this TUnits.
static TUnits	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TUnits[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final TUnits UNKNOWN

Unknown time units; assume seconds by default.

SEC

public static final TUnits SEC

Time units of seconds.

MSEC

public static final TUnits MSEC

Time units of milli seconds.

USEC

public static final TUnits USEC

Time units of micro seconds.

HERTZ

public static final TUnits HERTZ

Time units of Hertz.

PPM

public static final TUnits PPM

Time units of Hertz.

Method Detail

values

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

Returns:

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

valueOf

public static TUnits 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

toString

public java.lang.String toString()

Returns a string describing this TUnits.

Overrides:

toString in class java.lang.Enum<TUnits>

Returns:

a string describing this TUnits.

main

public static void main(java.lang.String[] args)

Run a self-test on the TUnits class.

Parameters:

args - ignored.