cfdm.GatheredSubarray

---

class cfdm.GatheredSubarray(data=None, indices=None, shape=None, compressed_dimensions=None, uncompressed_indices=None, source=None, copy=True, context_manager=None)

Bases: Subarray

A subarray of an array compressed by gathering.

A subarray describes a unique part of the uncompressed array.

See CF section 8.2. “Lossless Compression by Gathering”.

Added in version (cfdm): 1.10.0.0

Initialisation

Parameters:

data: array_like

The full compressed array spanning all subarrays, from which the elements for this subarray are defined by the indices.

indices: tuple of slice

The indices of data that define this subarray.

shape: tuple of int

The shape of the uncompressed subarray.

compressed_dimensions: dict

Mapping of compressed to uncompressed dimensions.

A dictionary key is a position of a dimension in the compressed data, with a value of the positions of the corresponding dimensions in the uncompressed data. Compressed array dimensions that are not compressed must be omitted from the mapping.

Parameter example:

{2: (2,)}

Parameter example:

{1: (1, 2)}

Parameter example:

{0: (0, 1, 2)}

uncompressed_indices: tuple

Indices of the uncompressed subarray for the compressed data.

source: optional

Convert source, which can be any type of object, to a GatheredSubarray instance.

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the GatheredSubarray 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 a GatheredSubarray instance then cfdm.GatheredSubarray(source=x) is equivalent to x.copy().

copy: bool, optional

If True (the default) then deep copy the input parameters prior to initialisation. By default the parameters are not deep copied.

context_manager: function, optional

A context manager that provides a runtime context for the conversion of data to a numpy array.

Methods

Methods

Units	The Units object containing the units of the array.
array	Return an independent numpy array containing the data.
astype	Cast the data to a specified type.
compressed_dimensions	Mapping of compressed to uncompressed dimensions.
copy	Return a deep copy of the array.
data	The full compressed array spanning all subarrays.
dtype	The data-type of the uncompressed data.
get_attributes	The attributes of the array.
get_calendar	The calendar of the array.
get_compression_type	Returns the array's compression type.
get_filename	Return the name of the file containing the data.
get_units	The units of the array.
indices	The indices of the data that define this subarray.
ndim	Number of array dimensions.
shape	The shape of the uncompressed data.
size	Number of elements in the array.
uncompressed_indices	Indices of the uncompressed subarray for the compressed data.