cfdm.Field.uncompress

Field.uncompress(inplace=False)[source]

Uncompress the field 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.

The field construct data is uncompressed, along with any applicable metadata constructs.

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

A field construct that is already uncompressed will be returned uncompressed.

The compression type can be discovered by the get_compression_type method of the data:

The following types of compression can be uncompressed:

  • Compression type 'ragged_contiguous': Contiguous ragged array representation for DSG “point”, “timeSeries”, “trajectory” or “profile” features.

  • Compression type 'ragged_indexed': Indexed ragged array representation for DSG “point”, “timeSeries”, “trajectory”, or “profile” features.

  • Compression type 'ragged_indexed_contiguous': Indexed contiguous ragged array representation for DSG “timeSeriesProfile”, or “trajectoryProfile” features.

  • Compression type 'gathered': Compression by gathering over any subset of the field construct data dimensions.

New in version (cfdm): 1.7.11

See also

compress

Parameters
inplace: bool, optional

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

Returns
Field or None

The uncompressed field 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