Class ImageHDU

java.lang.Object

nom.tam.fits.BasicHDU<ImageData>

nom.tam.fits.ImageHDU

All Implemented Interfaces:

FitsElement

public class ImageHDU
extends BasicHDU<ImageData>

FITS image header/data unit

Field Summary

Fields

Modifier and Type	Field	Description
private static final Logger	LOG

Fields inherited from class BasicHDU

BITPIX_BYTE, BITPIX_DOUBLE, BITPIX_FLOAT, BITPIX_INT, BITPIX_LONG, BITPIX_SHORT, isPrimary, myData, myHeader

Constructor Summary

Constructors

Constructor	Description
ImageHDU(Header h, ImageData d)	Build an image HDU using the supplied data.

Method Summary

Modifier and Type	Method	Description
protected boolean	canBePrimary()	Indicate that Images can appear at the beginning of a FITS dataset
static ImageData	encapsulate(Object o)
StandardImageTiler	getTiler()
void	info(PrintStream stream)	Print out some information about this HDU.
static boolean	isData(Object o)
static boolean	isHeader(Header hdr)	Check that this HDU has a valid header for this type.
static Data	manufactureData(Header hdr)
static Header	manufactureHeader(Data d)
protected void	setPrimaryHDU(boolean status)	Change the Image from/to primary

Methods inherited from class BasicHDU

addValue, addValue, addValue, addValue, addValue, addValue, addValue, addValue, card, 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, getTrimmedString, read, reset, rewrite, rewriteable, saveReplaceCard, write

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG

private static final Logger LOG

Constructor Details

ImageHDU

public ImageHDU(Header h,
 ImageData d)
         throws FitsException

Build an image HDU using the supplied data.

Parameters:

h - the header for the image.

d - the data used in the image.

Throws:

FitsException - if there was a problem with the data.

Method Details

encapsulate

public static ImageData encapsulate(Object o)
                             throws FitsException

Parameters:

o - object to encapsulate

Returns:

Encapsulate an object as an ImageHDU.

Throws:

FitsException - if the operation failed

isData

public static boolean isData(Object o)

Parameters:

o - The Object being tested.

Returns:

is this object can be described as a FITS image.

isHeader

public static boolean isHeader(Header hdr)

Check that this HDU has a valid header for this type.

Parameters:

hdr - header to check

Returns:

true if this HDU has a valid header.

manufactureData

public static Data manufactureData(Header hdr)
                            throws FitsException

Throws:

FitsException

manufactureHeader

public static Header manufactureHeader(Data d)
                                throws FitsException

Parameters:

d - The image to be described.

Returns:

Create a header that describes the given image data.

Throws:

FitsException - if the object does not contain valid image data.

canBePrimary

protected boolean canBePrimary()

Indicate that Images can appear at the beginning of a FITS dataset

Overrides:

canBePrimary in class BasicHDU<ImageData>

Returns:

Indicate whether HDU can be primary HDU. This method must be overriden in HDU types which can appear at the beginning of a FITS file.

getTiler

public StandardImageTiler getTiler()

info

public void info(PrintStream stream)

Print out some information about this HDU.

Specified by:

info in class BasicHDU<ImageData>

Parameters:

stream - the printstream to write the info on

setPrimaryHDU

protected void setPrimaryHDU(boolean status)

Change the Image from/to primary

Overrides:

setPrimaryHDU in class BasicHDU<ImageData>

Parameters:

status - value to set