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 then cfdm.RaggedContiguousArray(source=source) is equivalent to source.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

compressed_dimensions

Mapping of compressed to uncompressed dimensions.

get_compressed_axes

Return axes that are compressed in the underlying array.

get_compressed_dimension

Returns the compressed dimension’s position in the array.

get_compression_type

Returns the array’s compression type.

get_count

Return the count variable for the compressed array.

Attributes

array

Returns a numpy array containing the uncompressed data.

compressed_array

Returns an independent numpy array with the compressed data.

dtype

Data-type of the uncompressed data.

ndim

Number of array dimensions.

shape

Shape of the uncompressed data.

size

Number of elements in the array.

Miscellaneous

Methods

copy

Return a deep copy of the array.

get_subspace

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

source

Return the underlying array object.

to_memory

Bring data on disk into memory.

subarray_shapes

Create the subarray shapes along each uncompressed dimension.

subarrays

Return descriptors for every subarray.

get_Subarray

Return the Subarray class.

conformed_data

The data as required by the decompression algorithm.

get_index

Return the index variable for the compressed array.

Special

Methods

__array__

The numpy array interface.

__deepcopy__

Called by the copy.deepcopy function.

__getitem__

Return a subspace of the uncompressed data.

__repr__

Called by the repr built-in function.

__str__

Called by the str built-in function.

Docstring substitutions

Methods

_docstring_special_substitutions

Return the special docstring substitutions.

_docstring_substitutions

Returns the substitutions that apply to methods of the class.

_docstring_package_depth

Returns the class {{package}} substitutions package depth.

_docstring_method_exclusions

Returns method names excluded in the class substitutions.