cf.RaggedIndexedContiguousArray


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

Bases: cfdm.data.raggedindexedcontiguousarray.RaggedIndexedContiguousArray

An underlying indexed contiguous ragged array.

A collection of features, each of which is sequence of (vertical) profiles, stored using an indexed contiguous ragged array combines all feature elements along a single dimension (the “sample dimension”) such that a contiguous ragged array representation is used for each profile and the indexed ragged array representation to organise the profiles into timeseries.

The information needed to uncompress the data is stored in a “count variable” that gives the size of each profile; and in a “index variable” that specifies the feature that each profile 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

count_variable: Count

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

index_variable: Index

The index variable required to uncompress the data, corresponding to a CF-netCDF 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_count

Return the count variable for a compressed array.

get_index

Return the index variable for a compressed array.

get_subspace

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

source

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

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