Class QuantizeOption

java.lang.Object
nom.tam.fits.compression.algorithm.quant.QuantizeOption
All Implemented Interfaces:
Cloneable, ICompressOption
Direct Known Subclasses:
HCompressorQuantizeOption, RiceQuantizeCompressOption

public class QuantizeOption extends Object implements ICompressOption
  • Field Details

  • Constructor Details

    • QuantizeOption

      public QuantizeOption()
  • Method Details

    • copy

      public QuantizeOption copy()
      Specified by:
      copy in interface ICompressOption
      Returns:
      copy the option (normally the option from with the copy happened is saved as original).
    • getBNull

      public Integer getBNull()
    • getBScale

      public double getBScale()
    • getBZero

      public double getBZero()
    • getCompressionParameters

      public ICompressParameters getCompressionParameters()
      Specified by:
      getCompressionParameters in interface ICompressOption
      Returns:
      the parameters that must be synchronized with the hdu meta data.
    • getCompressOption

      public <T> T getCompressOption(Class<T> clazz)
    • getIntMaxValue

      public int getIntMaxValue()
    • getIntMinValue

      public int getIntMinValue()
    • getMaxValue

      public double getMaxValue()
    • getMinValue

      public double getMinValue()
    • getNullValue

      public double getNullValue()
    • getNullValueIndicator

      public Integer getNullValueIndicator()
    • getOriginal

      public QuantizeOption getOriginal()
    • getQLevel

      public double getQLevel()
    • getSeed

      public long getSeed()
    • getTileHeight

      public int getTileHeight()
    • getTileWidth

      public int getTileWidth()
    • isCenterOnZero

      public boolean isCenterOnZero()
    • isCheckNull

      public boolean isCheckNull()
    • isCheckZero

      public boolean isCheckZero()
    • isDither

      public boolean isDither()
    • isDither2

      public boolean isDither2()
    • isLossyCompression

      public boolean isLossyCompression()
      Specified by:
      isLossyCompression in interface ICompressOption
      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.
    • setBNull

      public ICompressOption setBNull(Integer blank)
    • setBScale

      public QuantizeOption setBScale(double value)
    • setBZero

      public QuantizeOption setBZero(double value)
    • setCenterOnZero

      public QuantizeOption setCenterOnZero(boolean value)
    • setCheckNull

      public QuantizeOption setCheckNull(boolean value)
    • setCheckZero

      public QuantizeOption setCheckZero(boolean value)
    • setDither

      public QuantizeOption setDither(boolean value)
    • setDither2

      public QuantizeOption setDither2(boolean value)
    • setIntMaxValue

      public QuantizeOption setIntMaxValue(int value)
    • setIntMinValue

      public QuantizeOption setIntMinValue(int value)
    • setMaxValue

      public QuantizeOption setMaxValue(double value)
    • setMinValue

      public QuantizeOption setMinValue(double value)
    • setNullValue

      public QuantizeOption setNullValue(double value)
    • setParameters

      public void setParameters(ICompressParameters parameters)
      Description copied from interface: ICompressOption
      set the parameters that must be synchronized with the hdu meta data.
      Specified by:
      setParameters in interface ICompressOption
      Parameters:
      parameters - the parameters to synchronized
    • setQlevel

      public QuantizeOption setQlevel(double value)
    • setSeed

      public QuantizeOption setSeed(long value)
    • setTileHeight

      public QuantizeOption setTileHeight(int value)
      Description copied from interface: ICompressOption
      set the tile height in pixel.
      Specified by:
      setTileHeight in interface ICompressOption
      Parameters:
      value - the number of pixel.
      Returns:
      this (builder pattern)
    • setTileWidth

      public QuantizeOption setTileWidth(int value)
      Description copied from interface: ICompressOption
      set the tile width.
      Specified by:
      setTileWidth in interface ICompressOption
      Parameters:
      value - the number of pixel.
      Returns:
      this (builder pattern)
    • unwrap

      public <T> T unwrap(Class<T> clazz)
      Description copied from interface: ICompressOption
      un wrap a specific implementation detail.
      Specified by:
      unwrap in interface ICompressOption
      Type Parameters:
      T - the class to unrwap
      Parameters:
      clazz - the type to unwrap
      Returns:
      the implementation detail or null if no such detail is avalable.