cfdm.RaggedIndexedArray¶

class
cfdm.
RaggedIndexedArray
(compressed_array=None, shape=None, size=None, ndim=None, index_variable=None, source=None, copy=True)[source]¶ Bases:
cfdm.data.abstract.raggedarray.RaggedArray
An underlying indexed ragged array.
A collection of features stored using an indexed ragged array combines all features along a single dimension (the “sample dimension”) such that the values of each feature in the collection are interleaved.
The information needed to uncompress the data is stored in an “index variable” that specifies the feature that each element of the sample dimension belongs to.
It is assumed that the compressed dimension is the leftmost 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 array.
 shape:
tuple
The shape of the uncompressed array.
 index_variable:
Index
The index variable required to uncompress the data, corresponding to a CFnetCDF index variable.
 source: optional
Convert source, which can be any type of object, to a
RaggedIndexedArray
instance.All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the
RaggedIndexedArray
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 aRaggedIndexedArray
instance thencfdm.RaggedIndexedArray(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 index variable for the compressed array. 
Attributes
Returns a numpy array containing the uncompressed data. 

Returns an independent numpy array with the compressed data. 

Datatype 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 count variable for the compressed array. 



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. 