edu.nrao.sss.astronomy
Enum VelocityFrame

java.lang.Object
  java.lang.Enum<VelocityFrame>
      edu.nrao.sss.astronomy.VelocityFrame

All Implemented Interfaces:

Serializable, Comparable<VelocityFrame>

public enum VelocityFrame
extends Enum<VelocityFrame>

A frame of rest against which a velocity is measured.

This list was based on the list found at http://www.gb.nrao.edu/~fghigo/gbtdoc/doppler.html.

CVS Info:

$Revision: 161 $

$Date: 2006-12-15 11:48:34 -0700 (Fri, 15 Dec 2006) $

$Author: btruitt $

Since:

2006-03-31

Author:

David M. Harland

Enum Constant Summary

BARYCENTRIC
Rest frame based on our solar system's center of mass.

COSMIC_MICROWAVE_BACKGROUND
Rest frame based on COBE measurements of dipole anisotropy.

GALACTOCENTRIC
Rest frame based on our galaxy's center of mass.

GEOCENTRIC
Rest frame based on the earth's center of mass.

HELIOCENTRIC
Rest frame based on our sun's center of mass.

LOCAL_GROUP
Rest frame based on the our local group of galaxies' center of mass.

LSR_DYNAMIC
Dynamic Local Standard of Rest.

LSR_KINEMATIC
Conventional Local Standard of Rest.

TOPOCENTRIC
Rest frame based on the observer's position.

UNKNOWN
An unknown rest frame.

Method Summary

static VelocityFrame	fromString(String text) Returns the velocity frame represented by text.
static VelocityFrame	getDefault() Returns a default velocity frame.
String	toString() Returns a text representation of this enumeration constant.
static VelocityFrame	valueOf(String name) Returns the enum constant of this type with the specified name.
static VelocityFrame[]	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

TOPOCENTRIC

public static final VelocityFrame TOPOCENTRIC

Rest frame based on the observer's position.

GEOCENTRIC

public static final VelocityFrame GEOCENTRIC

Rest frame based on the earth's center of mass.

BARYCENTRIC

public static final VelocityFrame BARYCENTRIC

Rest frame based on our solar system's center of mass.

HELIOCENTRIC

public static final VelocityFrame HELIOCENTRIC

Rest frame based on our sun's center of mass.

LSR_KINEMATIC

public static final VelocityFrame LSR_KINEMATIC

Conventional Local Standard of Rest.

From the source in the class comments, this is:

based on average velocity of stars in the Solar neighborhood.

LSR_DYNAMIC

public static final VelocityFrame LSR_DYNAMIC

Dynamic Local Standard of Rest.

From the source in the class comments, this is:

[The] solar peculiar velocity with respect to a frame in circular motions about the galactic center.

GALACTOCENTRIC

public static final VelocityFrame GALACTOCENTRIC

Rest frame based on our galaxy's center of mass.

LOCAL_GROUP

public static final VelocityFrame LOCAL_GROUP

Rest frame based on the our local group of galaxies' center of mass.

COSMIC_MICROWAVE_BACKGROUND

public static final VelocityFrame COSMIC_MICROWAVE_BACKGROUND

Rest frame based on COBE measurements of dipole anisotropy. (The description above was taken from the source listed in the class comments.)

UNKNOWN

public static final VelocityFrame UNKNOWN

An unknown rest frame.

This element is used to implement the Null Object Pattern. In situations where a method might be tempted to return null, this element is returned instead.

Method Detail

values

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

Returns:

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

valueOf

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

getDefault

public static VelocityFrame getDefault()

Returns a default velocity frame.

Returns:

a default velocity frame.

toString

public String toString()

Returns a text representation of this enumeration constant.

Overrides:

toString in class Enum<VelocityFrame>

Returns:

a text representation of this enumeration constant.

fromString

public static VelocityFrame fromString(String text)

Returns the velocity frame represented by text.

For details about the transformation, see EnumerationUtility.enumFromString(Class, String).

Parameters:

text - a text representation of a velocity frame.

Returns:

the velocity frame system represented by text.