Interface ICompressParameters

All Known Implementing Classes:
BundledParameters, CompressParameters, HCompressParameters, QuantizeParameters, RiceCompressParameters

public interface ICompressParameters

(for internal use) Group of parameters that must be synchronized with the hdu meta data for a specific compression algorithm.

NOTE, this interface is meant for internal use only. Implementing it externally to this library might not result in the desired behavior. If you feed the need to implement compression parameters externally to what is privided by this library, you are advised to extend the abstract CompressParameters class or of of its known subclasses instead

  • Method Details

    • addColumnsToTable

      void addColumnsToTable(BinaryTableHDU hdu) throws FitsException
      Add the columns that hold the metadata for the parameters that are column based to the dhu.
      Parameters:
      hdu - the hdu to add the column
      Throws:
      FitsException - if the column could not be added.
    • copy

      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)
    • setTileIndex

      void setTileIndex(int index)
      Initialize parameters for the given tile index
      Parameters:
      index - the 0-based tile index
    • getValuesFromColumn

      void getValuesFromColumn(int index)
      extract the option data from the column and set it in the option.
      Parameters:
      index - the index in the column.
    • getValuesFromHeader

      default void getValuesFromHeader(IHeaderAccess header)
      Deprecated.
      extract the option values that are represented by headers from the hdu header.
      Parameters:
      header - the header to extract the option values.
    • initializeColumns

      default void initializeColumns(IHeaderAccess header, BinaryTable binaryTable, int size) throws FitsException
      initialize the column based options of the compression algorithm from the binary table.
      Parameters:
      header - the header of the hdu
      binaryTable - the table of the hdu
      size - the column size
      Throws:
      FitsException - if the column could not be initialized
    • getValuesFromHeader

      void getValuesFromHeader(Header header) throws HeaderCardException
      extract the option values that are represented by headers from the hdu header.
      Parameters:
      header - the header to extract the option values.
      Throws:
      HeaderCardException - if there was an issue accessing the header
    • initializeColumns

      void initializeColumns(Header header, BinaryTable binaryTable, int size) throws HeaderCardException, FitsException
      initialize the column based options of the compression algorithm from the binary table.
      Parameters:
      header - the header of the hdu
      binaryTable - the table of the hdu
      size - the column size
      Throws:
      HeaderCardException - if there was an issue accessing the header
      FitsException - if the column could not be initialized
    • initializeColumns

      void initializeColumns(int length)
      initialize the column based parameter to the specified column length.
      Parameters:
      length - the column length.
    • setValuesInColumn

      void setValuesInColumn(int index)
      set the option values, that are column based, into the columns at the specified index.
      Parameters:
      index - the index in the columns to set.
    • setValueInColumn

      @Deprecated default void setValueInColumn(int index)
      Deprecated.
      Old, inconsistent method naming. Use setValuesInColumn(int) instead. set the option values, that are column based, into the columns at the specified index.
      Parameters:
      index - the index in the columns to set.
    • setValuesInHeader

      default void setValuesInHeader(IHeaderAccess header) throws HeaderCardException
      Deprecated.
      set the options values, that are hdu based, into the header.
      Parameters:
      header - the header to set the option value
      Throws:
      HeaderCardException - if the header could not be set.
    • setValuesInHeader

      void setValuesInHeader(Header header) throws HeaderCardException
      set the options values, that are hdu based, into the header.
      Parameters:
      header - the header to set the option value
      Throws:
      HeaderCardException - if the header could not be set.