cfdm.Data.get_index

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

Return the index variable for a compressed array.

New in version (cfdm): 1.7.0

See also

get_count, get_list

Parameters
default: optional

Return default if index variable has not been set.

default: optional

Return the value of the default parameter if an index variable has not been set. If set to an Exception instance then it will be raised instead.

Returns

The index variable.

Examples:

>>> i = d.get_index()