Package nom.tam.fits

Class HeaderCard

java.lang.Object
nom.tam.fits.HeaderCard
All Implemented Interfaces:
CursorValue<String>

public class HeaderCard extends Object implements CursorValue<String>
This class describes methods to access and manipulate the individual cards for a FITS Header.
  • Field Details

    • SPACE_NEEDED_FOR_EQUAL_AND_TWO_BLANKS

      private static final int SPACE_NEEDED_FOR_EQUAL_AND_TWO_BLANKS
      See Also:
    • MAX_DECIMAL_VALUE_TO_USE_PLAIN_STRING

      private static final double MAX_DECIMAL_VALUE_TO_USE_PLAIN_STRING
      See Also:
    • LOG

      private static final Logger LOG
    • CONTINUE_CARD_PREFIX

      private static final String CONTINUE_CARD_PREFIX
    • FITS_HEADER_CARD_SIZE

      public static final int FITS_HEADER_CARD_SIZE
      See Also:
    • HIERARCH_WITH_BLANK

      private static final String HIERARCH_WITH_BLANK
    • HIERARCH_WITH_BLANK_LENGTH

      private static final int HIERARCH_WITH_BLANK_LENGTH
    • HIERARCH_WITH_DOT

      private static final String HIERARCH_WITH_DOT
    • IEEE_REGEX

      private static final Pattern IEEE_REGEX
      regexp for IEEE floats
    • LONG_MAX_VALUE_AS_BIG_DECIMAL

      private static final BigDecimal LONG_MAX_VALUE_AS_BIG_DECIMAL
    • LONG_REGEX

      private static final Pattern LONG_REGEX
      regexp for numbers.
    • MAX_INTEGER_STRING_SIZE

      private static final int MAX_INTEGER_STRING_SIZE
      max number of characters an integer can have.
    • MAX_KEYWORD_LENGTH

      public static final int MAX_KEYWORD_LENGTH
      Maximum length of a FITS keyword field
      See Also:
    • MAX_LONG_STRING_CONTINUE_OVERHEAD

      public static final int MAX_LONG_STRING_CONTINUE_OVERHEAD
      the start and end quotes of the string and the ampasant to continue the string.
      See Also:
    • MAX_LONG_STRING_SIZE

      private static final int MAX_LONG_STRING_SIZE
      max number of characters a long can have.
    • MAX_LONG_STRING_VALUE_LENGTH

      public static final int MAX_LONG_STRING_VALUE_LENGTH
      Maximum length of a FITS long string value field. the & for the continuation needs one char.
      See Also:
    • MAX_LONG_STRING_VALUE_WITH_COMMENT_LENGTH

      public static final int MAX_LONG_STRING_VALUE_WITH_COMMENT_LENGTH
      if a commend needs the be specified 2 extra chars are needed to start the comment
      See Also:
    • MAX_STRING_VALUE_LENGTH

      public static final int MAX_STRING_VALUE_LENGTH
      Maximum length of a FITS string value field.
      See Also:
    • MAX_VALUE_LENGTH

      public static final int MAX_VALUE_LENGTH
      Maximum length of a FITS value field.
      See Also:
    • NORMAL_ALIGN_POSITION

      private static final int NORMAL_ALIGN_POSITION
      See Also:
    • NORMAL_SMALL_STRING_ALIGN_POSITION

      private static final int NORMAL_SMALL_STRING_ALIGN_POSITION
      See Also:
    • STRING_SPLIT_POSITION_FOR_EXTRA_COMMENT_SPACE

      private static final int STRING_SPLIT_POSITION_FOR_EXTRA_COMMENT_SPACE
      See Also:
    • comment

      private String comment
      The comment part of the card (set to null if there's no comment)
    • isString

      private boolean isString
      A flag indicating whether or not this is a string value
    • key

      private String key
      The keyword part of the card (set to null if there's no keyword)
    • nullable

      private boolean nullable
      Does this card represent a nullable field. ?
    • value

      private String value
      The value part of the card (set to null if there's no value)
  • Constructor Details

    • HeaderCard

      public HeaderCard(ArrayDataInput dis) throws TruncatedFileException, IOException
      Throws:
      TruncatedFileException
      IOException
    • HeaderCard

      Throws:
      TruncatedFileException
      IOException
    • HeaderCard

      public HeaderCard(String key, BigDecimal value, String comment) throws HeaderCardException
      Create a HeaderCard from its component parts
      Parameters:
      key - keyword (null for a comment)
      value - value (null for a comment or keyword without an '=')
      comment - comment
      Throws:
      HeaderCardException - for any invalid keyword
    • HeaderCard

      public HeaderCard(String key, BigInteger value, String comment) throws HeaderCardException
      Create a HeaderCard from its component parts
      Parameters:
      key - keyword (null for a comment)
      value - value (null for a comment or keyword without an '=')
      comment - comment
      Throws:
      HeaderCardException - for any invalid keyword
    • HeaderCard

      public HeaderCard(String key, boolean value, String comment) throws HeaderCardException
      Create a HeaderCard from its component parts
      Parameters:
      key - keyword (null for a comment)
      value - value (null for a comment or keyword without an '=')
      comment - comment
      Throws:
      HeaderCardException - for any invalid keyword
    • HeaderCard

      public HeaderCard(String key, double value, int precision, String comment) throws HeaderCardException
      Create a HeaderCard from its component parts
      Parameters:
      key - keyword (null for a comment)
      value - value (null for a comment or keyword without an '=')
      precision - Number of decimal places (fixed format).
      comment - comment
      Throws:
      HeaderCardException - for any invalid keyword
    • HeaderCard

      public HeaderCard(String key, double value, String comment) throws HeaderCardException
      Create a HeaderCard from its component parts
      Parameters:
      key - keyword (null for a comment)
      value - value (null for a comment or keyword without an '=')
      comment - comment
      Throws:
      HeaderCardException - for any invalid keyword
    • HeaderCard

      public HeaderCard(String key, float value, int precision, String comment) throws HeaderCardException
      Create a HeaderCard from its component parts
      Parameters:
      key - keyword (null for a comment)
      value - value (null for a comment or keyword without an '=')
      precision - Number of decimal places (fixed format).
      comment - comment
      Throws:
      HeaderCardException - for any invalid keyword
    • HeaderCard

      public HeaderCard(String key, float value, String comment) throws HeaderCardException
      Create a HeaderCard from its component parts
      Parameters:
      key - keyword (null for a comment)
      value - value (null for a comment or keyword without an '=')
      comment - comment
      Throws:
      HeaderCardException - for any invalid keyword
    • HeaderCard

      public HeaderCard(String key, int value, String comment) throws HeaderCardException
      Create a HeaderCard from its component parts
      Parameters:
      key - keyword (null for a comment)
      value - value (null for a comment or keyword without an '=')
      comment - comment
      Throws:
      HeaderCardException - for any invalid keyword
    • HeaderCard

      public HeaderCard(String key, long value, String comment) throws HeaderCardException
      Create a HeaderCard from its component parts
      Parameters:
      key - keyword (null for a comment)
      value - value (null for a comment or keyword without an '=')
      comment - comment
      Throws:
      HeaderCardException - for any invalid keyword
    • HeaderCard

      public HeaderCard(String key, String comment, boolean nullable) throws HeaderCardException
      Create a comment style card. This constructor builds a card which has no value. This may be either a comment style card in which case the nullable field should be false, or a value field which has a null value, in which case the nullable field should be true.
      Parameters:
      key - The key for the comment or nullable field.
      comment - The comment
      nullable - Is this a nullable field or a comment-style card?
      Throws:
      HeaderCardException - for any invalid keyword or value
    • HeaderCard

      public HeaderCard(String key, String value, String comment) throws HeaderCardException
      Create a HeaderCard from its component parts
      Parameters:
      key - keyword (null for a comment)
      value - value (null for a comment or keyword without an '=')
      comment - comment
      Throws:
      HeaderCardException - for any invalid keyword or value
    • HeaderCard

      public HeaderCard(String key, String value, String comment, boolean nullable) throws HeaderCardException
      Create a HeaderCard from its component parts
      Parameters:
      key - Keyword (null for a COMMENT)
      value - Value
      comment - Comment
      nullable - Is this a nullable value card?
      Throws:
      HeaderCardException - for any invalid keyword or value
    • HeaderCard

      private HeaderCard(String key, String value, String comment, boolean nullable, boolean isString) throws HeaderCardException
      Create a HeaderCard from its component parts
      Parameters:
      key - Keyword (null for a COMMENT)
      value - Value
      comment - Comment
      nullable - Is this a nullable value card?
      Throws:
      HeaderCardException - for any invalid keyword or value
  • Method Details

    • create

      public static HeaderCard create(String card)
      Parameters:
      card - the 80 character card image
      Returns:
      a created HeaderCard from a FITS card string.
    • dblString

      private static String dblString(BigDecimal decimalValue, int availableSpace)
      Create a string from a BigDecimal making sure that it's not longer than the available space.
      Parameters:
      decimalValue - the decimal value to print
      availableSpace - the space available for the value
      Returns:
      the string representing the value.
    • dblString

      private static String dblString(BigDecimal decimalValue, int precision, int availableSpace)
      Create a string from a BigDecimal making sure that it's not longer than the available space.
      Parameters:
      decimalValue - the decimal value to print
      precision - the precision to use
      availableSpace - the space available for the value
      Returns:
      the string representing the value.
    • dblString

      private static String dblString(double decimalValue, int availableSpace)
      Create a string from a BigDecimal making sure that it's not longer than the available space.
      Parameters:
      decimalValue - the decimal value to print
      availableSpace - the space available for the value
      Returns:
      the string representing the value.
    • dblString

      private static String dblString(double input, int precision, int availableSpace)
      Parameters:
      input - float value being converted
      precision - the number of decimal places to show
      Returns:
      Create a fixed decimal string from a double with the specified precision.
    • floatToBigDecimal

      private static BigDecimal floatToBigDecimal(float floatValue)
      attention float to double cases are very lossy so a toString is needed to keep the precision. proof (double)500.055f = 500.05499267578125d
      Parameters:
      floatValue - the float value
      Returns:
      the BigDecimal as close to the value of the float as possible
    • getDecimalNumberType

      private static Class<?> getDecimalNumberType(String value)
      detect the decimal type of the value, does it fit in a Double/BigInteger or must it be a BigDecimal to keep the needed precission.
      Parameters:
      value - the String value to check.
      Returns:
      the type to fit the value
    • getIntegerNumberType

      private static Class<?> getIntegerNumberType(String value)
    • readOneHeaderLine

      private static String readOneHeaderLine(HeaderCardCountingArrayDataInput dis) throws IOException, TruncatedFileException
      Read exactly one complete fits header line from the input.
      Parameters:
      dis - the data input stream to read the line
      Returns:
      a string of exactly 80 characters
      Throws:
      IOException - if the input stream could not be read
      TruncatedFileException - is there was not a complete line available in the input.
    • spaceAvailableForValue

      private static int spaceAvailableForValue(String key)
    • stringToArrayInputStream

      private static ArrayDataInput stringToArrayInputStream(String card)
    • saveNewHeaderCard

      protected static HeaderCard saveNewHeaderCard(String key, String comment, boolean isString)
      This method is only used internally when it is sure that the creation of the card is granted not to throw an exception
      Parameters:
      key - the key for the card
      comment - the comment for the card
      isString - is this a string value card?
      Returns:
      the new HeaderCard
    • cardSize

      public int cardSize()
      Returns:
      the size of the card in blocks of 80 bytes. So normally every card will return 1. only long stings can return more than one.
    • copy

      public HeaderCard copy() throws HeaderCardException
      Throws:
      HeaderCardException
    • getComment

      public String getComment()
      Returns:
      the comment from this card
    • getKey

      public String getKey()
      Specified by:
      getKey in interface CursorValue<String>
      Returns:
      the keyword from this card
    • getValue

      public String getValue()
      Returns:
      the value from this card
    • getValue

      public <T> T getValue(Class<T> clazz, T defaultValue)
      Type Parameters:
      T - the type of the requested class
      Parameters:
      clazz - the requested class of the value
      defaultValue - the value if the card was not present.
      Returns:
      the value from this card as a specific type
    • isKeyValuePair

      public boolean isKeyValuePair()
      Returns:
      Is this a key/value card?
    • isStringValue

      public boolean isStringValue()
      Returns:
      if this card contain does a string value?
    • setComment

      public void setComment(String comment)
      set the comment of a card.
      Parameters:
      comment - the comment to set.
    • setValue

      public HeaderCard setValue(BigDecimal update)
      Set the value for this card.
      Parameters:
      update - the new value to set
      Returns:
      the HeaderCard itself
    • setValue

      public HeaderCard setValue(boolean update)
      Set the value for this card.
      Parameters:
      update - the new value to set
      Returns:
      the HeaderCard itself
    • setValue

      public HeaderCard setValue(double update)
      Set the value for this card.
      Parameters:
      update - the new value to set
      Returns:
      the HeaderCard itself
    • setValue

      public HeaderCard setValue(double update, int precision)
      Set the value for this card.
      Parameters:
      update - the new value to set
      precision - the number of decimal places to show
      Returns:
      the HeaderCard itself
    • setValue

      public HeaderCard setValue(float update)
      Set the value for this card.
      Parameters:
      update - the new value to set
      Returns:
      the HeaderCard itself
    • setValue

      public HeaderCard setValue(float update, int precision)
      Set the value for this card.
      Parameters:
      update - the new value to set
      precision - the number of decimal places to show
      Returns:
      the HeaderCard itself
    • setValue

      public HeaderCard setValue(int update)
      Set the value for this card.
      Parameters:
      update - the new value to set
      Returns:
      the HeaderCard itself
    • setValue

      public HeaderCard setValue(long update)
      Set the value for this card.
      Parameters:
      update - the new value to set
      Returns:
      the HeaderCard itself
    • setValue

      public HeaderCard setValue(String update)
      Set the value for this card.
      Parameters:
      update - the new value to set
      Returns:
      the HeaderCard itself
    • toString

      public String toString()
      Return the modulo 80 character card image, the toString tries to preserve as much as possible of the comment value by reducing the alignment of the Strings if the comment is longer and if longString is enabled the string can be split into one more card to have more space for the comment.
      Overrides:
      toString in class Object
    • toString

      protected String toString(FitsFactory.FitsSettings settings)
      Same as toString() just with a prefetched settings object
      Parameters:
      settings - the settings to use for writing the header card
      Returns:
      the string representing the card.
    • valueType

      public Class<?> valueType()
      Returns:
      the type of the value.
    • extractValueCommentFromString

      private void extractValueCommentFromString(HeaderCardCountingArrayDataInput dis, String card) throws IOException, TruncatedFileException
      Throws:
      IOException
      TruncatedFileException
    • getBooleanValue

      private Boolean getBooleanValue(Boolean defaultValue)
    • hierarchCard

      private void hierarchCard(String card, HeaderCardCountingArrayDataInput dis) throws IOException, TruncatedFileException
      Process HIERARCH style cards... HIERARCH LEV1 LEV2 ... = value / comment The keyword for the card will be "HIERARCH.LEV1.LEV2..." A '/' is assumed to start a comment.
      Parameters:
      dis -
      Throws:
      IOException
      TruncatedFileException
    • longStringCard

      Throws:
      IOException
      TruncatedFileException
    • maxStringValueLength

      private int maxStringValueLength()
    • stringValueToString

      private boolean stringValueToString(int alignSmallString, int alignPosition, FitsLineAppender buf, boolean commentHandled)
    • writeLongStringValue

      private void writeLongStringValue(FitsLineAppender buf, String stringValueString)
    • setKey

      void setKey(String newKey)
      Set the key.