Enum ObservationDescription

java.lang.Object
java.lang.Enum<ObservationDescription>
nom.tam.fits.header.ObservationDescription
All Implemented Interfaces:
Serializable, Comparable<ObservationDescription>, java.lang.constant.Constable, IFitsHeader
public enum ObservationDescription extends Enum<ObservationDescription> implements IFitsHeader
This data dictionary contains FITS keywords that have been widely used within the astronomical community. It is recommended that these keywords only be used as defined here. These are the Keywords that describe the observation. 
 See http://heasarc.gsfc.nasa.gov/docs/fcg/common_dict.html
Author:
Richard van Nieuwenhoven

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

    Nested classes/interfaces inherited from interface IFitsHeader

    IFitsHeader.HDU, IFitsHeader.SOURCE, IFitsHeader.VALUE
    Modifier and Type
    Interface
    Description
    static enum 
    IFitsHeader.HDU
    An enumeration of HDU types in which a header keyword may be used.
    static enum 
    IFitsHeader.SOURCE
    Documentation sources for the various known conventions.
    static enum 
    IFitsHeader.VALUE
    Values types to which implementing keywords can be restricted to.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AIRMASS
    The value field shall contain a floating point number giving the air mass during the observation by a ground based telescope.
    DEC
    The value field gives the declination of the observation.
    DEC_NOM
    The value field shall contain a floating point number giving the nominal declination of the pointing direction in units of decimal degrees.
    DEC_OBJ
    The value field shall contain a floating point number giving the declination of the observed object in units of decimal degrees.
    DEC_PNT
    The value field shall contain a floating point number giving the declination of the pointing direction in units of decimal degrees.
    DEC_SCX
    The value field shall contain a floating point number giving the declination of the space craft (or telescope platform) X axis during the observation in decimal degrees.
    DEC_SCZ
    The value field shall contain a floating point number giving the declination of the space craft (or telescope platform) Z axis during the observation in decimal degrees.
    LATITUDE
    The value field shall contain a floating point number giving the geographic latitude from which the observation was made in units of degrees.
    MOONANGL
    The value field shall contain a floating point number giving the angle between the direction of the observation (e.g., the optical axis of the telescope or the position of the target) and the moon, measured in degrees.
    OBJNAME
    The value field shall contain a character string giving a name for the observed object that conforms to the IAU astronomical object naming conventions.
    OBS_ID
    The value field shall contain a character string which uniquely identifies the dataset contained in the FITS file.
    ORIENTAT
    The value field shall contain a floating point number giving the position angle of the y axis of the detector projected on the sky, in degrees east of north.
    PA_PNT
    The value field shall contain a floating point number giving the position angle of the relevant aspect of telescope pointing axis and/or instrument on the sky in units of degrees east of north.
    RA
    The value field gives the Right Ascension of the observation.
    RA_NOM
    The value field shall contain a floating point number giving the nominal Right Ascension of the pointing direction in units of decimal degrees.
    RA_OBJ
    The value field shall contain a floating point number giving the Right Ascension of the observed object in units of decimal degrees.
    RA_PNT
    The value field shall contain a floating point number giving the Right Ascension of the pointing direction in units of decimal degrees.
    RA_SCX
    The value field shall contain a floating point number giving the Right Ascension of the space craft (or telescope platform) X axis during the observation in decimal degrees.
    RA_SCY
    The value field shall contain a floating point number giving the Right Ascension of the space craft (or telescope platform) Y axis during the observation in decimal degrees.
    RA_SCZ
    The value field shall contain a floating point number giving the Right Ascension of the space craft (or telescope platform) Z axis during the observation in decimal degrees.
    SUNANGLE
    The value field shall contain a floating point number giving the angle between the direction of the observation (e.g., the optical axis of the telescope or the position of the target) and the sun, measured in degrees.

  • Field Summary

    Fields inherited from interface IFitsHeader

    MAX_INDEX
    Modifier and Type
    Field
    Description
    static final int
    MAX_INDEX
    Max numeric index we may use to replace n in the Java name of indexed variables.

  • Method Summary

    Modifier and Type
    Method
    Description
    final FitsKey
    impl()
    (primarily for internal use) Returns the concrete implementation of this header entry, which provides implementation of access methods.
    static ObservationDescription
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static ObservationDescription[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface IFitsHeader

    comment, extractIndices, hdu, key, n, status, valueType
    Modifier and Type
    Method
    Description
    default String
    comment()
    Returns the comment associated to this FITS header entry.
    default int[]
    extractIndices(String key)
    Extracts the indices for this stndardized key from an actual keyword realization.
    default IFitsHeader.HDU
    hdu()
    Returns the type of HDU(s) in which this header entry may be used.
    default String
    key()
    Returns the FITS header keyword (or keyword template) for this header entry.
    default IFitsHeader
    n(int... numbers)
    Constructs an indexed FITS header keyword entry from this stem, replacing index place-holders (indicated by lower-case 'n' in the name) with actual numerical values.
    default IFitsHeader.SOURCE
    status()
    Returns the standard convention, which defines this FITS header entry
    default IFitsHeader.VALUE
    valueType()
    The type(s) of value(s) this FITS header entry might take.

  • Enum Constant Details

    • AIRMASS

      public static final ObservationDescription AIRMASS
      The value field shall contain a floating point number giving the air mass during the observation by a ground based telescope. The value of the airmass is often approximated by the secant of the elevation angle and has a value of 1.0 at the zenith and increases towards the horizon. This value is assumed to correspond to the start of the observation unless another interpretation is clearly explained in the comment field.

    • DEC

      public static final ObservationDescription DEC
      The value field gives the declination of the observation. It may be expressed either as a floating point number in units of decimal degrees, or as a character string in 'dd:mm:ss.sss' format where the decimal point and number of fractional digits are optional. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. Example: -47.25944 or '-47:15:34.00'.

    • DEC_NOM

      public static final ObservationDescription DEC_NOM
      The value field shall contain a floating point number giving the nominal declination of the pointing direction in units of decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. The precise definition of this keyword is instrument-specific, but typically the nominal direction corresponds to the direction to which the instrument was requested to point. The DEC_PNT keyword should be used to give the actual pointed direction.

    • DEC_OBJ

      public static final ObservationDescription DEC_OBJ
      The value field shall contain a floating point number giving the declination of the observed object in units of decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword.

    • DEC_PNT

      public static final ObservationDescription DEC_PNT
      The value field shall contain a floating point number giving the declination of the pointing direction in units of decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. The precise definition of this keyword is instrument-specific, but typically the pointed direction corresponds to the optical axis of the instrument. This keyword gives a mean value in cases where the pointing axis was not fixed during the entire observation.

    • DEC_SCX

      public static final ObservationDescription DEC_SCX
      The value field shall contain a floating point number giving the declination of the space craft (or telescope platform) X axis during the observation in decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. This keyword gives a mean value in cases where the axis was not fixed during the entire observation.

    • DEC_SCZ

      public static final ObservationDescription DEC_SCZ
      The value field shall contain a floating point number giving the declination of the space craft (or telescope platform) Z axis during the observation in decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. This keyword gives a mean value in cases where the axis was not fixed during the entire observation.

    • LATITUDE

      public static final ObservationDescription LATITUDE
      The value field shall contain a floating point number giving the geographic latitude from which the observation was made in units of degrees.

    • MOONANGL

      public static final ObservationDescription MOONANGL
      The value field shall contain a floating point number giving the angle between the direction of the observation (e.g., the optical axis of the telescope or the position of the target) and the moon, measured in degrees.

    • OBJNAME

      public static final ObservationDescription OBJNAME
      The value field shall contain a character string giving a name for the observed object that conforms to the IAU astronomical object naming conventions. The value of this keyword is more strictly constrained than for the standard OBJECT keyword which in practice has often been used to record other ancillary information about the observation (e.g. filter, exposure time, weather conditions, etc.).

    • OBS_ID

      public static final ObservationDescription OBS_ID
      The value field shall contain a character string which uniquely identifies the dataset contained in the FITS file. This is typically a sequence number that can contain a mixture of numerical and character values. Example: '10315-01-01-30A'

    • ORIENTAT

      public static final ObservationDescription ORIENTAT
      The value field shall contain a floating point number giving the position angle of the y axis of the detector projected on the sky, in degrees east of north. This keyword is synonymous with the CROTA2 WCS keyword.

    • PA_PNT

      public static final ObservationDescription PA_PNT
      The value field shall contain a floating point number giving the position angle of the relevant aspect of telescope pointing axis and/or instrument on the sky in units of degrees east of north. It commonly applies to the orientation of a slit mask.

    • RA

      public static final ObservationDescription RA
      The value field gives the Right Ascension of the observation. It may be expressed either as a floating point number in units of decimal degrees, or as a character string in 'HH:MM:SS.sss' format where the decimal point and number of fractional digits are optional. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. Example: 180.6904 or '12:02:45.7'.

    • RA_NOM

      public static final ObservationDescription RA_NOM
      The value field shall contain a floating point number giving the nominal Right Ascension of the pointing direction in units of decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. The precise definition of this keyword is instrument-specific, but typically the nominal direction corresponds to the direction to which the instrument was requested to point. The RA_PNT keyword should be used to give the actual pointed direction.

    • RA_OBJ

      public static final ObservationDescription RA_OBJ
      The value field shall contain a floating point number giving the Right Ascension of the observed object in units of decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword.

    • RA_PNT

      public static final ObservationDescription RA_PNT
      The value field shall contain a floating point number giving the Right Ascension of the pointing direction in units of decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. The precise definition of this keyword is instrument-specific, but typically the pointed direction corresponds to the optical axis of the instrument. This keyword gives a mean value in cases where the pointing axis was not fixed during the entire observation.

    • RA_SCX

      public static final ObservationDescription RA_SCX
      The value field shall contain a floating point number giving the Right Ascension of the space craft (or telescope platform) X axis during the observation in decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. This keyword gives a mean value in cases where the axis was not fixed during the entire observation.

    • RA_SCY

      public static final ObservationDescription RA_SCY
      The value field shall contain a floating point number giving the Right Ascension of the space craft (or telescope platform) Y axis during the observation in decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. This keyword gives a mean value in cases where the axis was not fixed during the entire observation.

    • RA_SCZ

      public static final ObservationDescription RA_SCZ
      The value field shall contain a floating point number giving the Right Ascension of the space craft (or telescope platform) Z axis during the observation in decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. This keyword gives a mean value in cases where the axis was not fixed during the entire observation.

    • SUNANGLE

      public static final ObservationDescription SUNANGLE
      The value field shall contain a floating point number giving the angle between the direction of the observation (e.g., the optical axis of the telescope or the position of the target) and the sun, measured in degrees.

  • Method Details

    • values

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

    • valueOf

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

    • impl

      public final FitsKey impl()
      Description copied from interface: IFitsHeader
      (primarily for internal use) Returns the concrete implementation of this header entry, which provides implementation of access methods.
      Specified by:
      impl in interface IFitsHeader
      Returns:
      the implementation of this keyword, which provides the actual access methods. Implementations of this interface should simply return themselves.