com.xinapse.multisliceimage.Analyze
Enum XYZUnits

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

All Implemented Interfaces:

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

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

This class represents the NIFTI units of length.

Enum Constant Summary

METRE
Length units of metres.

MICRON
Length units of microns.

MM
Length units of mm.

UNKNOWN
Unknown length units.

Method Summary

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

Unknown length units. Assume mm by default.

METRE

public static final XYZUnits METRE

Length units of metres.

MM

public static final XYZUnits MM

Length units of mm.

MICRON

public static final XYZUnits MICRON

Length units of microns.

Method Detail

values

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

Returns:

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

valueOf

public static XYZUnits 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 XYZUnits.

Overrides:

toString in class java.lang.Enum<XYZUnits>

Returns:

a string describing this XYZUnits.

main

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

Run a self-test on the XYZUnits class.

Parameters:

args - ignored.