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

Class RiceBytePixParameter

java.lang.Object

nom.tam.fits.compression.provider.param.base.CompressParameter<OPTION>

nom.tam.fits.compression.provider.param.base.CompressHeaderParameter<RiceCompressOption>

nom.tam.fits.compression.provider.param.rice.RiceBytePixParameter

All Implemented Interfaces:

Cloneable, ICompressHeaderParameter, ICompressParameter

public final class RiceBytePixParameter
extends CompressHeaderParameter<RiceCompressOption>

(for internal use) The BYTEPIX value for the Rice compression as recorded in the FITS header.

Constructor Summary

Constructors

Constructor	Description
RiceBytePixParameter(RiceCompressOption riceCompressOption)	Deprecated. (for internal use) the visibility of this constructor may be reduced to the package level in future releases.

Method Summary

Modifier and Type	Method	Description
void	getValueFromHeader(IHeaderAccess header)	get the value from the header and set it in the compression option.
void	setValueInHeader(IHeaderAccess header)	Get the parameter value from the option and set it into the fits header.

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

findZVal, nextFreeZVal

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

copy, getName, getOption

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.ICompressParameter

getName

Constructor Details

RiceBytePixParameter

public RiceBytePixParameter(RiceCompressOption riceCompressOption)

Deprecated.

(for internal use) the visibility of this constructor may be reduced to the package level in future releases.

Method Details

getValueFromHeader

public void getValueFromHeader(IHeaderAccess header)

Description copied from interface: ICompressHeaderParameter

get the value from the header and set it in the compression option.

Parameters:

header - the header of the hdu

setValueInHeader

public void setValueInHeader(IHeaderAccess header)

Description copied from interface: ICompressHeaderParameter

Get the parameter value from the option and set it into the fits header.

Parameters:

header - the header to add the parameter.