Enum ESOExt

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

Standard ESO FITS keywords, based on ESO's Data Interface Control Document. Only ESO specific keyword, beyond those defined in the standard or in CommonExt are listed.

HIERARCH-type keywords are not currently included in this enumeration.

Since:
1.20.1
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
    ARCFILE
    Provides the name under which the file is stored in the archive
    DISPELEM
    If applicable, the string containing the designation of the dispersing element (grating, grism) used during the observation
    HDRVER
    Modification timestamp.
    LST
    UTC seconds since midnight.
    ORIGFILE
    Records the original file name, as assigned at the instrument workstation.
    PI_COI
    The PI or Co-I’s initials followed by their surname.
    UTC
    UTC seconds since midnight.

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

    • ARCFILE

      public static final ESOExt ARCFILE
      Provides the name under which the file is stored in the archive

    • DISPELEM

      public static final ESOExt DISPELEM
      If applicable, the string containing the designation of the dispersing element (grating, grism) used during the observation

    • HDRVER

      public static final ESOExt HDRVER
      Modification timestamp. Imay be added to files downloaded for the ESO archive by the delivery software. It shall be present in the primary HDU of the delivered file if the metadata of the frame have been updated/modified after the ingestion (an example of such modification is reassigning of the file to a different programme/run or a correction of erroneous metadata). If present, it contains the modification timetag, in restricted ISO 8601 format, YYYY-MM-DDThh:mm:ss.sss. If it is not present in the frame, it indicates that there have been no metadata modifications. HDRVER must not be present in files ingested into archive. In particular, HDRVER must be actively removed prior to ingestion from the headers of products.

    • LST

      public static final ESOExt LST
      UTC seconds since midnight.

    • ORIGFILE

      public static final ESOExt ORIGFILE
      Records the original file name, as assigned at the instrument workstation.

    • PI_COI

      public static final ESOExt PI_COI
      The PI or Co-I’s initials followed by their surname. The primary keyword should repeat the value OBS.PI-COI.NAME.

    • UTC

      public static final ESOExt UTC
      UTC seconds since midnight.

  • Method Details

    • values

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