Package nom.tam.fits.compression.provider.param.base

Class CompressParameters

java.lang.Object

nom.tam.fits.compression.provider.param.base.CompressParameters

All Implemented Interfaces:

Cloneable, ICompressParameters

Direct Known Subclasses:

BundledParameters, HCompressParameters, QuantizeParameters, RiceCompressParameters

public abstract class CompressParameters
extends Object
implements ICompressParameters, Cloneable

(for internal use) A set of CompressParameters that are bundled together, typically because they are parameters that all link to the same ICompressOption

See Also:

• CompressParameter

Constructor Summary

Constructors

Constructor	Description
CompressParameters()

Method Summary

Modifier and Type	Method	Description
void	addColumnsToTable(BinaryTableHDU hdu)	Add the columns that hold the metadata for the parameters that are column based to the dhu.
protected CompressParameters	clone()
protected ICompressColumnParameter[]	columnParameters()	Retuens the subset of parameters from within, which are recorded in compressed table columns along with the compressed data.
void	getValuesFromColumn(int index)	extract the option data from the column and set it in the option.
void	getValuesFromHeader(IHeaderAccess header)	extract the option values that are represented by headers from the hdu header.
protected abstract ICompressHeaderParameter[]	headerParameters()	Returns the subset of parameters from within, which are recorded in the header of the compressed HDU.
void	initializeColumns(int size)	initialize the column based parameter to the specified column length.
void	initializeColumns(IHeaderAccess header, BinaryTable binaryTable, int size)	initialize the column based options of the compression algorithm from the binary table.
void	setTileIndex(int index)	Initialize parameters for the given tile index
void	setValuesInColumn(int index)	set the option values, that are column based, into the columns at the specified index.
void	setValuesInHeader(IHeaderAccess header)	set the options values, that are hdu based, into the header.

Methods inherited from class java.lang.Object

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

Methods inherited from interface nom.tam.fits.compression.provider.param.api.ICompressParameters

copy, setValueInColumn

Constructor Details

CompressParameters

public CompressParameters()

Method Details

addColumnsToTable

public void addColumnsToTable(BinaryTableHDU hdu)
                       throws FitsException

Description copied from interface: ICompressParameters

Add the columns that hold the metadata for the parameters that are column based to the dhu.

Specified by:

addColumnsToTable in interface ICompressParameters

Parameters:

hdu - the hdu to add the column

Throws:

FitsException - if the column could not be added.

clone

protected CompressParameters clone()

Overrides:

clone in class Object

setTileIndex

public void setTileIndex(int index)

Description copied from interface: ICompressParameters

Initialize parameters for the given tile index

Specified by:

setTileIndex in interface ICompressParameters

Parameters:

index - the 0-based tile index

getValuesFromColumn

public void getValuesFromColumn(int index)

Description copied from interface: ICompressParameters

extract the option data from the column and set it in the option.

Specified by:

getValuesFromColumn in interface ICompressParameters

Parameters:

index - the index in the column.

getValuesFromHeader

public void getValuesFromHeader(IHeaderAccess header)

Description copied from interface: ICompressParameters

extract the option values that are represented by headers from the hdu header.

Specified by:

getValuesFromHeader in interface ICompressParameters

Parameters:

header - the header to extract the option values.

initializeColumns

public void initializeColumns(IHeaderAccess header,
 BinaryTable binaryTable,
 int size)
                       throws FitsException

Description copied from interface: ICompressParameters

initialize the column based options of the compression algorithm from the binary table.

Specified by:

initializeColumns in interface ICompressParameters

Parameters:

header - the header of the hdu

binaryTable - the table of the hdu

size - the column size

Throws:

FitsException - if the column could not be initialized

initializeColumns

public void initializeColumns(int size)

Description copied from interface: ICompressParameters

initialize the column based parameter to the specified column length.

Specified by:

initializeColumns in interface ICompressParameters

Parameters:

size - the column length.

setValuesInColumn

public void setValuesInColumn(int index)

Description copied from interface: ICompressParameters

set the option values, that are column based, into the columns at the specified index.

Specified by:

setValuesInColumn in interface ICompressParameters

Parameters:

index - the index in the columns to set.

setValuesInHeader

public void setValuesInHeader(IHeaderAccess header)
                       throws HeaderCardException

Description copied from interface: ICompressParameters

set the options values, that are hdu based, into the header.

Specified by:

setValuesInHeader in interface ICompressParameters

Parameters:

header - the header to set the option value

Throws:

HeaderCardException - if the header could not be set.

columnParameters

protected ICompressColumnParameter[] columnParameters()

Retuens the subset of parameters from within, which are recorded in compressed table columns along with the compressed data.

Returns:

the subset of parameters that are recorded in compressed table columns.

See Also:

• headerParameters()

headerParameters

protected abstract ICompressHeaderParameter[] headerParameters()

Returns the subset of parameters from within, which are recorded in the header of the compressed HDU.

Returns:

the subset of parameters that are recorded in the compressed HDU's header.

See Also:

• columnParameters()