cf.RaggedIndexedArray


class cf.RaggedIndexedArray(compressed_array=None, shape=None, size=None, ndim=None, index_variable=None)[source]

Bases: cf.data.abstract.compressedarray.CompressedArray, cfdm.data.raggedindexedarray.RaggedIndexedArray

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.

New in version 3.0.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

index_variable: Index

The index variable required to uncompress the data, corresponding to a CF-netCDF index variable.

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_index Return the index variable for a compressed array.
get_subspace Return a subspace, defined by indices, of a numpy array.
source TODO Return the underlying array object.

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.

Miscellaneous

Methods

copy Return a deep copy of the array.
get_subspace Return a subspace, defined by indices, of a numpy array.
to_memory TODO