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)[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: 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 aCompressedArray
instance thencfdm.CompressedArray(source=x)
is equivalent tox.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
Returns a numpy array containing the uncompressed data. 

Returns an independent numpy array with the compressed data. 

Datatype of the uncompressed data. 

Number of array dimensions. 

Shape of the uncompressed data. 

Number of elements in the array. 
Compression¶
Methods
Mapping of compressed to uncompressed dimensions. 

Return axes that are compressed in the underlying array. 

Returns the compressed dimension’s position in the array. 

Returns the array’s compression type. 

Create the subarray shapes along each uncompressed dimension. 

Return descriptors for every subarray. 

Return the Subarray class. 

The data as required by the decompression algorithm. 
Miscellaneous¶
Methods
Return a deep copy of the array. 

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

Return the underlying array object. 

Bring data on disk into memory. 



Return the names of any files containing the compressed data. 
Special¶
Methods
The numpy array interface. 

Called by the 

Return a subspace of the uncompressed subarray. 

Called by the 

Called by the 
Docstring substitutions¶
Methods
Return the special docstring substitutions. 

Returns the substitutions that apply to methods of the class. 

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

Returns method names excluded in the class substitutions. 