compression_kwargs

classmethod caput.memdata.fileformats.FileFormat.compression_kwargs(compression=None, compression_opts=None, compressor=None)

Abstractmethod:

Arrange compression arguments into a format expected by the file format module.

The use case of the compression and compressor arguments may vary in each subclass.

Not implemented in base class.

Parameters:

compressionstr | int | None

Name or identifier of HDF5 compression filter.

compression_optstuple | None

Options for the selected filter. See HDF5 documentation for compression filters.

compressornumcodecs compressor

Instance of a numcodecs compression Codec.

Returns:

kwargsdict

Compression arguments as required by the file format module.