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

Class QuantizeParameters

java.lang.Object

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

nom.tam.fits.compression.provider.param.quant.QuantizeParameters

All Implemented Interfaces:

Cloneable, ICompressParameters

public class QuantizeParameters
extends CompressParameters

(for internal use) A set of compression parameters recorded in the FITS that describe the quantization of floating point data. Quantization is the process of representing floating-point values by integers.

Author:

Attila Kovacs

Constructor Summary

Constructors

Constructor	Description
QuantizeParameters(QuantizeOption option)	Creates a set of compression parameters used for quantization of floating point data.

Method Summary

Modifier and Type	Method	Description
protected ICompressColumnParameter[]	columnParameters()	Retuens the subset of parameters from within, which are recorded in compressed table columns along with the compressed data.
QuantizeParameters	copy(ICompressOption option)	create a copy of this parameter for another option (normally a copy of the current option).
protected ICompressHeaderParameter[]	headerParameters()	Returns the subset of parameters from within, which are recorded in the header of the compressed HDU.
void	setTileIndex(int index)	Initialize parameters for the given tile index

Methods inherited from class nom.tam.fits.compression.provider.param.base.CompressParameters

addColumnsToTable, clone, getValuesFromColumn, getValuesFromHeader, initializeColumns, initializeColumns, setValuesInColumn, setValuesInHeader

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

setValueInColumn

Constructor Details

QuantizeParameters

public QuantizeParameters(QuantizeOption option)

Creates a set of compression parameters used for quantization of floating point data. Quantization is the process of representing floating-point values by integers.

Parameters:

option - The compression option that is configured with the particular parameter values of this object.

Method Details

columnParameters

protected ICompressColumnParameter[] columnParameters()

Description copied from class: CompressParameters

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

Overrides:

columnParameters in class CompressParameters

Returns:

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

See Also:

• CompressParameters.headerParameters()

headerParameters

protected ICompressHeaderParameter[] headerParameters()

Description copied from class: CompressParameters

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

Specified by:

headerParameters in class CompressParameters

Returns:

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

See Also:

• CompressParameters.columnParameters()

setTileIndex

public void setTileIndex(int index)

Description copied from interface: ICompressParameters

Initialize parameters for the given tile index

Specified by:

setTileIndex in interface ICompressParameters

Overrides:

setTileIndex in class CompressParameters

Parameters:

index - the 0-based tile index

copy

public QuantizeParameters copy(ICompressOption option)

Description copied from interface: ICompressParameters

create a copy of this parameter for another option (normally a copy of the current option).

Parameters:

option - the new option for the copied parameter

Returns:

this (builder pattern)