nom.tam.fits.compression.algorithm.rice

Class RiceCompressOption

java.lang.Object

nom.tam.fits.compression.algorithm.rice.RiceCompressOption

All Implemented Interfaces:

Cloneable, ICompressOption

public class RiceCompressOption
extends Object
implements ICompressOption

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RICE_BLOCKSIZE
static int	DEFAULT_RICE_BYTEPIX

Constructor Summary

Constructors

Constructor and Description
RiceCompressOption()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RICE_BLOCKSIZE

public static final int DEFAULT_RICE_BLOCKSIZE

See Also:

Constant Field Values

DEFAULT_RICE_BYTEPIX

public static final int DEFAULT_RICE_BYTEPIX

Constructor Detail

RiceCompressOption

public RiceCompressOption()

Method Detail

copy

public RiceCompressOption copy()

Specified by:

copy in interface ICompressOption

Returns:

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

getBlockSize

public int getBlockSize()

getBytePix

public int getBytePix()

getCompressionParameters

public ICompressParameters getCompressionParameters()

Specified by:

getCompressionParameters in interface ICompressOption

Returns:

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

isLossyCompression

public boolean isLossyCompression()

Specified by:

isLossyCompression in interface ICompressOption

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.

setBlockSize

public RiceCompressOption setBlockSize(int value)

setBytePix

public RiceCompressOption setBytePix(int value)

setParameters

public void setParameters(ICompressParameters parameters)

Description copied from interface: ICompressOption

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

Specified by:

setParameters in interface ICompressOption

Parameters:

parameters - the parameters to synchronized

setTileHeight

public RiceCompressOption setTileHeight(int value)

Description copied from interface: ICompressOption

set the tile height in pixel.

Specified by:

setTileHeight in interface ICompressOption

Parameters:

value - the number of pixel.

Returns:

this (builder pattern)

setTileWidth

public RiceCompressOption setTileWidth(int value)

Description copied from interface: ICompressOption

set the tile width.

Specified by:

setTileWidth in interface ICompressOption

Parameters:

value - the number of pixel.

Returns:

this (builder pattern)

unwrap

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

Description copied from interface: ICompressOption

un wrap a specific implementation detail.

Specified by:

unwrap in interface ICompressOption

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.

setDefaultBytePix

protected RiceCompressOption setDefaultBytePix(int defaultBytePix)