numcodecs_wasm_sz3

Classes:

  • Sz3 –

    Codec providing compression using SZ3

Sz3 

Sz3(
    eb_mode,
    _version="0.2.0",
    eb_abs=None,
    eb_l2=None,
    eb_psnr=None,
    eb_rel=None,
    predictor="interpolation-lorenzo",
)

Codec providing compression using SZ3

Parameters:
  • eb_mode (...) –

    • "abs-and-rel": Errors are bounded by both the absolute and relative error, i.e. by whichever bound is stricter

    • "abs-or-rel": Errors are bounded by either the absolute or relative error, i.e. by whichever bound is weaker

    • "abs": Absolute error bound

    • "rel": Relative error bound

    • "psnr": Peak signal to noise ratio error bound

    • "l2": Peak L2 norm error bound

  • _version (..., default: = "0.2.0" ) –

    The codec's encoding format version. Do not provide this parameter explicitly.

  • eb_abs (..., default: None ) –

    Absolute error bound

  • eb_l2 (..., default: None ) –

    Peak L2 norm error bound

  • eb_psnr (..., default: None ) –

    Peak signal to noise ratio error bound

  • eb_rel (..., default: None ) –

    Relative error bound

  • predictor (..., default: = "interpolation-lorenzo" ) –

    Predictor

Methods:

  • decode –

    Decode the data in buf.

  • encode –

    Encode the data in buf.

  • from_config –

    Instantiate the codec from a configuration dict.

  • get_config –

    Returns the configuration of the codec.

codec_id class-attribute instance-attribute 

codec_id = 'sz3.rs'

decode 

decode(buf, out=None)

Decode the data in buf.

Parameters:
  • buf (Buffer) –

    Encoded data. May be any object supporting the new-style buffer protocol.

  • out (Buffer, default: None ) –

    Writeable buffer to store decoded data. N.B. if provided, this buffer must be exactly the right size to store the decoded data.
Returns:
  • dec( Buffer ) –

    Decoded data. May be any object supporting the new-style buffer protocol.

encode 

encode(buf)

Encode the data in buf.

Parameters:
  • buf (Buffer) –

    Data to be encoded. May be any object supporting the new-style buffer protocol.
Returns:
  • enc( Buffer ) –

    Encoded data. May be any object supporting the new-style buffer protocol.

from_config classmethod 

from_config(config)

Instantiate the codec from a configuration dict.

Parameters:
  • config (dict) –

    Configuration of the codec.
Returns:
  • codec( Self ) –

    Instantiated codec.

get_config 

get_config()

Returns the configuration of the codec.

numcodecs.registry.get_codec(config) can be used to reconstruct this codec from the returned config.

Returns:
  • config( dict ) –

    Configuration of the codec.