net.talvi.puffinplot.data

Enum MeasurementAxis

java.lang.Object

java.lang.Enum<MeasurementAxis>

net.talvi.puffinplot.data.MeasurementAxis

All Implemented Interfaces:

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

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

An axis along which a magnetic moment measurement was made.

Enum Constant Summary

Enum Constants

Enum Constant and Description
H a virtual axis used in the modified Zijderveld plot, corresponding to the direction of the horizontal component of a data point.
MINUSX the inverted X axis
MINUSY the inverted Y axis
MINUSZ the inverted z axis
X the x axis
Y the y axis
Z the z axis

Method Summary

Modifier and Type	Method and Description
Direction	getDirection() Returns a compass (field) direction corresponding to this axis.
MeasurementAxis	opposite() Returns an axis pointing in the opposite direction to this axis.
static MeasurementAxis	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MeasurementAxis[]	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

X

public static final MeasurementAxis X

the x axis

Y

public static final MeasurementAxis Y

the y axis

Z

public static final MeasurementAxis Z

the z axis

MINUSX

public static final MeasurementAxis MINUSX

the inverted X axis

MINUSY

public static final MeasurementAxis MINUSY

the inverted Y axis

MINUSZ

public static final MeasurementAxis MINUSZ

the inverted z axis

H

public static final MeasurementAxis H

a virtual axis used in the modified Zijderveld plot, corresponding to the direction of the horizontal component of a data point.

See Also:

ZPlot

Method Detail

values

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

Returns:

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

valueOf

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

opposite

public MeasurementAxis opposite()

Returns an axis pointing in the opposite direction to this axis.

Returns:

the opposing axis

getDirection

public Direction getDirection()

Returns a compass (field) direction corresponding to this axis. The returned direction should be interpreted as a compass direction rather than a "paper" (up/down/left/right) direction. The direction indicates the original field orientation corresponding to this measurement axis. This method is useful for determining labels on Zijderveld plots.

Returns:

the compass direction for this axis