Class RiceQuantizeCompressOption

java.lang.Object

nom.tam.fits.compression.algorithm.quant.QuantizeOption

nom.tam.fits.compression.algorithm.rice.RiceQuantizeCompressOption

All Implemented Interfaces:

Cloneable, ICompressOption

@Deprecated
public class RiceQuantizeCompressOption
extends QuantizeOption

Deprecated.

(for internal use) This class should not be exposed to users.

Options to the Rice compression algorithm when the compression includes quantization. When compressing tables and images using the Rice algorithm, including quantization, users can control how exactly the compression and quantization are perfomed. When reading compressed FITS files, these options will be set automatically based on the header values recorded in the compressed HDU.

See Also:

• CompressedImageHDU.setCompressAlgorithm(String)
• CompressedImageHDU.getCompressOption(Class)
• RiceCompressOption

Field Summary

Fields inherited from class QuantizeOption

RECOMMENDED_NAN_INDICATOR

Modifier and Type	Field	Description
static final int	RECOMMENDED_NAN_INDICATOR	The integer value recommeded by the FITS standard to represent NaN floating-point values in integer compressed data.

Constructor Summary

Constructors

Constructor	Description
RiceQuantizeCompressOption()	Deprecated.
RiceQuantizeCompressOption(RiceCompressOption compressOption)	Deprecated.

Method Summary

Modifier and Type	Method	Description
RiceCompressOption	getRiceCompressOption()	Deprecated.

Methods inherited from class QuantizeOption

copy, getBNull, getBScale, getBZero, getCompressionParameters, getCompressOption, getCompressOption, getIntMaxValue, getIntMinValue, getMaxValue, getMinValue, getNullValue, getNullValueIndicator, getQLevel, getSeed, getTileHeight, getTileIndex, getTileWidth, isCenterOnZero, isCheckNull, isCheckZero, isDither, isDither2, isLossyCompression, isUseFMA, setBNull, setBScale, setBZero, setCenterOnZero, setCheckNull, setCheckZero, setDither, setDither2, setIntMaxValue, setIntMinValue, setMaxValue, setMinValue, setNullValue, setParameters, setQlevel, setSeed, setTileHeight, setTileIndex, setTileWidth, unwrap, useFMA

Modifier and Type	Method	Description
QuantizeOption	copy()	Returns an independent copy of this option.
Integer	getBNull()	Returns the integer value that represents missing (null) for integer compressed floating-point data.
double	getBScale()	Returns the quantization level for integer compressed floating-point data.
double	getBZero()	Returns the quantization offset for integer compressed floating-point data.
nom.tam.fits.compression.provider.param.api.ICompressParameters	getCompressionParameters()	(for internal use) Returns the parameters that represent the settings for this option in the FITS header or compressed data column.
final ICompressOption	getCompressOption()	Returns the options for the compression algorithm that accompanies quantization.
<T> T	getCompressOption(Class<T> clazz)	Returns the compression or quantization options, recast for the selected option class.
int	getIntMaxValue()	Returns the maximum integer level in the quantized representation.
int	getIntMinValue()	Returns the maximum integer level in the quantized representation.
double	getMaxValue()	Returns the maximum floating-point value in the data
double	getMinValue()	Returns the minimum floating-point value in the data
double	getNullValue()	Deprecated. The FITS standard allows only NaNs to indicate missing / invalid floating-point data.
final Integer	getNullValueIndicator()	Deprecated. use QuantizeOption.getBNull() instead (duplicate method).
double	getQLevel()	Returns the quantization resolution level used for automatic qunatization.
long	getSeed()	Gets the random seed value used for dithering
int	getTileHeight()	Returns the tile height
long	getTileIndex()	Returns the sequential tile index that this option is currently configured for.
int	getTileWidth()	Returns the tile width
boolean	isCenterOnZero()	Checks whether we force the integer quantized level 0 to correspond to a floating-point level 0.0, when using automatic quantization.
final boolean	isCheckNull()	Deprecated. Use QuantizeOption.getBNull() instead to see if a custom null-value indicator has been configured.
boolean	isCheckZero()	Deprecated. Use QuantizeOption.isDither2() instead.
boolean	isDither()	Whether dithering is enabled
boolean	isDither2()	Whether dithering (when enabled) uses method 2, which treats 0.0 values as special.
boolean	isLossyCompression()	Checks if this type of compression is inherently lossy
static final boolean	isUseFMA()	Checks whether Math.fma(double, double, double) is used for converting quantized integers back to doubles.
QuantizeOption	setBNull(Integer blank)	Sets the integer value that represents missing data (null) for integer compressed floating-point data.
QuantizeOption	setBScale(double value)	Sets the quantization level for integer compressed floating-point data.
QuantizeOption	setBZero(double value)	Sets the quantization offset for integer compressed floating-point data.
QuantizeOption	setCenterOnZero(boolean value)	Enabled or disables keeping `ZZERO` at 0 when using automatic quantization.
QuantizeOption	setCheckNull(boolean value)	Deprecated. This feature is set automatically as needed.
QuantizeOption	setCheckZero(boolean value)	Deprecated. Use QuantizeOption.setDither2(boolean) instead if you want zero values to be special encoded.
QuantizeOption	setDither(boolean value)	Enables or disables dithering.
QuantizeOption	setDither2(boolean value)	Sets whether dithering is to use method 2, when dithering is enabled.
QuantizeOption	setIntMaxValue(int value)	Sets the maximum integer level in the quantized representation.
QuantizeOption	setIntMinValue(int value)	Sets the minimum integer level in the quantized representation.
QuantizeOption	setMaxValue(double value)	Sets the maximum floating-point value in the data
QuantizeOption	setMinValue(double value)	Sets the minimum floating-point value in the data
QuantizeOption	setNullValue(double value)	Deprecated. The use of null values other than NaN for floating-point data types is not standard in FITS.
void	setParameters(nom.tam.fits.compression.provider.param.api.ICompressParameters parameters)	(for internal use) Sets the parameters that link the options to how they are recorded in the FITS headers or compressed table columns.
QuantizeOption	setQlevel(double value)	Sets the quantization resolution level to use for automatic quantization.
QuantizeOption	setSeed(long value)	Sets the seed value for the dither random generator
QuantizeOption	setTileHeight(int value)	Set the tile height (if the option supports it).
QuantizeOption	setTileIndex(int index)	Sets the tile index for which to initialize the random number generator with the given seed (i.e.
QuantizeOption	setTileWidth(int value)	Set the tile width (if the option supports it).
<T> T	unwrap(Class<T> clazz)	(for internal use) Recasts these options for the specific implementation class
static void	useFMA(boolean value)	Selects whether Math.fma(double, double, double) should be used when converting quantized integers back to doubles.

Methods inherited from class Object

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

Constructor Details

RiceQuantizeCompressOption

@Deprecated
public RiceQuantizeCompressOption()

Deprecated.

Creates a new set of options for Rice compression with quantization, initialized to default values.

RiceQuantizeCompressOption

@Deprecated
public RiceQuantizeCompressOption(RiceCompressOption compressOption)

Deprecated.

Creates a new set of options for Rice compression with quantization, using the specified option to the Rice (de)compression, and initializing the qunatization options with default values.

Parameters:

compressOption - The Rice compression options to use

Method Details

getRiceCompressOption

@Deprecated
public RiceCompressOption getRiceCompressOption()

Deprecated.

Returns the options that are specific to the Rice compression algorithm (without quantization).

Returns:

the included options to the Rice compression algorithm

See Also:

• QuantizeOption.getCompressOption(Class)