Package nom.tam.fits.header

Enum DataDescription

java.lang.Object
java.lang.Enum<DataDescription>
nom.tam.fits.header.DataDescription
All Implemented Interfaces:
Serializable, Comparable<DataDescription>, java.lang.constant.Constable, IFitsHeader
public enum DataDescription extends Enum<DataDescription> 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 data or the FITS file itself

See http://heasarc.gsfc.nasa.gov/docs/fcg/common_dict.html

Author:
Richard van Nieuwenhoven

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

    Nested classes/interfaces inherited from interface nom.tam.fits.header.IFitsHeader

    IFitsHeader.HDU, IFitsHeader.SOURCE, IFitsHeader.VALUE

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CONFIGUR
    The value field shall contain a character string that uniquely defines the configuration state, or version, of the the software processing system that generated the data contained in the HDU.
    CREATOR
    The value field shall contain a character string giving the name, and optionally, the version of the program that originally created the current FITS HDU.
    FILENAME
    The value field shall contain a character string giving the the host file name used to record the original data.
    FILETYPE
    The value field shall contain a character string giving the file type suffix of the host file name.
    HDUCLASn
    The value fields of this hierarchical set of indexed keywords shall contain character strings that classify the type of data contained in the HDU.
    HDUCLASS
    The value field shall contain a character string that identifies the domain to which the associated HDUCLASn keywords apply.
    HDUDOC
    The value field shall contain a character string that gives a reference to a document that describes the allowed values that may be assigned to the HDUCLASn data classification keywords.
    HDULEVEL
    This keyword is synonymous to the standard EXTLEVEL.
    HDUNAME
    This keyword is synonymous to the standard EXTNAME keyword except.
    HDUVER
    This keyword is synonymous to the standard EXTVER keyword.
    HDUVERS
    The value field shall contain a character string that gives the specific version of the document referenced by HDUDOC.
    NEXTEND
    The value field shall contain an integer giving the number of standard extensions contained in the FITS file.
    PROGRAM
    The value field shall contain a character string giving the name, and optionally, the version of the program that originally created the current FITS HDU.
    ROOTNAME
    The value field shall contain a character string giving the root of the host file name.
    TDBINn
    The value field of this indexed keyword shall contain a floating point number specifying the suggested bin size when producing a histogram of the values in column n.
    TDMAXn
    Deprecated.
    Use Standard.TDMAXn instead.
    TDMINn
    Deprecated.
    Use Standard.TDMINn instead.
    TITLE
    The value field shall contain a character string giving a title that is suitable for display purposes, e.g., for annotation on images or plots of the data contained in the HDU.
    TLMAXn
    Deprecated.
    Use Standard.TLMAXn instead.
    TLMINn
    Deprecated.
    Use Standard.TLMINn instead.
    TSORTKEY
    The value field shall contain a character string that defines the order in which the rows in the current FITS ASCII or binary table extension have been sorted.

  • Field Summary

    Fields inherited from interface nom.tam.fits.header.IFitsHeader

    MAX_INDEX

  • 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 DataDescription
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static DataDescription[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface nom.tam.fits.header.IFitsHeader

    comment, extractIndices, hdu, key, n, status, valueType

  • Enum Constant Details

    • CONFIGUR

      public static final DataDescription CONFIGUR
      The value field shall contain a character string that uniquely defines the configuration state, or version, of the the software processing system that generated the data contained in the HDU. This keyword differs from the CREATOR keyword in that it give the name and version of the overall processing system and not just the name and version of a single program.

    • CREATOR

      public static final DataDescription CREATOR
      The value field shall contain a character string giving the name, and optionally, the version of the program that originally created the current FITS HDU. This keyword is synonymous with the PROGRAM keyword. Example: 'TASKNAME V1.2.3'

    • FILENAME

      public static final DataDescription FILENAME
      The value field shall contain a character string giving the the host file name used to record the original data.

    • FILETYPE

      public static final DataDescription FILETYPE
      The value field shall contain a character string giving the file type suffix of the host file name. The full file name typically consists of the root name (see ROOTNAME) followed by a file type suffix, separated by the period ('.') character.

    • HDUCLASn

      public static final DataDescription HDUCLASn
      The value fields of this hierarchical set of indexed keywords shall contain character strings that classify the type of data contained in the HDU. The HDUCLAS1 keyword gives the highest, most general data classification, and the HDUCLAS2 and higher keywords provide progressively more detailed subclassifications of the data.

    • HDUCLASS

      public static final DataDescription HDUCLASS
      The value field shall contain a character string that identifies the domain to which the associated HDUCLASn keywords apply. This keyword typically identifies the institution or project that has defined the allowed set of values for the associated hierarchical HDUCLASn keywords.

    • HDUDOC

      public static final DataDescription HDUDOC
      The value field shall contain a character string that gives a reference to a document that describes the allowed values that may be assigned to the HDUCLASn data classification keywords.

    • HDULEVEL

      public static final DataDescription HDULEVEL
      This keyword is synonymous to the standard EXTLEVEL. It is recommended that the HDULEVEL and EXTLEVEL keywords should not both be given in the same HDU key, but if they are, then the HDULEVEL keyword will have precedence.

    • HDUNAME

      public static final DataDescription HDUNAME
      This keyword is synonymous to the standard EXTNAME keyword except. It is recommended that the HDUNAME and EXTNAME keywords should not both be given in the same HDU key, but if they are, then the HDUNAME keyword will have precedence.

    • HDUVER

      public static final DataDescription HDUVER
      This keyword is synonymous to the standard EXTVER keyword. It is recommended that the HDUVER and EXTVER keywords should not both be given in the same HDU key, but if they are, then the HDUVER keyword will have precedence.

    • HDUVERS

      public static final DataDescription HDUVERS
      The value field shall contain a character string that gives the specific version of the document referenced by HDUDOC.

    • NEXTEND

      public static final DataDescription NEXTEND
      The value field shall contain an integer giving the number of standard extensions contained in the FITS file. This keyword may only be used in the primary array key.

    • PROGRAM

      public static final DataDescription PROGRAM
      The value field shall contain a character string giving the name, and optionally, the version of the program that originally created the current FITS HDU. This keyword is synonymous with the CREATOR keyword. Example: 'TASKNAME V1.2.3'

    • ROOTNAME

      public static final DataDescription ROOTNAME
      The value field shall contain a character string giving the root of the host file name. The full file name typically consists of the root name followed by a file type suffix (see FILETYPE), separated by the period ('.') character.

    • TDBINn

      public static final DataDescription TDBINn
      The value field of this indexed keyword shall contain a floating point number specifying the suggested bin size when producing a histogram of the values in column n. This keyword is typically used in conjunction the TLMINn and TLMAXn keywords when constructing a histogram of the values in column n, such that the histogram ranges from TLMINn to TLMAXn with the histogram bin size given by TDBINn. This keyword may only be used in 'TABLE' or 'BINTABLE' extensions.

    • TDMAXn

      public static final DataDescription TDMAXn
      Deprecated.
      Use Standard.TDMAXn instead.
      The value field of this indexed keyword shall contain a floating point number specifying the maximum valid physical value represented in column n of the table, exclusive of any special values. This keyword may only be used in 'TABLE' or 'BINTABLE' extensions and is analogous to the DATAMAX keyword used for FITS images.

    • TDMINn

      public static final DataDescription TDMINn
      Deprecated.
      Use Standard.TDMINn instead.
      The value field of this indexed keyword shall contain a floating point number specifying the minimum valid physical value represented in column n of the table, exclusive of any special values. This keyword may only be used in 'TABLE' or 'BINTABLE' extensions and is analogous to the DATAMIN keyword used for FITS images.

    • TITLE

      public static final DataDescription TITLE
      The value field shall contain a character string giving a title that is suitable for display purposes, e.g., for annotation on images or plots of the data contained in the HDU.

    • TLMAXn

      public static final DataDescription TLMAXn
      Deprecated.
      Use Standard.TLMAXn instead.
      The value field of this indexed keyword shall contain a floating point number specifying the upper bound of the legal range of physical values that may be represented in column n of the table. The column may contain values that are greater than this legal maximum value but the interpretation of such values is not defined here. The value of this keyword is typically used as the maxinum value when constructing a histogram of the values in the column. This keyword may only be used in 'TABLE' or 'BINTABLE' extensions.

    • TLMINn

      public static final DataDescription TLMINn
      Deprecated.
      Use Standard.TLMINn instead.
      The value field of this indexed keyword shall contain a floating point number specifying the lower bound of the legal range of physical values that may be represented in column n of the table. The column may contain values that are less than this legal minimum value but the interpretation of such values is not defined here. The value of this keyword is typically used as the mininum value when constructing a histogram of the values in the column. This keyword may only be used in 'TABLE' or 'BINTABLE' extensions.

    • TSORTKEY

      public static final DataDescription TSORTKEY
      The value field shall contain a character string that defines the order in which the rows in the current FITS ASCII or binary table extension have been sorted. The character string lists the name (as given by the TTYPEn keyword) of the primary sort column, optionally followed by the names of any secondary sort column(s). The presence of this keyword indicates that the rows in the table have been sorted first by the values in the primary sort column; any rows that have the same value in the primary column have been further sorted by the values in the secondary sort column and so on for all the specified columns. If more than one column is specified by TSORTKEY then the names must be separated by a comma. One or more spaces are also allowed between the comma and the following column name. By default, columns are sorted in ascending order, but a minus sign may precede the column name to indicate that the rows are sorted in descending order. This keyword may only be used in 'TABLE' or 'BINTABLE' extensions. Example: TSORTKEY = 'TIME, RA, DEC'.

  • Method Details

    • values

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