Class CompressedTableHDU

java.lang.Object

nom.tam.fits.BasicHDU<BinaryTable>

nom.tam.fits.TableHDU<BinaryTable>

nom.tam.fits.BinaryTableHDU

nom.tam.image.compression.hdu.CompressedTableHDU

All Implemented Interfaces:

FitsElement

public class CompressedTableHDU
extends BinaryTableHDU

Field Summary

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
CompressedTableHDU(Header hdr, CompressedTableData datum)

Method Summary

Modifier and Type	Method	Description
BinaryTableHDU	asBinaryTableHDU()
CompressedTableHDU	compress()
static CompressedTableHDU	fromBinaryTableHDU(BinaryTableHDU binaryTableHDU, int tileRows, String... columnCompressionAlgorithms)	Prepare a compressed binary table HDU for the specified binary table.
CompressedTableData	getData()
static boolean	isHeader(Header hdr)	Check that this HDU has a valid header for this type.
static CompressedTableData	manufactureData(Header hdr)

Methods inherited from class BinaryTableHDU

addColumn, binaryTableColumnKeyStems, columnKeyStems, encapsulate, info, isData, isHeader, manufactureHeader, setComplexColumn, write

Methods inherited from class TableHDU

addRow, deleteColumnsIndexOne, deleteColumnsIndexOne, deleteColumnsIndexZero, deleteColumnsIndexZero, deleteRows, deleteRows, findColumn, getColumn, getColumn, getColumnFormat, getColumnMeta, getColumnName, getColumns, getElement, getNCols, getNRows, getRow, setColumn, setColumn, setColumnMeta, setColumnMeta, setColumnMeta, setColumnMeta, setColumnMeta, setColumnMeta, setColumnMeta, setColumnName, setCurrentColumn, setCurrentColumn, setElement, setRow

Methods inherited from class BasicHDU

addValue, addValue, addValue, addValue, addValue, addValue, addValue, addValue, card, getAuthor, getAxes, getBitPix, getBlankValue, getBScale, getBUnit, getBZero, getCreationDate, 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

Methods inherited from class Object

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

Constructor Details

CompressedTableHDU

public CompressedTableHDU(Header hdr,
 CompressedTableData datum)

Method Details

fromBinaryTableHDU

public static CompressedTableHDU fromBinaryTableHDU(BinaryTableHDU binaryTableHDU,
 int tileRows,
 String... columnCompressionAlgorithms)
                                             throws FitsException

Prepare a compressed binary table HDU for the specified binary table. When the tile row size is specified with -1, the value will be set ti the number of rows in the table. The table will be compressed in "rows" that are defined by the tile size. Next step would be to set the compression options into the HDU and then compress it.

Parameters:

binaryTableHDU - the binary table to compress

tileRows - the number of rows that should be compressed per tile.

columnCompressionAlgorithms - the compression algorithms to use for the columns (optional default compression will be used if a column has no compression specified)

Returns:

the prepared compressed binary table HDU.

Throws:

FitsException - if the binary table could not be used to create a compressed binary table.

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 CompressedTableData manufactureData(Header hdr)
                                           throws FitsException

Throws:

FitsException

asBinaryTableHDU

public BinaryTableHDU asBinaryTableHDU()
                                throws FitsException

Throws:

FitsException

compress

public CompressedTableHDU compress()
                            throws FitsException

Throws:

FitsException

getData

public CompressedTableData getData()

Overrides:

getData in class BasicHDU<BinaryTable>

Returns:

the associated Data object