Package nom.tam.fits.compression.algorithm.api

Interface ICompressOption

All Superinterfaces:
Cloneable
All Known Implementing Classes:
HCompressorOption, HCompressorQuantizeOption, QuantizeOption, RiceCompressOption, RiceQuantizeCompressOption
public interface ICompressOption extends Cloneable
Option for the compression algorithm, implementors are used to control the compression algorithm.

  • Method Summary

    Modifier and Type
    Method
    Description
    ICompressOption
    copy()
    Returns an independent copy of this option.
    nom.tam.fits.compression.provider.param.api.ICompressParameters
    getCompressionParameters()
    (for internal use) Returns the parameters that represent the settings for this option in the FITS header or compressed data column.
    default int
    getTileHeight()
    Returns the tile height (if supported), or else 0 (also the default implementation).
    default int
    getTileWidth()
    Returns the tile width (if supported), or else 0 (also the default implementation).
    boolean
    isLossyCompression()
    Checks if this type of compression is inherently lossy
    void
    setParameters(nom.tam.fits.compression.provider.param.api.ICompressParameters parameters)
    (for internal use) Sets the parameters that link the options to how they are recorded in the FITS headers or compressed table columns.
    ICompressOption
    setTileHeight(int value)
    Set the tile height (if the option supports it).
    ICompressOption
    setTileWidth(int value)
    Set the tile width (if the option supports it).
    <T> T
    unwrap(Class<T> clazz)
    (for internal use) Recasts these options for the specific implementation class

  • Method Details

    • copy

      ICompressOption copy()
      Returns an independent copy of this option. Modifications to the original or the copy will not affect the other.
      Returns:
      copy the option (normally the option from with the copy happened is saved as original).

    • getCompressionParameters

      nom.tam.fits.compression.provider.param.api.ICompressParameters getCompressionParameters()
      (for internal use) Returns the parameters that represent the settings for this option in the FITS header or compressed data column.
      Returns:
      the parameters that must be synchronized with the hdu meta data.
      See Also:

    • isLossyCompression

      boolean isLossyCompression()
      Checks if this type of compression is inherently lossy
      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.

    • setParameters

      void setParameters(nom.tam.fits.compression.provider.param.api.ICompressParameters parameters)
      (for internal use) Sets the parameters that link the options to how they are recorded in the FITS headers or compressed table columns.
      Parameters:
      parameters - the parameters to synchronized
      See Also:

    • setTileHeight

      ICompressOption setTileHeight(int value)
      Set the tile height (if the option supports it). If the implementing option class does not have a setting for tile size, it should simply ignore the setting and return normally.
      Parameters:
      value - the new tile height in pixels
      Returns:
      itself
      See Also:

    • setTileWidth

      ICompressOption setTileWidth(int value)
      Set the tile width (if the option supports it). If the implementing option class does not have a setting for tile size, it should simply ignore the setting and return normally.
      Parameters:
      value - the new tile with in pixels
      Returns:
      itself
      See Also:

    • getTileHeight

      default int getTileHeight()
      Returns the tile height (if supported), or else 0 (also the default implementation).
      Returns:
      the tile height in pixels, or 0 if the options do not have a tile size setting.
      Since:
      1.18
      See Also:

    • getTileWidth

      default int getTileWidth()
      Returns the tile width (if supported), or else 0 (also the default implementation).
      Returns:
      the tile width in pixels, or 0 if the options do not have a tile size setting.
      Since:
      1.18
      See Also:

    • unwrap

      <T> T unwrap(Class<T> clazz)
      (for internal use) Recasts these options for the specific implementation class
      Type Parameters:
      T - these options recast to the designated implementation type.
      Parameters:
      clazz - the implementation class
      Returns:
      the recast version of us or null if the recasting is not available for the specified class type.