Enum Class Checksum

java.lang.Object
java.lang.Enum<Checksum>
nom.tam.fits.header.Checksum
All Implemented Interfaces:
Serializable, Comparable<Checksum>, 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 Also:
  • 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.
  • Field Details

  • Constructor Details

  • Method Details

    • values

      public static Checksum[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static Checksum valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • comment

      public String comment()
      Specified by:
      comment in interface IFitsHeader
    • hdu

      public IFitsHeader.HDU hdu()
      Specified by:
      hdu in interface IFitsHeader
    • key

      public String key()
      Specified by:
      key in interface IFitsHeader
    • n

      public IFitsHeader n(int... number)
      Specified by:
      n in interface IFitsHeader
    • status

      public IFitsHeader.SOURCE status()
      Specified by:
      status in interface IFitsHeader
    • valueType

      public IFitsHeader.VALUE valueType()
      Specified by:
      valueType in interface IFitsHeader