compress#

stixpy.calibration.compression.compress(values, *, s, k, m)[source]#

Compress values according to parameters.

Parameters:
  • values (array-like (int)) – Values to be compressed

  • s (int) – Number of sign bits, 0 for positive only values 1 for signed

  • k (int) – Number of bits for exponent

  • m (int) – Number of bit for mantissa

Returns:

array – The compressed values

Examples

>>> comp = compress(12345, s=0, k=5, m=3)
>>> int(comp)
92
>>> comp = compress(-1984, s=1, k=3, m=4)
>>> int(comp)
255