Enum DateTime

java.lang.Object
java.lang.Enum<DateTime>
nom.tam.fits.header.DateTime
All Implemented Interfaces:
Serializable, Comparable<DateTime>, java.lang.constant.Constable, IFitsHeader
public enum DateTime extends Enum<DateTime> implements IFitsHeader
Date-time related keywords defined by the FITS standard.
Since:
1.19
Author:
Attila Kovacs
See Also:

  • 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
    BEPOCH
    [yr] Besselian epoch of observation
    DATE
    The date on which the HDU was created, in the format specified in the FITS Standard.
    DATE_AVG
    The average date of the observation, in the format specified in the FITS Standard.
    DATE_BEG
    The start date of the observation, in the format specified in the FITS Standard.
    DATE_END
    The end date of the observation, in the format specified in the FITS Standard.
    DATE_OBS
    The date of the observation, in the format specified in the FITS Standard.
    DATEREF
    The reference date of the observation, in the format specified in the FITS Standard.
    DAVGn
    Avearge date of the observation for the given column index, in the format specified in the FITS Standard.
    DOBSn
    The date of the observation for the given column index, in the format specified in the FITS Standard.
    JDREF
    [day] Reference Julian Date
    JEPOCH
    [yr] Julian epoch of observation
    MJD_AVG
    [day] Average Modified Julian Date of observation
    MJD_BEG
    [day] Modified Julian Date of the start of observation
    MJD_END
    [day] Average Modified Julian Date of the end of observation
    MJD_OBS
    [day] Modified Julian Date of observation
    MJDAn
    [day] Average Modified Julian Date of observation for the given column index
    MJDOBn
    [day] Modified Julian Date of observation for the given column index
    MJDREF
    [day] Reference Modified Julian Date
    PLEPHEM
    Solar system ephemeris used, e.g.
    TELAPSE
    Wall clock exposure duration (in specified time units, or else seconds)
    TIMEDEL
    Time resolution (in specified time units, or else seconds)
    TIMEOFFS
    Precision time offset (in specified time units, or else seconds)
    TIMEPIXR
    Time location within pixel, between 0.0 and 1.0 (default 0.5).
    TIMERDER
    Random time error (in specified time units, or else seconds)
    TIMESYER
    Systematic time error (in specified time units, or else seconds)
    TIMESYS
    Time reference system name
    TIMEUNIT
    Time unit name
    TRDIRn
    Time reference direction for given column index, e.g.
    TREFDIR
    Pointer to time reference direction
    TREFPOS
    Time reference location
    TRPOSn
    Time reference location for given column index.
    TSTART
    The start time of the observation, in the format specified in the FITS Standard, as decimal or in the format HH:MM:SS[.s...]'.
    TSTOP
    The end time of the observation, in the format specified in the FITS Standard, as decimal or in the format HH:MM:SS[.s...]'.
    XPOSURE
    Net exposure duration (in specified time units, or else seconds)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PLEPHEM_DE200
    Solar System ephemeris value for PLEPHEM for Standish (1990).
    static final String
    PLEPHEM_DE405
    Solar System ephemeris value for PLEPHEM for Standish (1998).
    static final String
    PLEPHEM_DE421
    Solar System ephemeris value for PLEPHEM for Folkner, et al. (2009).
    static final String
    PLEPHEM_DE430
    Solar System ephemeris value for PLEPHEM for Folkner, et al. (2014).
    static final String
    PLEPHEM_DE431
    Solar System ephemeris value for PLEPHEM for Folkner, et al. (2014).
    static final String
    PLEPHEM_DE432
    Solar System ephemeris value for PLEPHEM for Folkner, et al. (2014).
    static final String
    PLEPHEM_DE440
    Solar System ephemeris value for PLEPHEM for Park, et al. (2021).
    static final String
    PLEPHEM_DE441
    Solar System ephemeris value for PLEPHEM for Park, et al. (2021).
    static final String
    TIMESYS_ET
    Ephemeris Time (ET) timescale value.
    static final String
    TIMESYS_GMT
    Deprecated.
    Greenwich Mean time (GMT) timescale value; deprecated by the FITS standard, use TIMESYS_UTC instead.
    static final String
    TIMESYS_GPS
    Global Positioning System (GPS) time timescale value.
    static final String
    TIMESYS_IAT
    Deprecated.
    Deprecated by the FITS standard, use TIMESYS_TAI instead.
    static final String
    TIMESYS_LOCAL
    Local time timescale value for free-running clocks.
    static final String
    TIMESYS_TAI
    International Atomic Time (TAI) timescale value.
    static final String
    TIMESYS_TCB
    Barycentric Coordinated Time (TCB) timescale value.
    static final String
    TIMESYS_TCG
    Geocentric Coordinated Time (TCG) timescale value.
    static final String
    TIMESYS_TDB
    Barycentric Dynamical Time (TDB) timescale value.
    static final String
    TIMESYS_TDT
    Terrestrial Dynamical Time (TDT) timescale value.
    static final String
    TIMESYS_TT
    Terrestrial Time (TT) timescale value.
    static final String
    TIMESYS_UT1
    Earth rotation time (UT1) timescale value.
    static final String
    TIMESYS_UTC
    Universal Coordinated Time (UTC) timescale value.
    static final String
    TIMEUNIT_BESSELIAN_YEAR
    Time unit value for time measured in Besselian years (essentially the same as TIMEUNIT_TROPICAL_YEAR)
    static final String
    TIMEUNIT_DAY
    Time unit value for time measured in days
    static final String
    TIMEUNIT_HOUR
    Time unit value for time measured in hours
    static final String
    TIMEUNIT_JULIAN_CENTURY
    Time unit value for time measured in seconds (1 cy = 36525 d)
    static final String
    TIMEUNIT_JULIAN_YEAR
    Time unit value for time measured in Julian years (1 a = 365.25 d)
    static final String
    TIMEUNIT_MINUTE
    Time unit value for time measured in minutes
    static final String
    TIMEUNIT_SECOND
    Time unit value for time measured in seconds
    static final String
    TIMEUNIT_TROPICAL_YEAR
    Time unit value for time measured in tropical years (1 ta ~ 365.2421988 d)
    static final String
    TIMEUNIT_YEAR
    Time unit value for time measured in Julian years (same as TIMEUNIT_JULIAN_YEAR)
    static final String
    TREFPOS_BARYCENTER
    Barycentric (Solar-system) time reference position
    static final String
    TREFPOS_CUSTOM
    Topocentric time reference position that is not the observatory location
    static final String
    TREFPOS_EMBARYCENTER
    Earth-Moon barycenter time reference position
    static final String
    TREFPOS_GALACTIC
    Galactocentric time reference position
    static final String
    TREFPOS_GEOCENTER
    Geocentric time reference position
    static final String
    TREFPOS_HELIOCENTER
    Helioentric time reference position
    static final String
    TREFPOS_JUPITER
    Time reference position at the center of Jupiter
    static final String
    TREFPOS_MARS
    Time reference position at the center of Mars
    static final String
    TREFPOS_MERCURY
    Time reference position at the center of Mercury
    static final String
    TREFPOS_NEPTUNE
    Time reference position at the center of Neptune
    static final String
    TREFPOS_RELOCATABLE
    Relocatable time reference position (for simulations only)
    static final String
    TREFPOS_SATURN
    Time reference position at the center of Saturn
    static final String
    TREFPOS_TOPOCENTER
    Topocentric time reference position
    static final String
    TREFPOS_URANUS
    Time reference position at the center of Uranus
    static final String
    TREFPOS_VENUS
    Time reference position at the center of Venus

    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 DateTime
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static DateTime[]
    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

    • DATE

      public static final DateTime DATE
      The date on which the HDU was created, in the format specified in the FITS Standard. The old date format was 'yy/mm/dd' and may be used only for dates from 1900 through 1999. the new Y2K compliant date format is 'yyyy-mm-dd' or 'yyyy-mm-ddTHH:MM:SS[.sss]'.
      Since:
      1.19

    • DATE_OBS

      public static final DateTime DATE_OBS
      The date of the observation, in the format specified in the FITS Standard. The old date format was 'yy/mm/dd' and may be used only for dates from 1900 through 1999. The new Y2K compliant date format is 'yyyy-mm-dd' or 'yyyy-mm-ddTHH:MM:SS[.sss]'.
      Since:
      1.19

    • DOBSn

      public static final DateTime DOBSn
      The date of the observation for the given column index, in the format specified in the FITS Standard. The old date format was 'yy/mm/dd' and may be used only for dates from 1900 through 1999. The new Y2K compliant date format is 'yyyy-mm-dd' or 'yyyy-mm-ddTHH:MM:SS[.sss]'.
      Since:
      1.19

    • DATE_AVG

      public static final DateTime DATE_AVG
      The average date of the observation, in the format specified in the FITS Standard. The old date format was 'yy/mm/dd' and may be used only for dates from 1900 through 1999. The new Y2K compliant date format is 'yyyy-mm-dd' or 'yyyy-mm-ddTHH:MM:SS[.sss]'.
      Since:
      1.19

    • DAVGn

      public static final DateTime DAVGn
      Avearge date of the observation for the given column index, in the format specified in the FITS Standard. The old date format was 'yy/mm/dd' and may be used only for dates from 1900 through 1999. The new Y2K compliant date format is 'yyyy-mm-dd' or 'yyyy-mm-ddTHH:MM:SS[.sss]'.
      Since:
      1.19

    • DATE_BEG

      public static final DateTime DATE_BEG
      The start date of the observation, in the format specified in the FITS Standard. The old date format was 'yy/mm/dd' and may be used only for dates from 1900 through 1999. The new Y2K compliant date format is 'yyyy-mm-dd' or 'yyyy-mm-ddTHH:MM:SS[.sss]'.
      Since:
      1.19

    • DATE_END

      public static final DateTime DATE_END
      The end date of the observation, in the format specified in the FITS Standard. The old date format was 'yy/mm/dd' and may be used only for dates from 1900 through 1999. The new Y2K compliant date format is 'yyyy-mm-dd' or 'yyyy-mm-ddTHH:MM:SS[.sss]'.
      Since:
      1.19

    • DATEREF

      public static final DateTime DATEREF
      The reference date of the observation, in the format specified in the FITS Standard. The old date format was 'yy/mm/dd' and may be used only for dates from 1900 through 1999. The new Y2K compliant date format is 'yyyy-mm-dd' or 'yyyy-mm-ddTHH:MM:SS[.sss]'.
      Since:
      1.19

    • MJD_OBS

      public static final DateTime MJD_OBS
      [day] Modified Julian Date of observation
      Since:
      1.19

    • MJDOBn

      public static final DateTime MJDOBn
      [day] Modified Julian Date of observation for the given column index
      Since:
      1.19

    • MJD_AVG

      public static final DateTime MJD_AVG
      [day] Average Modified Julian Date of observation
      Since:
      1.19

    • MJDAn

      public static final DateTime MJDAn
      [day] Average Modified Julian Date of observation for the given column index
      Since:
      1.19

    • MJD_BEG

      public static final DateTime MJD_BEG
      [day] Modified Julian Date of the start of observation
      Since:
      1.19

    • MJD_END

      public static final DateTime MJD_END
      [day] Average Modified Julian Date of the end of observation
      Since:
      1.19

    • MJDREF

      public static final DateTime MJDREF
      [day] Reference Modified Julian Date
      Since:
      1.19

    • JDREF

      public static final DateTime JDREF
      [day] Reference Julian Date
      Since:
      1.19

    • TSTART

      public static final DateTime TSTART
      The start time of the observation, in the format specified in the FITS Standard, as decimal or in the format HH:MM:SS[.s...]'.
      Since:
      1.19

    • TSTOP

      public static final DateTime TSTOP
      The end time of the observation, in the format specified in the FITS Standard, as decimal or in the format HH:MM:SS[.s...]'.
      Since:
      1.19

    • BEPOCH

      public static final DateTime BEPOCH
      [yr] Besselian epoch of observation
      Since:
      1.19

    • JEPOCH

      public static final DateTime JEPOCH
      [yr] Julian epoch of observation
      Since:
      1.19

    • XPOSURE

      public static final DateTime XPOSURE
      Net exposure duration (in specified time units, or else seconds)
      Since:
      1.19

    • TELAPSE

      public static final DateTime TELAPSE
      Wall clock exposure duration (in specified time units, or else seconds)
      Since:
      1.19

    • TIMESYS

      public static final DateTime TIMESYS
      Time reference system name
      Since:
      1.19

    • TREFPOS

      public static final DateTime TREFPOS
      Time reference location
      Since:
      1.19

    • TRPOSn

      public static final DateTime TRPOSn
      Time reference location for given column index.
      Since:
      1.19

    • TREFDIR

      public static final DateTime TREFDIR
      Pointer to time reference direction
      Since:
      1.19

    • TRDIRn

      public static final DateTime TRDIRn
      Time reference direction for given column index, e.g. 'TOPOCENT'
      Since:
      1.19

    • PLEPHEM

      public static final DateTime PLEPHEM
      Solar system ephemeris used, e.g. 'DE-405'.
      Since:
      1.19

    • TIMEUNIT

      public static final DateTime TIMEUNIT
      Time unit name
      Since:
      1.19

    • TIMEOFFS

      public static final DateTime TIMEOFFS
      Precision time offset (in specified time units, or else seconds)
      Since:
      1.19

    • TIMESYER

      public static final DateTime TIMESYER
      Systematic time error (in specified time units, or else seconds)
      Since:
      1.19

    • TIMERDER

      public static final DateTime TIMERDER
      Random time error (in specified time units, or else seconds)
      Since:
      1.19

    • TIMEDEL

      public static final DateTime TIMEDEL
      Time resolution (in specified time units, or else seconds)
      Since:
      1.19

    • TIMEPIXR

      public static final DateTime TIMEPIXR
      Time location within pixel, between 0.0 and 1.0 (default 0.5).
      Since:
      1.19

  • Field Details

  • Method Details

    • values

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