numcodecs_wasm_swizzle_reshape

Classes:

  • SwizzleReshape –

    Codec to swizzle/swap the axes of an array and reshape it.

SwizzleReshape 

SwizzleReshape(axes, _version='1.0.0')

Codec to swizzle/swap the axes of an array and reshape it.

This codec does not store metadata about the original shape of the array. Since axes that have been combined during encoding cannot be split without further information, decoding may fail if an output array is not provided.

Swizzling axes is always supported since no additional information about the array's shape is required to reconstruct it.

Parameters:
  • axes (...) –

    The permutation of the axes that is applied on encoding.

    The permutation is given as a list of axis groups, where each group corresponds to one encoded output axis that may consist of several decoded input axes. For instance, [[0], [1, 2]] flattens a three- dimensional array into a two-dimensional one by combining the second and third axes.

    The permutation also allows specifying a special catch-all remaining axes marker: - [[0], {}] moves the second axis to be the first and appends all other axes afterwards, i.e. the encoded array has the same number of axes as the input array - [[0], [{}]] in contrast collapses all other axes into one, i.e. the encoded array is two-dimensional

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

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

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 = 'swizzle-reshape.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.