cfdm.Data.get_compressed_dimension

Data.get_compressed_dimension(default=ValueError())[source]

Returns the compressed dimension’s array position.

That is, returns the position of the compressed dimension in the compressed array.

New in version (cfdm): 1.7.0

Parameters
default: optional

Return the value of the default parameter there is no compressed dimension. If set to an Exception instance then it will be raised instead.

Returns
int

The position of the compressed dimension in the compressed array.

Examples:

>>> d.get_compressed_dimension()
2