ZFPY

class numcodecs.zfpy.ZFPY(mode=4, tolerance=-1, rate=-1, precision=-1, compression_kwargs=None)[source]

Codec providing compression using zfpy via the Python standard library.

Parameters
modeinteger

One of the zfpy mode choice, e.g., zfpy.mode_fixed_accuracy.

tolerancedouble, optional

A double-precision number, specifying the compression accuracy needed.

ratedouble, optional

A double-precision number, specifying the compression rate needed.

precisionint, optional

A integer number, specifying the compression precision needed.

codec_id = 'zfpy'

Codec identifier.

encode(buf)[source]

Encode data in buf.

Parameters
bufbuffer-like

Data to be encoded. May be any object supporting the new-style buffer protocol.

Returns
encbuffer-like

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

decode(buf, out=None)[source]

Decode data in buf.

Parameters
bufbuffer-like

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

outbuffer-like, optional

Writeable buffer to store decoded data. N.B. if provided, this buffer must be exactly the right size to store the decoded data.

Returns
decbuffer-like

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

get_config()

Return a dictionary holding configuration parameters for this codec. Must include an ‘id’ field with the codec identifier. All values must be compatible with JSON encoding.

classmethod from_config(config)

Instantiate codec from a configuration object.