Header (Starlink-UK API)

java.lang.Object
- nom.tam.fits.Header

All Implemented Interfaces:

FitsElement
```
public class Header
extends Object
implements FitsElement
```
This class describes methods to access and manipulate the header for a FITS HDU. This class does not include code specific to particular types of HDU.

Constructor Summary

Constructors
Constructor and Description
`Header()` Create an empty header
`Header(ArrayDataInput is)` Create a header and populate it from the input stream
`Header(Data o)` Create a header which points to the given data object.
`Header(String[] newCards)` Create a header and initialize it with a vector of strings.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addLine(HeaderCard fcard)` Add a card image to the header.
`protected void`	`addLine(String card)` Add a card image to the header.
`void`	`addValue(String key, boolean val, String comment)` Add or replace a key with the given boolean value and comment.
`void`	`addValue(String key, double val, String comment)` Add or replace a key with the given double value and comment.
`void`	`addValue(String key, long val, String comment)` Add or replace a key with the given long value and comment.
`void`	`addValue(String key, String val, String comment)` Add or replace a key with the given string value and comment.
`boolean`	`containsKey(String key)` Tests if the specified keyword is present in this table.
`void`	`deleteKey(String key)` Delete the card associated with the given key.
`protected void`	`dumpHeader(PrintStream ps)` Print the header to a given stream.
`HeaderCard`	`findCard(String key)` Find the card associated with a given key.
`String`	`findKey(String key)` Find the card associated with a given key.
`boolean`	`getBooleanValue(String key)` Get the `boolean` value associated with the given key.
`boolean`	`getBooleanValue(String key, boolean dft)` Get the `boolean` value associated with the given key.
`String`	`getCard(int n)` Deprecated. An iterator should be used for sequential access to the header.
`long`	`getDataSize()` Return the size of the data including any needed padding.
`double`	`getDoubleValue(String key)` Get the `double` value associated with the given key.
`double`	`getDoubleValue(String key, double dft)` Get the `double` value associated with the given key.
`long`	`getFileOffset()` Get the offset of this header
`float`	`getFloatValue(String key)` Get the `float` value associated with the given key.
`float`	`getFloatValue(String key, float dft)` Get the `float` value associated with the given key.
`int`	`getIntValue(String key)` Get the `int` value associated with the given key.
`int`	`getIntValue(String key, int dft)` Get the value associated with the key as an int.
`String`	`getKey(int n)` Deprecated. An iterator should be used for sequential access to the header.
`long`	`getLongValue(String key)` Get the `long` value associated with the given key.
`long`	`getLongValue(String key, long dft)` Get the `long` value associated with the given key.
`int`	`getNumberOfCards()` Find the number of cards in the header
`long`	`getSize()` Get the size of the header in bytes
`String`	`getStringValue(String key)` Get the `String` value associated with the given key.
`void`	`insertComment(String value)` Add a COMMENT line.
`void`	`insertCommentStyle(String header, String value)` Add a line to the header using the COMMENT style, i.e., no '=' in column 9.
`void`	`insertHistory(String value)` Add a HISTORY line.
`Cursor`	`iterator()` Get an iterator over the header cards
`Data`	`makeData()` Create the data element corresponding to the current header
`void`	`pointToData(Data o)` Deprecated. Use the appropriate Header constructor.
`void`	`read(ArrayDataInput dis)` Read a stream for header data.
`static Header`	`readHeader(ArrayDataInput dis)` Create a header by reading the information from the input stream.
`void`	`removeCard(String key)` Add or replace a key using the preformatted value.
`void`	`rewrite()` Rewrite the header.
`boolean`	`rewriteable()` Can the header be rewritten without rewriting the entire file?
`void`	`setBitpix(int val)` Set the BITPIX value for the header.
`void`	`setHeaderSorter(Comparator<String> headerSorter)` Matches a method introduced in v1.15.2 of nom.tam.fits, so this method can be called harmlessly in that or this version.
`void`	`setNaxes(int val)` Set the value of the NAXIS keyword
`void`	`setNaxis(int axis, int dim)` Set the dimension for a given axis.
`void`	`setSimple(boolean val)` Set the SIMPLE keyword to the given value.
`void`	`setXtension(String val)` Set the XTENSION keyword to the given value.
`int`	`size()` Deprecated. see numberOfCards(). The units of the size of the header may be unclear.
`void`	`write(ArrayDataOutput dos)` Write the current header (including any needed padding) to the output stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Header
```
public Header()
```
    Create an empty header
  - Header
```
public Header(ArrayDataInput is)
       throws TruncatedFileException,
              IOException
```
    Create a header and populate it from the input stream
    
    Parameters:
    
    is - The input stream where header information is expected.
    
    Throws:
    
    TruncatedFileException
    
    IOException
  - Header
```
public Header(String[] newCards)
```
    Create a header and initialize it with a vector of strings.
    
    Parameters:
    
    cards - Card images to be placed in the header.
  - Header
```
public Header(Data o)
       throws FitsException
```
    Create a header which points to the given data object.
    
    Parameters:
    
    o - The data object to be described.
    
    Throws:
    
    FitsException - if the data was not valid for this header.
- Method Detail
  - makeData
```
public Data makeData()
              throws FitsException
```
    Create the data element corresponding to the current header
    
    Throws:
    
    FitsException
  - getNumberOfCards
```
public int getNumberOfCards()
```
    Find the number of cards in the header
  - iterator
```
public Cursor iterator()
```
    Get an iterator over the header cards
  - getFileOffset
```
public long getFileOffset()
```
    Get the offset of this header
    
    Specified by:
    
    getFileOffset in interface FitsElement
  - getDataSize
```
public long getDataSize()
```
    Return the size of the data including any needed padding.
    
    Returns:
    
    the data segment size including any needed padding.
  - getSize
```
public long getSize()
```
    Get the size of the header in bytes
    
    Specified by:
    
    getSize in interface FitsElement
  - findCard
```
public HeaderCard findCard(String key)
```
    Find the card associated with a given key. If found this sets the mark to the card, otherwise it unsets the mark.
    
    Parameters:
    
    key - The header key.
    
    Returns:
    
    null if the keyword could not be found; return the HeaderCard object otherwise.
  - getIntValue
```
public int getIntValue(String key,
                       int dft)
```
    Get the value associated with the key as an int.
    
    Parameters:
    
    key - The header key.
    
    dft - The value to be returned if the key is not found.
  - getIntValue
```
public int getIntValue(String key)
```
    Get the int value associated with the given key.
    
    Parameters:
    
    key - The header key.
    
    Returns:
    
    The associated value or 0 if not found.
  - getLongValue
```
public long getLongValue(String key)
```
    Get the long value associated with the given key.
    
    Parameters:
    
    key - The header key.
    
    Returns:
    
    The associated value or 0 if not found.
  - getLongValue
```
public long getLongValue(String key,
                         long dft)
```
    Get the long value associated with the given key.
    
    Parameters:
    
    key - The header key.
    
    dft - The default value to be returned if the key cannot be found.
    
    Returns:
    
    the associated value.
  - getFloatValue
```
public float getFloatValue(String key,
                           float dft)
```
    Get the float value associated with the given key.
    
    Parameters:
    
    key - The header key.
    
    dft - The value to be returned if the key is not found.
  - getFloatValue
```
public float getFloatValue(String key)
```
    Get the float value associated with the given key.
    
    Parameters:
    
    key - The header key.
    
    Returns:
    
    The associated value or 0.0 if not found.
  - getDoubleValue
```
public double getDoubleValue(String key)
```
    Get the double value associated with the given key.
    
    Parameters:
    
    key - The header key.
    
    Returns:
    
    The associated value or 0.0 if not found.
  - getDoubleValue
```
public double getDoubleValue(String key,
                             double dft)
```
    Get the double value associated with the given key.
    
    Parameters:
    
    key - The header key.
    
    dft - The default value to return if the key cannot be found.
    
    Returns:
    
    the associated value.
  - getBooleanValue
```
public boolean getBooleanValue(String key)
```
    Get the boolean value associated with the given key.
    
    Parameters:
    
    The - header key.
    
    Returns:
    
    The value found, or false if not found or if the keyword is not a logical keyword.
  - getBooleanValue
```
public boolean getBooleanValue(String key,
                               boolean dft)
```
    Get the boolean value associated with the given key.
    
    Parameters:
    
    key - The header key.
    
    dft - The value to be returned if the key cannot be found or if the parameter does not seem to be a boolean.
    
    Returns:
    
    the associated value.
  - getStringValue
```
public String getStringValue(String key)
```
    Get the String value associated with the given key.
    
    Parameters:
    
    key - The header key.
    
    Returns:
    
    The associated value or null if not found or if the value is not a string.
  - addLine
```
public void addLine(HeaderCard fcard)
```
    Add a card image to the header.
    
    Parameters:
    
    fcard - The card to be added.
  - addLine
```
protected void addLine(String card)
                throws HeaderCardException
```
    Add a card image to the header.
    
    Parameters:
    
    card - The card to be added.
    
    Throws:
    
    HeaderCardException - If the card is not valid.
  - readHeader
```
public static Header readHeader(ArrayDataInput dis)
                         throws TruncatedFileException,
                                IOException
```
    Create a header by reading the information from the input stream.
    
    Parameters:
    
    dis - The input stream to read the data from.
    
    Returns:
    
    null if there was a problem with the header; otherwise return the header read from the input stream.
    
    Throws:
    
    TruncatedFileException
    
    IOException
  - read
```
public void read(ArrayDataInput dis)
          throws TruncatedFileException,
                 IOException
```
    Read a stream for header data.
    
    Specified by:
    
    read in interface FitsElement
    
    Parameters:
    
    dis - The input stream to read the data from.
    
    Throws:
    
    TruncatedFileException
    
    IOException
  - findKey
```
public String findKey(String key)
```
    Find the card associated with a given key.
    
    Parameters:
    
    key - The header key.
    
    Returns:
    
    null if the keyword could not be found; return the card image otherwise.
  - write
```
public void write(ArrayDataOutput dos)
           throws FitsException
```
    Write the current header (including any needed padding) to the output stream.
    
    Specified by:
    
    write in interface FitsElement
    
    Parameters:
    
    dos - The output stream to which the data is to be written.
    
    Throws:
    
    FitsException - if the header could not be written.
  - rewrite
```
public void rewrite()
             throws FitsException,
                    IOException
```
    Rewrite the header.
    
    Specified by:
    
    rewrite in interface FitsElement
    
    Throws:
    
    FitsException
    
    IOException
  - rewriteable
```
public boolean rewriteable()
```
    Can the header be rewritten without rewriting the entire file?
    
    Specified by:
    
    rewriteable in interface FitsElement
  - addValue
```
public void addValue(String key,
                     boolean val,
                     String comment)
              throws HeaderCardException
```
    Add or replace a key with the given boolean value and comment.
    
    Parameters:
    
    key - The header key.
    
    val - The boolean value.
    
    comment - A comment to append to the card.
    
    Throws:
    
    HeaderCardException - If the parameters cannot build a valid FITS card.
  - addValue
```
public void addValue(String key,
                     double val,
                     String comment)
              throws HeaderCardException
```
    Add or replace a key with the given double value and comment. Note that float values will be promoted to doubles.
    
    Parameters:
    
    key - The header key.
    
    val - The double value.
    
    comment - A comment to append to the card.
    
    Throws:
    
    HeaderCardException - If the parameters cannot build a valid FITS card.
  - addValue
```
public void addValue(String key,
                     String val,
                     String comment)
              throws HeaderCardException
```
    Add or replace a key with the given string value and comment.
    
    Parameters:
    
    key - The header key.
    
    val - The string value.
    
    comment - A comment to append to the card.
    
    Throws:
    
    HeaderCardException - If the parameters cannot build a valid FITS card.
  - addValue
```
public void addValue(String key,
                     long val,
                     String comment)
              throws HeaderCardException
```
    Add or replace a key with the given long value and comment. Note that int's will be promoted to long's.
    
    Parameters:
    
    key - The header key.
    
    val - The long value.
    
    comment - A comment to append to the card.
    
    Throws:
    
    HeaderCardException - If the parameters cannot build a valid FITS card.
  - removeCard
```
public void removeCard(String key)
                throws HeaderCardException
```
    Add or replace a key using the preformatted value. If the key is not found, then add the card at the current default location.
    
    Parameters:
    
    key - The header key.
    
    val - The string which will follow the "= " on the card. This routine is called by the various addXXXValue routines after they have formatted the value as a string.
    
    comment - A comment to append to the card.
    
    Throws:
    
    HeaderCardException - If the parameters cannot build a valid FITS card.
  - insertCommentStyle
```
public void insertCommentStyle(String header,
                               String value)
```
    Add a line to the header using the COMMENT style, i.e., no '=' in column 9.
    
    Parameters:
    
    header - The comment style header.
    
    value - A string to follow the header.
    
    Throws:
    
    HeaderCardException - If the parameters cannot build a valid FITS card.
  - insertComment
```
public void insertComment(String value)
                   throws HeaderCardException
```
    Add a COMMENT line.
    
    Parameters:
    
    value - The comment.
    
    Throws:
    
    HeaderCardException - If the parameter is not a valid FITS comment.
  - insertHistory
```
public void insertHistory(String value)
                   throws HeaderCardException
```
    Add a HISTORY line.
    
    Parameters:
    
    value - The history record.
    
    Throws:
    
    HeaderCardException - If the parameter is not a valid FITS comment.
  - deleteKey
```
public void deleteKey(String key)
```
    Delete the card associated with the given key. Nothing occurs if the key is not found.
    
    Parameters:
    
    key - The header key.
  - containsKey
```
public final boolean containsKey(String key)
```
    Tests if the specified keyword is present in this table.
    
    Parameters:
    
    key - the keyword to be found.
    
    Returns:
    
    true if the specified keyword is present in this table; false otherwise.
  setSimple public void setSimple(boolean val) Set the SIMPLE keyword to the given value. Parameters: val - The boolean value -- Should be true for FITS data. setXtension public void setXtension(String val) Set the XTENSION keyword to the given value. Parameters: val - The name of the extension. "IMAGE" and "BINTABLE" are supported. setBitpix public void setBitpix(int val) Set the BITPIX value for the header. Parameters: val. - The following values are permitted by FITS conventions: 8 -- signed bytes data. Also used for tables. 16 -- signed short data. 32 -- signed int data. -32 -- IEEE 32 bit floating point numbers. -64 -- IEEE 64 bit floating point numbers. These Fits classes also support BITPIX=64 in which case data is signed 64 bit long data. setNaxes public void setNaxes(int val) Set the value of the NAXIS keyword Parameters: val - The dimensionality of the data. setNaxis public void setNaxis(int axis, int dim) Set the dimension for a given axis. Parameters: axis - The axis being set. dim - The dimension dumpHeader protected void dumpHeader(PrintStream ps) Print the header to a given stream. Parameters: ps - the stream to which the card images are dumped. size public int size() Deprecated. see numberOfCards(). The units of the size of the header may be unclear. Find the number of cards in the header getCard public String getCard(int n) Deprecated. An iterator should be used for sequential access to the header. Get the n'th card image in the header Returns: the card image; return null if the n'th card does not exist. getKey public String getKey(int n) Deprecated. An iterator should be used for sequential access to the header. Get the n'th key in the header. Returns: the card image; return null if the n'th key does not exist. pointToData public void pointToData(Data o) throws FitsException Deprecated. Use the appropriate Header constructor. Create a header which points to the given data object. Parameters: o - The data object to be described. Throws: FitsException - if the data was not valid for this header. setHeaderSorter public void setHeaderSorter(Comparator<String> headerSorter) Matches a method introduced in v1.15.2 of nom.tam.fits, so this method can be called harmlessly in that or this version. This implementation may only be called with a null argument, in which case it's a no-op. Parameters: headerSorter - must be null Throws: IllegalArgumentException - for non-null headerSorter

Class Header

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Header

Header

Header

Header

Method Detail

makeData

getNumberOfCards

iterator

getFileOffset

getDataSize

getSize

findCard

getIntValue

getIntValue

getLongValue

getLongValue

getFloatValue

getFloatValue

getDoubleValue

getDoubleValue

getBooleanValue

getBooleanValue

getStringValue

addLine

addLine

readHeader

read

findKey

write

rewrite

rewriteable

addValue

addValue

addValue

addValue

removeCard

insertCommentStyle

insertComment

insertHistory

deleteKey

containsKey

setSimple

setXtension

setBitpix

setNaxes

setNaxis

dumpHeader

size

getCard

getKey

pointToData

setHeaderSorter