Enum Checksum

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Checksum>, IFitsHeader

    public enum Checksum
    extends java.lang.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.
    Author:
    Richard van Nieuwenhoven
    See Also:
    http://heasarc.gsfc.nasa.gov/docs/fcg/common_dict.html
    • 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.
    • Enum Constant Detail

      • 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 Detail

      • values

        public static Checksum[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (Checksum c : Checksum.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Checksum valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • comment

        public java.lang.String comment()
        Specified by:
        comment in interface IFitsHeader
      • key

        public java.lang.String key()
        Specified by:
        key in interface IFitsHeader