Class CompressParameters
- java.lang.Object
-
- nom.tam.fits.compression.provider.param.base.CompressParameters
-
- All Implemented Interfaces:
ICompressParameters
- Direct Known Subclasses:
HCompressParameters
,QuantizeParameters
,RiceCompressParameters
public abstract class CompressParameters extends java.lang.Object implements ICompressParameters
-
-
Constructor Summary
Constructors Constructor Description CompressParameters()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods 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 ICompressColumnParameter[]
columnParameters()
private java.lang.Object
getNullableColumn(IHeaderAccess header, BinaryTable binaryTable, java.lang.String columnName)
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()
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
setValueFromColumn(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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface nom.tam.fits.compression.provider.param.api.ICompressParameters
copy
-
-
-
-
Method Detail
-
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 interfaceICompressParameters
- Parameters:
hdu
- the hdu to add the column- Throws:
FitsException
- if the column could not be added.
-
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 interfaceICompressParameters
- 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 interfaceICompressParameters
- 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 interfaceICompressParameters
- Parameters:
header
- the header of the hdubinaryTable
- the table of the hdusize
- 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 interfaceICompressParameters
- Parameters:
size
- the column length.
-
setValueFromColumn
public void setValueFromColumn(int index)
Description copied from interface:ICompressParameters
set the option values, that are column based, into the columns at the specified index.- Specified by:
setValueFromColumn
in interfaceICompressParameters
- 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 interfaceICompressParameters
- Parameters:
header
- the header to set the option value- Throws:
HeaderCardException
- if the header could not be set.
-
getNullableColumn
private java.lang.Object getNullableColumn(IHeaderAccess header, BinaryTable binaryTable, java.lang.String columnName) throws FitsException
- Throws:
FitsException
-
columnParameters
protected ICompressColumnParameter[] columnParameters()
-
headerParameters
protected abstract ICompressHeaderParameter[] headerParameters()
-
-