Package org.ivoa.dm.caom2

Enum Class PolarizationState

java.lang.Object
java.lang.Enum<PolarizationState>
org.ivoa.dm.caom2.PolarizationState
All Implemented Interfaces:
Serializable, Comparable<PolarizationState>, Constable
@VoDml(id="caom2:PolarizationState", role=enumeration) public enum PolarizationState extends Enum<PolarizationState>
a classification of polarization (Stokes states plus other related quantities); work-around: using the name of the literal to convey the serialised value. Enumeration PolarizationState :

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CPOLI
    Value CPOLI : circular polarization intensity: |V|.
    EPOLI
    Value EPOLI : elliptical polarization intensity: sqrt(Q^2 + U^2 + V^2).
    FPOLI
    Value FPOLI : fractional linear polarization: POLI/I.
    I
    Value I : unpolarized.
    LL
    Value LL : left-left circular.
    LR
    Value LR : left-right cross-circular.
    NPOLI
    Value NPOLI : unpolarized intensity: I - EPOLI.
    POLA
    Value POLA : linear polarization angle: 1/2 arctan(U,Q).
    POLI
    Value POLI : linear polarized intensity: sqrt(Q^2 + U^2).
    Q
    Value Q : Stokes linear Q.
    RL
    Value RL : right-left cross-circular.
    RR
    Value RR : right-right circular.
    U
    Value U : Stokes linear U.
    V
    Value V : Stokes circular V.
    XX
    Value XX : X parallel linear.
    XY
    Value XY : XY cross-linear.
    YX
    Value YX : YX cross-linear.
    YY
    Value YY : Y parallel linear.

  • Method Summary

    Modifier and Type
    Method
    Description
    static final PolarizationState
    fromValue(String v)
    Return the PolarizationState enum constant corresponding to the given string representation (value)
    final String
    toString()
    Return the string representation of this enum constant (value)
    final String
    value()
    Return the string representation of this enum constant (value)
    static PolarizationState
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static PolarizationState[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • I

      public static final PolarizationState I
      Value I : unpolarized.

    • Q

      public static final PolarizationState Q
      Value Q : Stokes linear Q.

    • U

      public static final PolarizationState U
      Value U : Stokes linear U.

    • V

      public static final PolarizationState V
      Value V : Stokes circular V.

    • RR

      public static final PolarizationState RR
      Value RR : right-right circular.

    • LL

      public static final PolarizationState LL
      Value LL : left-left circular.

    • RL

      public static final PolarizationState RL
      Value RL : right-left cross-circular.

    • LR

      public static final PolarizationState LR
      Value LR : left-right cross-circular.

    • XX

      public static final PolarizationState XX
      Value XX : X parallel linear.

    • YY

      public static final PolarizationState YY
      Value YY : Y parallel linear.

    • XY

      public static final PolarizationState XY
      Value XY : XY cross-linear.

    • YX

      public static final PolarizationState YX
      Value YX : YX cross-linear.

    • POLI

      public static final PolarizationState POLI
      Value POLI : linear polarized intensity: sqrt(Q^2 + U^2).

    • FPOLI

      public static final PolarizationState FPOLI
      Value FPOLI : fractional linear polarization: POLI/I.

    • POLA

      public static final PolarizationState POLA
      Value POLA : linear polarization angle: 1/2 arctan(U,Q).

    • EPOLI

      public static final PolarizationState EPOLI
      Value EPOLI : elliptical polarization intensity: sqrt(Q^2 + U^2 + V^2).

    • CPOLI

      public static final PolarizationState CPOLI
      Value CPOLI : circular polarization intensity: |V|.

    • NPOLI

      public static final PolarizationState NPOLI
      Value NPOLI : unpolarized intensity: I - EPOLI.

  • Method Details

    • values

      public static PolarizationState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PolarizationState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • value

      public final String value()
      Return the string representation of this enum constant (value)
      Returns:
      string representation of this enum constant (value)

    • toString

      public final String toString()
      Return the string representation of this enum constant (value)
      Overrides:
      toString in class Enum<PolarizationState>
      Returns:
      string representation of this enum constant (value)
      See Also:

    • fromValue

      public static final PolarizationState fromValue(String v)
      Return the PolarizationState enum constant corresponding to the given string representation (value)
      Parameters:
      v - string representation (value)
      Returns:
      PolarizationState enum constant
      Throws:
      IllegalArgumentException - if there is no matching enum constant