cfdm.RaggedContiguousArray¶
-
class
cfdm.
RaggedContiguousArray
(compressed_array=None, shape=None, size=None, ndim=None, count_variable=None, source=None, copy=True)[source]¶ Bases:
cfdm.data.abstract.raggedarray.RaggedArray
An underlying contiguous ragged array.
A collection of features stored using a contiguous ragged array combines all features along a single dimension (the “sample dimension”) such that each feature in the collection occupies a contiguous block.
The information needed to uncompress the data is stored in a “count variable” that gives the size of each block.
It is assumed that the compressed dimension is the left-most dimension in the compressed array.
See CF section 9 “Discrete Sampling Geometries”.
New in version (cfdm): 1.7.0
Initialisation
- Parameters
- compressed_array: array_like
The compressed data.
- shape:
tuple
The shape of the uncompressed array.
- count_variable:
Count
The count variable required to uncompress the data, corresponding to a CF-netCDF count variable.
- source: optional
Initialise the array from the given object.
Note that if source is a
RaggedContiguousArray
instance thencfdm.RaggedContiguousArray(source=source)
is equivalent tosource.copy()
.New in version (cfdm): 1.10.0.0
- copy:
bool
, optional If True (the default) then deep copy input parameters prior to initialisation, else they 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 count variable for the compressed array. |
Attributes
Returns a numpy array containing the uncompressed data. |
|
Returns an independent numpy array with the compressed data. |
|
Data-type of the uncompressed data. |
|
Number of array dimensions. |
|
Shape of the uncompressed data. |
|
Number of elements in 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. |
|
Return descriptors for every subarray. |
|
Return the Subarray class. |
|
The data as required by the decompression algorithm. |
|
Return the index variable for the compressed array. |
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. |