enstools.compression.api.emulate_compression_on_data_array

enstools.compression.api.emulate_compression_on_data_array(data_array: DataArray, compression_specification: Encoding, in_place=True) → Tuple[DataArray, dict]

Emulates compression on a given DataArray using the specified encoding.

Parameters:

data_arrayxarray.DataArray

The input data array to be compressed.

compression_specificationEncoding

The encoding specification to apply for the compression.

in_placebool, optional, default=True

If True, modifies the input data array in place, otherwise creates a new copy.

Returns:

data_arrayxarray.DataArray

The compressed data array.

compression_metricsdict

A dictionary containing compression metrics.