Enum ObservationDurationDescription

java.lang.Object
java.lang.Enum<ObservationDurationDescription>
nom.tam.fits.header.ObservationDurationDescription
All Implemented Interfaces:
Serializable, Comparable<ObservationDurationDescription>, java.lang.constant.Constable, IFitsHeader
public enum ObservationDurationDescription extends Enum<ObservationDurationDescription> implements IFitsHeader

This data dictionary contains FITS keywords that have been widely used within the astronomical community. Many of them are not part of the FITS standard. For more standard FITS keywords relating to date-time see DateTime instead. 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
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
    DATE_END
    Deprecated.
    Part of the FITS standard, use DateTime.DATE_END instead
    ELAPTIME
    The value field shall contain a floating point number giving the difference between the stop and start times of the observation in units of seconds.
    EXPOSURE
    The value field shall contain a floating point number giving the exposure time of the observation in units of seconds.
    EXPTIME
    The value field shall contain a floating point number giving the exposure time of the observation in units of seconds.
    LIVETIME
    The value field shall contain a floating point number giving the total integrated exposure time in units of seconds corrected for detector 'dead time' effects which reduce the net efficiency of the detector.
    ONTIME
    The value field shall contain a floating point number giving the total integrated exposure time of the observation in units of seconds.
    TELAPSE
    Deprecated.
    Part of the FITS standard, use DateTime.TELAPSE instead.
    TIME_END
    The value field shall contain a character string that gives the time at which the observation ended.
    TIME_OBS
    The value field shall contain a character string that gives the time at which the observation started.

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

      @Deprecated public static final ObservationDurationDescription DATE_END
      Deprecated.
      Part of the FITS standard, use DateTime.DATE_END instead
      The value field shall contain a character string that gives the date on which the observation ended. This keyword has the same format, and is used in conjunction with, the standard DATA-OBS keyword that gives the starting date of the observation. These 2 keywords may give either the calendar date using the 'yyyy-mm-dd' format, or may give the full date and time using the 'yyyy-mm-ddThh:mm:ss.sss' format.

    • ELAPTIME

      public static final ObservationDurationDescription ELAPTIME
      The value field shall contain a floating point number giving the difference between the stop and start times of the observation in units of seconds. This keyword is synonymous with the TELAPSE keyword.
      See Also:

    • EXPOSURE

      public static final ObservationDurationDescription EXPOSURE
      The value field shall contain a floating point number giving the exposure time of the observation in units of seconds. The exact definition of 'exposure time' is mission dependent and may, for example, include corrections for shutter open and close duration, detector dead time, vignetting, or other effects. This keyword is synonymous with the EXPTIME keyword.
      See Also:

    • EXPTIME

      public static final ObservationDurationDescription EXPTIME
      The value field shall contain a floating point number giving the exposure time of the observation in units of seconds. The exact definition of 'exposure time' is mission dependent and may, for example, include corrections for shutter open and close duration, detector dead time, vignetting, or other effects. This keyword is synonymous with the EXPOSURE keyword.
      See Also:

    • LIVETIME

      public static final ObservationDurationDescription LIVETIME
      The value field shall contain a floating point number giving the total integrated exposure time in units of seconds corrected for detector 'dead time' effects which reduce the net efficiency of the detector. The ratio of LIVETIME/ONTIME gives the mean dead time correction during the observation, which lies in the range 0.0 to 1.0.

    • ONTIME

      public static final ObservationDurationDescription ONTIME
      The value field shall contain a floating point number giving the total integrated exposure time of the observation in units of seconds. ONTIME may be less than TELAPSE if there were intevals during the observation in which the target was not observed (e.g., the shutter was closed, or the detector power was turned off).
      See Also:

    • TELAPSE

      @Deprecated public static final ObservationDurationDescription TELAPSE
      Deprecated.
      Part of the FITS standard, use DateTime.TELAPSE instead.
      The value field shall contain a floating point number giving the difference between the stop and start times of the observation in units of seconds. This keyword is synonymous with the ELAPTIME keyword.

    • TIME_END

      public static final ObservationDurationDescription TIME_END
      The value field shall contain a character string that gives the time at which the observation ended. This keyword is used in conjunction with the DATE-END keyword to give the ending time of the observation; the DATE-END keyword gives the ending calendar date, with format 'yyyy-mm-dd', and TIME-END gives the time within that day using the format 'hh:mm:ss.sss...'. This keyword should not be used if the time is included directly as part of the DATE-END keyword value with the format 'yyyy-mm-ddThh:mm:ss.sss'.
      See Also:

    • TIME_OBS

      public static final ObservationDurationDescription TIME_OBS
      The value field shall contain a character string that gives the time at which the observation started. This keyword is used in conjunction with the standard DATE-OBS keyword to give the starting time of the observation; the DATE-OBS keyword gives the starting calendar date, with format 'yyyy-mm-dd', and TIME-OBS gives the time within that day using the format 'hh:mm:ss.sss...'. This keyword should not be used if the time is included directly as part of the DATE-OBS keyword value with the format 'yyyy-mm-ddThh:mm:ss.sss'.
      See Also:

  • Method Details

    • values

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