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.
 compressed_array: subclass of
Inspection¶
Attributes
Returns a numpy array containing the uncompressed data. 

Returns an independent numpy array with the compressed data. 

Datatype of the data elements. 

The number of dimensions of the uncompressed data. 

Shape of the uncompressed data. 

Number of elements in the uncompressed data. 
Compression¶
Methods
Return axes that are compressed in the underlying array. 

Returns the compressed dimension’s position in the array. 

Returns the array’s compression type. 
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 an array on disk into memory and retain it there. 
Special¶
Methods
The numpy array interface. 

Called by the 

Return a subspace as an independent numpy array. 

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. 