BasicHDU (Starlink-UK API)

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

All Implemented Interfaces:

FitsElement

Direct Known Subclasses:

ImageHDU, RandomGroupsHDU, TableHDU, UndefinedHDU
```
public abstract class BasicHDU
extends Object
implements FitsElement
```
This abstract class is the parent of all HDU types. It provides basic functionality for an HDU.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BITPIX_BYTE`
`static int`	`BITPIX_DOUBLE`
`static int`	`BITPIX_FLOAT`
`static int`	`BITPIX_INT`
`static int`	`BITPIX_LONG`
`static int`	`BITPIX_SHORT`
`protected boolean`	`isPrimary` Is this the first HDU in a FITS file?
`protected Data`	`myData` The associated data unit.
`protected Header`	`myHeader` The associated header.

Constructor Summary

Constructors
Constructor and Description

BasicHDU()

Constructors
Constructor and Description
`BasicHDU()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addValue(String key, boolean val, String comment)` Add information to the header
`void`	`addValue(String key, double val, String comment)`
`void`	`addValue(String key, int val, String comment)`
`void`	`addValue(String key, String val, String comment)`
`String`	`getAuthor()` Return the name of the person who compiled the information in the data associated with this header.
`int[]`	`getAxes()`
`int`	`getBitPix()`
`int`	`getBlankValue()`
`double`	`getBScale()`
`String`	`getBUnit()`
`double`	`getBZero()`
`Date`	`getCreationDate()` Get the FITS file creation date as a `Date` object.
`Data`	`getData()` Get the associated Data object
`static BasicHDU`	`getDummyHDU()`
`double`	`getEpoch()` Deprecated. Replaced by getEquinox
`double`	`getEquinox()` Get the equinox in years for the celestial coordinate system in which positions given in either the header or data are expressed.
`long`	`getFileOffset()` Get the starting offset of the HDU
`int`	`getGroupCount()`
`Header`	`getHeader()` Get the associated header
`String`	`getInstrument()` Get the name of the instrument which was used to acquire the data in this FITS file.
`Object`	`getKernel()` Get the non-FITS data object
`double`	`getMaximumValue()` Return the minimum valid value in the array.
`double`	`getMinimumValue()` Return the minimum valid value in the array.
`String`	`getObject()` Get the name of the observed object in this FITS file.
`Date`	`getObservationDate()` Get the FITS file observation date as a `Date` object.
`String`	`getObserver()` Get the name of the person who acquired the data in this FITS file.
`String`	`getOrigin()` Get the name of the organization which created this FITS file.
`int`	`getParameterCount()`
`String`	`getReference()` Return the citation of a reference where the data associated with this header are published.
`long`	`getSize()` Get the total size in bytes of the HDU.
`String`	`getTelescope()` Get the name of the telescope which was used to acquire the data in this FITS file.
`String`	`getTrimmedString(String keyword)` Get the String value associated with `keyword`.
`abstract void`	`info()` Print out some information about this HDU.
`static boolean`	`isHeader(Header header)` Check that this is a valid header for the HDU.
`void`	`read(ArrayDataInput stream)` Read the contents of the element from an input source.
`void`	`readData(ArrayDataInput stream)` Read in the Data object for this HDU.
`void`	`rewrite()` Rewrite the HDU
`boolean`	`rewriteable()` Is the HDU rewriteable
`void`	`skipData(ArrayDataInput stream)` Skip the Data object for this HDU.
`static void`	`skipData(ArrayDataInput stream, Header hdr)` Skip the Data object immediately after the given Header object on the given stream object.
`void`	`write(ArrayDataOutput stream)` Write the contents of the element to a data sink.

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

- Field Detail
  - BITPIX_BYTE
```
public static final int BITPIX_BYTE
```
    See Also:
    
    Constant Field Values
  - BITPIX_SHORT
```
public static final int BITPIX_SHORT
```
    See Also:
    
    Constant Field Values
  - BITPIX_INT
```
public static final int BITPIX_INT
```
    See Also:
    
    Constant Field Values
  - BITPIX_LONG
```
public static final int BITPIX_LONG
```
    See Also:
    
    Constant Field Values
  - BITPIX_FLOAT
```
public static final int BITPIX_FLOAT
```
    See Also:
    
    Constant Field Values
  - BITPIX_DOUBLE
```
public static final int BITPIX_DOUBLE
```
    See Also:
    
    Constant Field Values
  - myHeader
```
protected Header myHeader
```
    The associated header.
  - myData
```
protected Data myData
```
    The associated data unit.
  - isPrimary
```
protected boolean isPrimary
```
    Is this the first HDU in a FITS file?
- Constructor Detail
  - BasicHDU
```
public BasicHDU()
```
- Method Detail
  - skipData
```
public static void skipData(ArrayDataInput stream,
                            Header hdr)
                     throws IOException
```
    Skip the Data object immediately after the given Header object on the given stream object.
    
    Parameters:
    
    stream - the stream which contains the data.
    
    Header - template indicating length of Data section
    
    Throws:
    
    IOException - if the Data object could not be skipped.
  - skipData
```
public void skipData(ArrayDataInput stream)
              throws IOException
```
    Skip the Data object for this HDU.
    
    Parameters:
    
    stream - the stream which contains the data.
    
    Throws:
    
    IOException - if the Data object could not be skipped.
  - readData
```
public void readData(ArrayDataInput stream)
              throws FitsException
```
    Read in the Data object for this HDU.
    
    Parameters:
    
    stream - the stream from which the data is read.
    
    Throws:
    
    FitsException - if the Data object could not be created from this HDU's Header
  - getHeader
```
public Header getHeader()
```
    Get the associated header
  - getFileOffset
```
public long getFileOffset()
```
    Get the starting offset of the HDU
    
    Specified by:
    
    getFileOffset in interface FitsElement
  - getData
```
public Data getData()
```
    Get the associated Data object
  - getKernel
```
public Object getKernel()
```
    Get the non-FITS data object
  - getSize
```
public long getSize()
```
    Get the total size in bytes of the HDU.
    
    Specified by:
    
    getSize in interface FitsElement
    
    Returns:
    
    The size in bytes.
  - isHeader
```
public static boolean isHeader(Header header)
```
    Check that this is a valid header for the HDU.
    
    Parameters:
    
    header - to validate.
    
    Returns:
    
    true if this is a valid header.
  - info
```
public abstract void info()
```
    Print out some information about this HDU.
  - read
```
public void read(ArrayDataInput stream)
          throws FitsException,
                 IOException
```
    Description copied from interface: FitsElement
    
    Read the contents of the element from an input source.
    
    Specified by:
    
    read in interface FitsElement
    
    Parameters:
    
    stream - The input source.
    
    Throws:
    
    FitsException
    
    IOException
  - write
```
public void write(ArrayDataOutput stream)
           throws FitsException
```
    Description copied from interface: FitsElement
    
    Write the contents of the element to a data sink.
    
    Specified by:
    
    write in interface FitsElement
    
    Parameters:
    
    stream - The data sink.
    
    Throws:
    
    FitsException
  - rewriteable
```
public boolean rewriteable()
```
    Is the HDU rewriteable
    
    Specified by:
    
    rewriteable in interface FitsElement
  - rewrite
```
public void rewrite()
             throws FitsException,
                    IOException
```
    Rewrite the HDU
    
    Specified by:
    
    rewrite in interface FitsElement
    
    Throws:
    
    FitsException
    
    IOException
  - getTrimmedString
```
public String getTrimmedString(String keyword)
```
    Get the String value associated with keyword.
    
    Parameters:
    
    hdr - the header piece of an HDU
    
    keyword - the FITS keyword
    
    Returns:
    
    either null or a String with leading/trailing blanks stripped.
  - getBitPix
```
public int getBitPix()
              throws FitsException
```
    Throws:
    
    FitsException
  - getAxes
```
public int[] getAxes()
              throws FitsException
```
    Throws:
    
    FitsException
  - getParameterCount
```
public int getParameterCount()
```
  - getGroupCount
```
public int getGroupCount()
```
  - getBScale
```
public double getBScale()
```
  - getBZero
```
public double getBZero()
```
  - getBUnit
```
public String getBUnit()
```
  - getBlankValue
```
public int getBlankValue()
                  throws FitsException
```
    Throws:
    
    FitsException
  - getCreationDate
```
public Date getCreationDate()
```
    Get the FITS file creation date as a Date object.
    
    Returns:
    
    either null or a Date object
  - getObservationDate
```
public Date getObservationDate()
```
    Get the FITS file observation date as a Date object.
    
    Returns:
    
    either null or a Date object
  - getOrigin
```
public String getOrigin()
```
    Get the name of the organization which created this FITS file.
    
    Returns:
    
    either null or a String object
  - getTelescope
```
public String getTelescope()
```
    Get the name of the telescope which was used to acquire the data in this FITS file.
    
    Returns:
    
    either null or a String object
  - getInstrument
```
public String getInstrument()
```
    Get the name of the instrument which was used to acquire the data in this FITS file.
    
    Returns:
    
    either null or a String object
  - getObserver
```
public String getObserver()
```
    Get the name of the person who acquired the data in this FITS file.
    
    Returns:
    
    either null or a String object
  - getObject
```
public String getObject()
```
    Get the name of the observed object in this FITS file.
    
    Returns:
    
    either null or a String object
  - getEquinox
```
public double getEquinox()
```
    Get the equinox in years for the celestial coordinate system in which positions given in either the header or data are expressed.
    
    Returns:
    
    either null or a String object
  - getEpoch
```
public double getEpoch()
```
    Deprecated. Replaced by getEquinox
    
    Get the equinox in years for the celestial coordinate system in which positions given in either the header or data are expressed.
    
    Returns:
    
    either null or a String object
    
    See Also:
    
    getEquinox()
  - getAuthor
```
public String getAuthor()
```
    Return the name of the person who compiled the information in the data associated with this header.
    
    Returns:
    
    either null or a String object
  - getReference
```
public String getReference()
```
    Return the citation of a reference where the data associated with this header are published.
    
    Returns:
    
    either null or a String object
  - getMaximumValue
```
public double getMaximumValue()
```
    Return the minimum valid value in the array.
    
    Returns:
    
    minimum value.
  - getMinimumValue
```
public double getMinimumValue()
```
    Return the minimum valid value in the array.
    
    Returns:
    
    minimum value.
  - addValue
```
public void addValue(String key,
                     boolean val,
                     String comment)
              throws HeaderCardException
```
    Add information to the header
    
    Throws:
    
    HeaderCardException
  - addValue
```
public void addValue(String key,
                     int val,
                     String comment)
              throws HeaderCardException
```
    Throws:
    
    HeaderCardException
  - addValue
```
public void addValue(String key,
                     double val,
                     String comment)
              throws HeaderCardException
```
    Throws:
    
    HeaderCardException
  - addValue
```
public void addValue(String key,
                     String val,
                     String comment)
              throws HeaderCardException
```
    Throws:
    
    HeaderCardException
  - getDummyHDU
```
public static BasicHDU getDummyHDU()
```

Class BasicHDU

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BITPIX_BYTE

BITPIX_SHORT

BITPIX_INT

BITPIX_LONG

BITPIX_FLOAT

BITPIX_DOUBLE

myHeader

myData

isPrimary

Constructor Detail

BasicHDU

Method Detail

skipData

skipData

readData

getHeader

getFileOffset

getData

getKernel

getSize

isHeader

info

read

write

rewriteable

rewrite

getTrimmedString

getBitPix

getAxes

getParameterCount

getGroupCount

getBScale

getBZero

getBUnit

getBlankValue

getCreationDate

getObservationDate

getOrigin

getTelescope

getInstrument

getObserver

getObject

getEquinox

getEpoch

getAuthor

getReference

getMaximumValue

getMinimumValue

addValue

addValue

addValue

addValue

getDummyHDU