cf.FieldAncillary.uncompress

FieldAncillary.uncompress(*args, **kwargs)[source]

Uncompress the construct.

Compression saves space by identifying and removing unwanted missing data. Such compression techniques store the data more efficiently and result in no precision loss.

Whether or not the construct is compressed does not alter its functionality nor external appearance.

A construct that is already uncompressed will be returned uncompressed.

The following type of compression are available:

  • Ragged arrays for discrete sampling geometries (DSG). Three different types of ragged array representation are supported.

  • Compression by gathering.

New in version (cfdm): 1.7.11

Parameters
inplace: bool, optional

If True then do the operation in-place and return None.

Returns
FieldAncillary or None

The uncompressed construct, or None if the operation was in-place.

Examples:

>>> f.data.get_compression_type()
'ragged contiguous'
>>> g = f.uncompress()
>>> g.data.get_compression_type()
''
>>> g.equals(f)
True