cfdm.CompressedArray.get_compressed_dimension

CompressedArray.get_compressed_dimension(default=ValueError())

Returns the compressed dimension’s position in the array.

New in version (cfdm): 1.7.0

See also

get_compressed_axes, get_compression_type

Parameters

default: optional

Return the value of the default parameter if the underlying array is not compressed. If set to an Exception instance then it will be raised instead.

Returns

int

The position of the compressed dimension in the compressed array. If the underlying is not compressed then default is returned, if provided.

Examples

>>> i = d.get_compressed_dimension()