cfdm.GatheredArray¶

class
cfdm.
GatheredArray
(compressed_array=None, shape=None, size=None, ndim=None, compressed_dimension=None, compressed_dimensions=None, list_variable=None, source=None, copy=True)[source]¶ Bases:
cfdm.data.abstract.compressedarray.CompressedArray
An underlying gathered array.
Compression by gathering combines axes of a multidimensional array into a new, discrete axis whilst omitting the missing values and thus reducing the number of values that need to be stored.
The information needed to uncompress the data is stored in a “list variable” that gives the indices of the required points.
See CF section 8.2 “Lossless Compression by Gathering”.
New in version (cfdm): 1.7.0
Initialisation
 Parameters
 compressed_array: array_like
The compressed array.
 shape:
tuple
The shape of the uncompressed array.
 compressed_dimensions:
dict
Mapping of compressed to uncompressed dimensions.
A dictionary key is a position of a dimension in the compressed data, with a value of the positions of the corresponding dimensions in the uncompressed data. Compressed array dimensions that are not compressed must be omitted from the mapping.
 Parameter example:
{2: (2, 3)}
New in version (cfdm): 1.10.0.0
 list_variable:
List
The “list variable” required to uncompress the data, identical to the data of a CFnetCDF list variable.
 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
GatheredArray
instance.All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the
GatheredArray
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 aGatheredArray
instance thencfdm.GatheredArray(source=x)
is equivalent tox.copy()
.New in version (cfdm): 1.10.0.0
 copy:
bool
, optional If True (the default) then deep copy the input parameters prior to initialisation. By default the parameters are not deep copied.
New in version (cfdm): 1.10.0.0
 size:
int
Deprecated at version 1.10.0.0. Ignored if set.
Number of elements in the uncompressed array.
 ndim:
int
Deprecated at version 1.10.0.0. Ignored if set.
The number of uncompressed array dimensions
Inspection¶
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. 

Return the list variable for a compressed array. 
Attributes
Returns a numpy array containing the uncompressed data. 

Returns an independent numpy array with the compressed data. 

The datatype of the uncompressed data. 

Number of array dimensions. 

Shape of the uncompressed data. 

Number of elements in the array. 
Units¶
Methods
The calendar of the array. 

The units of the array. 
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. 

Create the subarray shapes along each uncompressed dimension. 

Nondata parameters required by the 

Return descriptors for every subarray. 

Return the Subarray class. 

The compressed data and list variable. 



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 data. 

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. 