Package gaiasky.util.gaia

Enum Class FOV

java.lang.Object
java.lang.Enum<FOV>
gaiasky.util.gaia.FOV
All Implemented Interfaces:
Serializable, Comparable<FOV>, Constable
public enum FOV extends Enum<FOV>
FOV enumeration

  • 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
    FOV1
     
    FOV2
     
    FOV3
     
    FOV4
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static FOV
    F
     
    static FOV[]
    FollowingFovs
     
    static FOV[]
    MotionFovs
    Lists of FOVs grouped by the application of AC motion in theis related observations
    static FOV[]
    NullMotionFovs
     
    static FOV
    P
    Mapping/Alias of the FOVs (with AC motion applied) to the "Following/Preceding" telescope nomenclature (mainly for AGIS use)
    static FOV[]
    PrecedingFovs
    Lists of FOVs grouped by associated telescope "Following/Preceding"
    static FOV[]
    Telescopes
    List of the telescope alias of the FOVs with AC motion applied

  • Method Summary

    Modifier and Type
    Method
    Description
    static FOV
    getFov​(int fovIndex)
    Get enumeration type for the given FoV index [0-3]
    static FOV
    getFovByNumber​(int fovNumber)
    Get enumeration type for the given FoV number [1-4]
    static int
    getFovCount()
    Get the number of FoV identifiers (including the both motion configurations)
    byte
    getIndex()
    Get FOV index [0-3]
    byte
    getNumber()
    Get FOV number [1-4]
    double
    getNumericalFieldIndex()
    Get numerical field index defined as 1.0 for FOV1-3 and -1.0 for FOV2-4
    byte
    getTelescopeIndex()
    Get telescope index [0-1]
    byte
    getTelescopeNumber()
    Get telescope number [1-2]
    boolean
    isFollowingTelescope()
    Determine whether a given field of view corresponds to the following telescope
    boolean
    isMotion()
    Indicates if this FoV has motion propagation in the Focal plane
    boolean
    isNullMotion()
    Indicates if this FoV has Null motion propagation in the Focal plane
    boolean
    isPrecedingTelescope()
    Indicates whether this field of view corresponds to the preceding telescope
    static boolean
    validFov​(int fovIndex)
    Indicates if the FoV index is valid [0-3]
    static FOV
    valueOf​(String name)
    Returns the enum constant of this class with the specified name.
    static FOV[]
    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, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • FOV1

      public static final FOV FOV1

    • FOV2

      public static final FOV FOV2

    • FOV3

      public static final FOV FOV3

    • FOV4

      public static final FOV FOV4

  • Field Details

    • P

      public static final FOV P
      Mapping/Alias of the FOVs (with AC motion applied) to the "Following/Preceding" telescope nomenclature (mainly for AGIS use)

    • F

      public static final FOV F

    • Telescopes

      public static final FOV[] Telescopes
      List of the telescope alias of the FOVs with AC motion applied

    • PrecedingFovs

      public static final FOV[] PrecedingFovs
      Lists of FOVs grouped by associated telescope "Following/Preceding"

    • FollowingFovs

      public static final FOV[] FollowingFovs

    • MotionFovs

      public static final FOV[] MotionFovs
      Lists of FOVs grouped by the application of AC motion in theis related observations

    • NullMotionFovs

      public static final FOV[] NullMotionFovs

  • Method Details

    • values

      public static FOV[] 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 FOV 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

    • getFov

      public static FOV getFov​(int fovIndex)
      Get enumeration type for the given FoV index [0-3]
      Parameters:
      fovIndex - FoV index [0-3]
      Returns:
      enumeration type for the desired FoV index, null if index is not valid

    • getFovByNumber

      public static FOV getFovByNumber​(int fovNumber)
      Get enumeration type for the given FoV number [1-4]
      Parameters:
      fovNumber - FoV number [1-4]
      Returns:
      enumeration type for the desired FoV number, null if number is invalid

    • getFovCount

      public static int getFovCount()
      Get the number of FoV identifiers (including the both motion configurations)
      Returns:
      Number of FoV identifiers

    • validFov

      public static boolean validFov​(int fovIndex)
      Indicates if the FoV index is valid [0-3]
      Parameters:
      fovIndex - FoV [0-3]
      Returns:
      true if the FoV index is valid, false otherwise

    • getIndex

      public byte getIndex()
      Get FOV index [0-3]
      Returns:
      FOV index [FOV1:0, FOV2:1, FOV3:2, FOV4:3]

    • getNumber

      public byte getNumber()
      Get FOV number [1-4]
      Returns:
      FOV number [FOV1:1, FOV2:2, FOV3:3, FOV4:4]

    • getNumericalFieldIndex

      public double getNumericalFieldIndex()
      Get numerical field index defined as 1.0 for FOV1-3 and -1.0 for FOV2-4
      Returns:
      the numerical field index [-1.0:+1.0]

    • getTelescopeIndex

      public byte getTelescopeIndex()
      Get telescope index [0-1]
      Returns:
      Telescope index [FOV1:0, FOV2:1, FOV3:0, FOV4:1]

    • getTelescopeNumber

      public byte getTelescopeNumber()
      Get telescope number [1-2]
      Returns:
      Telescope number [FOV1:1, FOV2:2, FOV3:1, FOV4:2]

    • isFollowingTelescope

      public boolean isFollowingTelescope()
      Determine whether a given field of view corresponds to the following telescope
      Returns:
      true if field of view corresponds to the following telescope, false otherwise

    • isMotion

      public boolean isMotion()
      Indicates if this FoV has motion propagation in the Focal plane
      Returns:
      True if this FoV correspond to a motion propagation observation

    • isNullMotion

      public boolean isNullMotion()
      Indicates if this FoV has Null motion propagation in the Focal plane
      Returns:
      True if this FoV correspond to a Null motion propagation observation

    • isPrecedingTelescope

      public boolean isPrecedingTelescope()
      Indicates whether this field of view corresponds to the preceding telescope
      Returns:
      true if field of view corresponds to the preceding telescope, false otherwise