cfdm.CompressedArray


class cfdm.CompressedArray(compressed_array=None, shape=None, size=None, ndim=None, compressed_dimension=None, compression_type=None, **kwargs)[source]

Bases: cfdm.data.abstract.array.Array

Abstract base class for a container of an underlying compressed array.

See cfdm.GatheredArray for an example implementation.

New in version 1.7.0.

Initialization

Parameters:
compressed_array: subclass of Array

The compressed array.

shape: tuple

The uncompressed array dimension sizes.

size: int

Number of elements in the uncompressed array.

ndim: int

The number of uncompressed array dimensions

compressed_dimension: int

The position of the compressed dimension in the compressed array.

compression_type: str

The type of compression.

kwargs: optional

Further named parameters and their values needed to define the compressed array.

Inspection

Attributes

array Return an independent numpy array containing the uncompressed data.
compressed_array Return an independent numpy array containing the compressed data.
dtype Data-type of the data elements.
ndim The number of dimensions of the uncompressed data.
shape Shape of the uncompressed data.
size Number of elements in the uncompressed data.

Compression

Methods

get_compressed_axes Return axes that are compressed in the underlying array.
get_compressed_dimension Return the position of the compressed dimension in the compressed array.
get_compression_type The type of compression that has been applied to the underlying array.

Miscellaneous

Methods

copy Return a deep copy of the array.

Special

Methods

__array__ The numpy array interface.
__deepcopy__ Called by the copy.deepcopy function.
__getitem__ Return an uncompressed subspace as an independent numpy array.
__repr__ Called by the repr built-in function.
__str__ Called by the str built-in function.