cf.Field.get_quantization

Field.get_quantization(default=ValueError())[source]

Get quantization metadata.

Quantization eliminates false precision, usually by rounding the least significant bits of floating-point mantissas to zeros, so that a subsequent compression on disk is more efficient.

Quantization metadata describes any existing quantization that has already been applied to the data.

Added in version (cfdm): 1.12.2.0

See also

_del_quantization, _set_quantization, get_quantize_on_write

Parameters:
default: optional

Return the value of the default keyword if there is no quantization metadata.

If set to an Exception instance then it will be raised instead.

Returns:
Quantization

A copy of quantization metadata.

Examples

>>> f.get_quantization()
<CF Quantization: algorithm=bitgroom, quantization_nsd=4>
>>> q = f._del_quantization()
>>> print(f.get_quantization(None))
None
>>> f._set_quantization(q)
>>> f.get_quantization()
<CF Quantization: algorithm=bitgroom, quantization_nsd=4>