cfdm.GatheredArray¶
-
class
cfdm.
GatheredArray
(compressed_array=None, shape=None, size=None, ndim=None, compressed_dimension=None, list_variable=None)[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.
New in version 1.7.0.
Initialization
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 CF-netCDF list variable.
- compressed_array:
Inspection¶
Methods
get_compressed_axes |
Return axes that are compressed in the underlying array. |
get_compressed_dimension |
Return the position of the compressed dimension in the compressed array. |
get_compression_type |
The type of compression that has been applied to the underlying array. |
get_list |
Return the list variable for a compressed array. |
Attributes
array |
Return an independent numpy array containing the uncompressed data. |
compressed_array |
Return an independent numpy array containing the compressed data. |
dtype |
Data-type of the data elements. |
ndim |
The number of dimensions of the uncompressed data. |
shape |
Shape of the uncompressed data. |
size |
Number of elements in the uncompressed data. |
Special¶
Methods
__array__ |
The numpy array interface. |
__deepcopy__ |
Called by the copy.deepcopy function. |
__getitem__ |
x.__getitem__(indices) <==> x[indices] |
__repr__ |
Called by the repr built-in function. |
__str__ |
Called by the str built-in function. |