edu.nrao.sss.astronomy
Enum PolarizationType

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

All Implemented Interfaces:

Serializable, Comparable<PolarizationType>

public enum PolarizationType
extends Enum<PolarizationType>

The polarizations a single receptor can detect.

This enumeration has the same name, and most of the elements have the same names and are in the same order, as the corresponding ALMA enumeration. The one exception is the UNSPECIFIED element, which is not present in the ALMA specification.

References

• World of Physics
• ATNF
• Wikipedia
• University of Arizona (there's a great 3D motion display here)

Version Info:

$Revision: 1387 $

$Date: 2008-06-27 16:17:41 -0600 (Fri, 27 Jun 2008) $

$Author: dharland $ (last person to modify)

Since:

2007-09-24

Author:

David M. Harland

Enum Constant Summary

L
Left-handed circular polarization.

R
Right-handed circular polarization.

UNSPECIFIED
Used when the polarization is unspecified or unknown.

X
X-axis linear polarization.

Y
Y-axis linear polarization.

Method Summary

static PolarizationType	fromString(String text) Returns the polarization type represented by text.
static Set<PolarizationType>	getCircularTypes() Returns the complete set of circular polarizations.
static Set<PolarizationType>	getLinearTypes() Returns the complete set of linear polarizations.
PolarizationType	getOpposite() Returns the opposite polarization.
boolean	isCircular() Returns true if this is a type of circular polarization.
boolean	isLinear() Returns true if this is a type of linear polarization.
static PolarizationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PolarizationType[]	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

R

public static final PolarizationType R

Right-handed circular polarization.

L

public static final PolarizationType L

Left-handed circular polarization.

X

public static final PolarizationType X

X-axis linear polarization.

Y

public static final PolarizationType Y

Y-axis linear polarization.

UNSPECIFIED

public static final PolarizationType UNSPECIFIED

Used when the polarization is unspecified or unknown.

Method Detail

values

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

Returns:

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

valueOf

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

isCircular

public boolean isCircular()

Returns true if this is a type of circular polarization.

Returns:

true if this is a type of circular polarization.

isLinear

public boolean isLinear()

Returns true if this is a type of linear polarization.

Returns:

true if this is a type of linear polarization.

getOpposite

public PolarizationType getOpposite()

Returns the opposite polarization.

Returns:

the opposite polarization.

fromString

public static PolarizationType fromString(String text)

Returns the polarization type represented by text.

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

Parameters:

text - a text representation of a polarization type.

Returns:

the polarization type represented by text.

getCircularTypes

public static Set<PolarizationType> getCircularTypes()

Returns the complete set of circular polarizations.

Returns:

the complete set of circular polarizations.

getLinearTypes

public static Set<PolarizationType> getLinearTypes()

Returns the complete set of linear polarizations.

Returns:

the complete set of linear polarizations.