cf.GatheredArray¶

class
cf.
GatheredArray
(compressed_array=None, shape=None, size=None, ndim=None, compressed_dimension=None, list_variable=None)[source]¶ Bases:
cfdm.data.gatheredarray.GatheredArray
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.
New in version 3.0.0.
Initialisation
 Parameters
 compressed_array:
Data
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.
 list_variable:
List
The “list variable” required to uncompress the data, identical to the data of a CFnetCDF list variable.
 compressed_array:
Inspection¶
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. 

Return the list variable for a compressed array. 

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

Return the underlying array object. 
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. 
Miscellaneous¶
Methods
Return a deep copy of the array. 

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

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