Package nom.tam.fits.header

Enum NonStandard

java.lang.Object
java.lang.Enum<NonStandard>
nom.tam.fits.header.NonStandard
All Implemented Interfaces:
Serializable, Comparable<NonStandard>, java.lang.constant.Constable, IFitsHeader
public enum NonStandard extends Enum<NonStandard> 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 denote non-standard FITS keyword format conventions.

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

Author:
Richard van Nieuwenhoven

  • Enum Constant Details

    • CONTINUE

      @Deprecated public static final NonStandard CONTINUE
      Deprecated.
      The CONTINUE key is now part of the FITS 4.0 standard, so use Standard.CONTINUE instead.

    • HIERARCH

      public static final NonStandard HIERARCH
      The HIERARCH keyword, when followed by spaces in columns 9 and 10 of the FITS card image, indicates that the ESO HIERARCH keyword convention should be used to interpret the name and value of the keyword. The HIERARCH keyword formally has no value because it is not followed by an equals sign in column 9. Under the HIERARCH convention the actual name of the keyword begins in column 11 of the card image and is terminated by the equal sign ('=') character. The name can contain any number of characters as long as it fits within columns 11 and 80 of the card image and also leaves enough space for the equal sign separator and the value field. The name can contain any printable ASCII text character, including spaces and lower-case characters, except for the equal sign character which serves as the terminator of the name field. Leading and trailing spaces in the name field are not significant, but embedded spaces within the name are significant. The value field follows the equals sign and must conform to the syntax for a free-format value field as defined in the FITS Standard. The value field may be null, in which case it contains only space characters, otherwise it may contain either a character string enclosed in single quotes, the logical constant T or F, an integer number, a floating point number, a complex integer number, or a complex floating point number. The value field may be followed by an optional comment string. The comment field must be separated from the value field by a slash character ('/'). It is recommended that the slash character be preceeded and followed by a space character. Example: "HIERARCH Filter Wheel = 12 / filter position". In this example the logical name of the keyword is 'Filter Wheel' and the value is 12.

    • INHERIT

      public static final NonStandard INHERIT
      Deprecated.
      Part of the FITS standard, use Standard.INHERIT instead.
      The presence of this keyword with a value = T in an extension key indicates that the keywords contained in the primary key (except the FITS Mandatory keywords, and any COMMENT, HISTORY or 'blank' keywords) are to be inherited, or logically included in that extension key.

  • Field Details

    • XTENSION_IUEIMAGE

      public static final String XTENSION_IUEIMAGE
      An alternative older value of the XTENSION keword in case of an image.
      See Also:

    • XTENSION_A3DTABLE

      public static final String XTENSION_A3DTABLE
      an alternative olde value of the XTENSION keword in case of an earlier version of binary table.
      See Also:

  • Method Details

    • values

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