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

Class CompressParameter<OPTION>

java.lang.Object
nom.tam.fits.compression.provider.param.base.CompressParameter<OPTION>
Type Parameters:
OPTION - The generic type of the compression option that is linked to this parameter.
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
CompressColumnParameter, CompressHeaderParameter
public class CompressParameter<OPTION> extends Object implements Cloneable
(for internal use) A parameter stored in the FITS header or compressed table that is linked to a compression option. When writing compressed data, the parameter ensures that the compression options that were used to generate the compressed data are stored in the FITS (headers of compressed table) along with the compressed data themselves. When reading compressed data, the parameter acts to apply the options stored in the FITS along with the data to set the appropriate options for decompression.
See Also:

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    CompressParameter(String name, OPTION option)
    Creates a new compression parameter with the name it is recorded in the FITS and the compression options it is to be linked with.

  • Method Summary

    Modifier and Type
    Method
    Description
    CompressParameter<OPTION>
    copy(OPTION opt)
    Returns an independent copy of these parameters to associate with the specific instance of compression options.
    final String
    getName()
    Returns the name of this parameter as it is recorded in the FITS
    protected final OPTION
    getOption()
    Returns the compression options that are linked to this parameter

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CompressParameter

      protected CompressParameter(String name, OPTION option)
      Creates a new compression parameter with the name it is recorded in the FITS and the compression options it is to be linked with.
      Parameters:
      name - the FITS header keyword or binary table column name that records this parameter in the FITS.
      option - the compression option instance that this parameter is linked to.

  • Method Details

    • copy

      public CompressParameter<OPTION> copy(OPTION opt)
      Returns an independent copy of these parameters to associate with the specific instance of compression options. As a result, updating these parameters in the copy will affect only the specified compression options, but not the compression options associated to this originating instance.
      Parameters:
      opt - The compression options that are linked to the copy of the parameters
      Returns:
      A copy of these parameters, linked to the specified compression options.
      Since:
      1.18

    • getName

      public final String getName()
      Returns the name of this parameter as it is recorded in the FITS
      Returns:
      the FITS header keyword or binary table column name that records this parameter in the FITS.

    • getOption

      protected final OPTION getOption()
      Returns the compression options that are linked to this parameter
      Returns:
      the compression option instance that this parameter is linked to.