Enum Checksum

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

File checksum keywords. 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.

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

Author:
Richard van Nieuwenhoven

  • 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
    CHECKSUM
    The value field of the CHECKSUM keyword shall contain a 16 character string, left justified starting in column 12, containing the ASCII encoded complement of the checksum of the FITS HDU (Header and Data Unit).
    CHECKVER
    The value field of the CHECKVER keyword shall contain a string, unique in the first 8 characters, which distinguishes between any future alternative checksum algorithms which may be defined.
    DATASUM
    The value field of the DATASUM keyword shall be a character string containing the unsigned integer value of the checksum of the data records of the HDU.

  • 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
    FitsKey
    impl()
    (primarily for internal use) Returns the concrete implementation of this header entry, which provides implementation of access methods.
    static Checksum
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static Checksum[]
    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

    • CHECKSUM

      public static final Checksum CHECKSUM
      The value field of the CHECKSUM keyword shall contain a 16 character string, left justified starting in column 12, containing the ASCII encoded complement of the checksum of the FITS HDU (Header and Data Unit). The algorithm shall be the 32-bit 1's complement checksum and the ASCII encoding that are described in the checksum proposal. The checksum is accumulated in FITS datastream order on the same HDU, identical in all respects, except that the value of the CHECKSUM keyword shall be set to the string '0000000000000000' (ASCII 0's, hex 30) before the checksum is computed.

    • CHECKVER

      public static final Checksum CHECKVER
      The value field of the CHECKVER keyword shall contain a string, unique in the first 8 characters, which distinguishes between any future alternative checksum algorithms which may be defined. The default value for a missing keyword shall be 'COMPLEMENT' which will represent the algorithm defined in the current proposal. It is recommended that this keyword be omitted from headers which implement the default ASCII encoded 32-bit 1's complement algorithm.

    • DATASUM

      public static final Checksum DATASUM
      The value field of the DATASUM keyword shall be a character string containing the unsigned integer value of the checksum of the data records of the HDU. For dataless HDU's, this keyword may either be omitted, or the value field shall contain the string value '0', which is preferred. A missing DATASUM keyword asserts no knowledge of the checksum of the data records.

  • Method Details

    • values

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