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

Mixin class for a container of an underlying compressed array.

New in version (cfdm): 1.7.0

Initialisation

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

Returns a numpy array containing the uncompressed data.

compressed_array

Returns an independent numpy array with 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

Returns the compressed dimension’s position in the array.

get_compression_type

Returns the array’s compression type.

Miscellaneous

Methods

copy

Return a deep copy of the array.

get_subspace

Return a subspace, defined by indices, of a numpy array.

source

Return the underlying array object.

to_memory

Bring an array on disk into memory and retain it there.

Special

Methods

__array__

The numpy array interface.

__deepcopy__

Called by the copy.deepcopy function.

__getitem__

Return a subspace as an independent numpy array.

__repr__

Called by the repr built-in function.

__str__

Called by the str built-in function.

Docstring substitutions

Methods

_docstring_special_substitutions

Return the special docstring substitutions.

_docstring_substitutions

Returns the substitutions that apply to methods of the class.

_docstring_package_depth

Returns the class {{package}} substitutions package depth.

_docstring_method_exclusions

Returns method names excluded in the class substitutions.