nom.tam.fits.compression.algorithm.api

Interface ICompressOption

All Superinterfaces:

Cloneable

All Known Implementing Classes:

HCompressorOption, HCompressorQuantizeOption, QuantizeOption, RiceCompressOption, RiceQuantizeCompressOption

public interface ICompressOption
extends Cloneable

Option for the compression algorithm, implementors are used to control the compression algorithm.

Method Summary

Modifier and Type	Method and Description
ICompressOption	copy()
ICompressParameters	getCompressionParameters()
boolean	isLossyCompression()
void	setParameters(ICompressParameters parameters) set the parameters that must be synchronized with the hdu meta data.
ICompressOption	setTileHeight(int value) set the tile height in pixel.
ICompressOption	setTileWidth(int value) set the tile width.
<T> T	unwrap(Class<T> clazz) un wrap a specific implementation detail.

Method Detail

copy

ICompressOption copy()

Returns:

copy the option (normally the option from with the copy happened is saved as original).

getCompressionParameters

ICompressParameters getCompressionParameters()

Returns:

the parameters that must be synchronized with the hdu meta data.

isLossyCompression

boolean isLossyCompression()

Returns:

true if the compression done with this specified options uses approximations. That means if the reconstruction of the data is excact the return should be false.

setParameters

void setParameters(ICompressParameters parameters)

set the parameters that must be synchronized with the hdu meta data.

Parameters:

parameters - the parameters to synchronized

setTileHeight

ICompressOption setTileHeight(int value)

set the tile height in pixel.

Parameters:

value - the number of pixel.

Returns:

this (builder pattern)

setTileWidth

ICompressOption setTileWidth(int value)

set the tile width.

Parameters:

value - the number of pixel.

Returns:

this (builder pattern)

unwrap

<T> T unwrap(Class<T> clazz)

un wrap a specific implementation detail.

Type Parameters:

T - the class to unrwap

Parameters:

clazz - the type to unwrap

Returns:

the implementation detail or null if no such detail is avalable.