cfdm.CompressedArray

---

class cfdm.CompressedArray(compressed_array=None, shape=None, size=None, ndim=None, compressed_dimension=None, compressed_dimensions=None, compression_type=None, source=None, copy=True)

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: array_like

The compressed array.

shape: tuple

The uncompressed array dimension sizes.

compressed_dimensions: dict

Mapping of dimensions of the compressed array to their corresponding dimensions in the uncompressed array. Compressed array dimensions that are not compressed must be omitted from the mapping.

Parameter example:

{0: (0, 1)}

Parameter example:

{0: (0, 1, 2)}

Parameter example:

{2: (2, 3)}

Parameter example:

{1: (1,)}

Parameter example:

{0: (0,), 2: (2,)}

New in version (cfdm): 1.10.0.0

compression_type: str

The type of compression.

kwargs: optional

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

compressed_dimension: Deprecated at version 1.10.0.0

Use the compressed_dimensions parameter instead.

source: optional

Convert source, which can be any type of object, to a CompressedArray instance.

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the CompressedArray API. Any parameters that can not be retrieved from source in this way are assumed to have their default value.

Note that if x is also a CompressedArray instance then cfdm.CompressedArray(source=x) is equivalent to x.copy().

New in version (cfdm): 1.10.0.0

copy: bool, optional

If True (the default) then deep copy input parameters prior to initialisation. If False then arguments are not deep copied.

New in version (cfdm): 1.10.0.0

size: int

Deprecated at version 1.10.0.0. If set will be ignored.

Number of elements in the uncompressed array.

ndim: int

Deprecated at version 1.10.0.0. If set will be ignored.

The number of uncompressed array dimensions

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 uncompressed data.
ndim	Number of array dimensions.
shape	Shape of the uncompressed data.
size	Number of elements in the array.

Units

Methods

get_calendar	The calendar of the array.
get_units	The units of the array.

Compression

Methods

compressed_dimensions	Mapping of compressed to uncompressed dimensions.
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.
subarray_shapes	Create the subarray shapes along each uncompressed dimension.
subarray_parameters	Non-data parameters required by the Subarray class.
subarrays	Return descriptors for every subarray.
get_Subarray	Return the Subarray class.
conformed_data	The data as required by the decompression algorithm.

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 data on disk into memory.
get_filenames	Return the names of any files containing the compressed data.

Special

Methods

__array__	The numpy array interface.
__deepcopy__	Called by the copy.deepcopy function.
__getitem__	Return a subspace of the uncompressed data.
__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.