numcodecs_wasm_sperr

Classes:

  • Sperr –

    Codec providing compression using SPERR.

Sperr 

Sperr(
    mode,
    _version="0.2.0",
    bpp=None,
    psnr=None,
    pwe=None,
    q=None,
)

Codec providing compression using SPERR.

Arrays that are higher-dimensional than 3D are encoded by compressing each 3D slice with SPERR independently. Specifically, the array's shape is interpreted as [.., depth, height, width]. If you want to compress 3D slices along three different axes, you can swizzle the array axes beforehand.

Parameters:
  • mode (...) –

    • "bpp": Fixed bit-per-pixel rate

    • "psnr": Fixed peak signal-to-noise ratio

    • "pwe": Fixed point-wise (absolute) error

    • "q": Fixed quantisation step

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

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

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

    positive bits-per-pixel

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

    positive peak signal-to-noise ratio

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

    positive point-wise (absolute) error

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

    positive quantisation step

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 = 'sperr.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.