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

Class BundledParameters

java.lang.Object

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

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

All Implemented Interfaces:

Cloneable, ICompressParameters

public class BundledParameters
extends CompressParameters

(for internal use) Compression parameters that are bundled together from distinct sets of component parameters. For example, some tiled image compression methods will take parameters that consist of those specifically for the compression algorithm (e.g. Rice vs HCompress) and a set of common parameters for the quantization (floating-point to integer conversion). This class helps manage such composite parameter sets. The bundle behaves as it it were a single set of all parameters across all its components.

Since:

1.18

Author:

Attila Kovacs

Constructor Summary

Constructors

Constructor	Description
BundledParameters(ICompressParameters... components)	Creates a new set of bundled compression parameters from the specified separate parameter components.

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.
BundledParameters	copy(ICompressOption option)	create a copy of this parameter for another option (normally a copy of the current option).
ICompressParameters	get(int index)	Resturn the compression parameters for the specified component index.
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
int	size()	Returns the number of independent compression parameter components represented by this bundle.

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

BundledParameters

public BundledParameters(ICompressParameters... components)

Creates a new set of bundled compression parameters from the specified separate parameter components.

Parameters:

components - The components, which are to be bundled to provide a single set of parameters that span all of them.

See Also:

• get(int)

Method Details

size

public int size()

Returns the number of independent compression parameter components represented by this bundle.

Returns:

the number of component compression parameter sets in this bundle.

See Also:

• get(int)

get

public ICompressParameters get(int index)

Resturn the compression parameters for the specified component index.

Parameters:

index - the index of the paramete set in the bundle.

Returns:

the compression parameters for the particular bundle component.

Throws:

IndexOutOfBoundsException - if the index it negative or beyond the index of the last component.

See Also:

• size()

copy

public BundledParameters 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)

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