cfdm.CompressedArray.subarrays

CompressedArray.subarrays(shapes=-1)

Return descriptors for every subarray.

Theses descriptors are used during subarray decompression.

New in version (cfdm): 1.10.0.0

Parameters

chunks: -1 or sequence, optional

Define the subarray shapes.

Must be either -1, the default, meaning that all non-compressed dimensions in each subarray have the maximum possible size; or a sequence of tuple. In the latter case chunks must be allowed as an input to subarray_shapes.

A valid chunks specification may always be found by normalising an output of subarray_shapes with dask.array.core.normalize_chunks as follows: chunks = dask.array.core.normalize_chunks(a.subarray_shapes(...), shape=a.shape, dtype=a.dtype).

Returns

sequence of iterable

Each iterable iterates over a particular descriptor from each subarray.