nom.tam.fits
Class ImageHDU

java.lang.Object
  extended by nom.tam.fits.BasicHDU
      extended by nom.tam.fits.ImageHDU
All Implemented Interfaces:
FitsElement

public class ImageHDU
extends BasicHDU

FITS image header/data unit


Field Summary
 
Fields inherited from class nom.tam.fits.BasicHDU
BITPIX_BYTE, BITPIX_DOUBLE, BITPIX_FLOAT, BITPIX_INT, BITPIX_LONG, BITPIX_SHORT, isPrimary, myData, myHeader
 
Constructor Summary
ImageHDU(Header h, Data d)
          Build an image HDU using the supplied data.
 
Method Summary
protected  boolean canBePrimary()
          Indicate that Images can appear at the beginning of a FITS dataset
static Data encapsulate(java.lang.Object o)
          Encapsulate an object as an ImageHDU.
 ImageTiler getTiler()
           
 void info()
          Print out some information about this HDU.
static boolean isData(java.lang.Object o)
          Check if this object can be described as a FITS image.
static boolean isHeader(Header hdr)
          Check that this HDU has a valid header for this type.
 Data manufactureData()
          Create a Data object to correspond to the header description.
static Data manufactureData(Header hdr)
           
static Header manufactureHeader(Data d)
          Create a header that describes the given image data.
protected  void setPrimaryHDU(boolean status)
          Change the Image from/to primary
 
Methods inherited from class nom.tam.fits.BasicHDU
addValue, addValue, addValue, addValue, getAuthor, getAxes, getBitPix, getBlankValue, getBScale, getBUnit, getBZero, getCreationDate, getData, getDummyHDU, getEpoch, getEquinox, getFileOffset, getGroupCount, getHeader, getInstrument, getKernel, getMaximumValue, getMinimumValue, getObject, getObservationDate, getObserver, getOrigin, getParameterCount, getReference, getSize, getTelescope, getTrimmedString, read, readData, rewrite, rewriteable, skipData, skipData, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImageHDU

public ImageHDU(Header h,
                Data d)
         throws FitsException
Build an image HDU using the supplied data.

Parameters:
obj - the data used to build the image.
Throws:
FitsException - if there was a problem with the data.
Method Detail

canBePrimary

protected boolean canBePrimary()
Indicate that Images can appear at the beginning of a FITS dataset


setPrimaryHDU

protected void setPrimaryHDU(boolean status)
Change the Image from/to primary


isHeader

public static boolean isHeader(Header hdr)
Check that this HDU has a valid header for this type.

Returns:
true if this HDU has a valid header.

isData

public static boolean isData(java.lang.Object o)
Check if this object can be described as a FITS image.

Parameters:
o - The Object being tested.

manufactureData

public Data manufactureData()
                     throws FitsException
Create a Data object to correspond to the header description.

Returns:
An unfilled Data object which can be used to read in the data for this HDU.
Throws:
FitsException - if the image extension could not be created.

manufactureData

public static Data manufactureData(Header hdr)
                            throws FitsException
Throws:
FitsException

manufactureHeader

public static Header manufactureHeader(Data d)
                                throws FitsException
Create a header that describes the given image data.

Parameters:
o - The image to be described.
Throws:
FitsException - if the object does not contain valid image data.

encapsulate

public static Data encapsulate(java.lang.Object o)
                        throws FitsException
Encapsulate an object as an ImageHDU.

Throws:
FitsException

getTiler

public ImageTiler getTiler()

info

public void info()
Print out some information about this HDU.

Specified by:
info in class BasicHDU