cf.Field.equivalent_data

Field.equivalent_data(other, rtol=None, atol=None, traceback=False)[source]

Equivelence is defined as both fields having the same data arrays after accounting for different but equivalent units, size one dimensions, different dimension directions and different dimension orders.

Parameters :

other : Field

atol : float, optional

The absolute tolerance for all numerical comparisons, By default the value returned by the cf.ATOL function is used.

rtol : float, optional

The relative tolerance for all numerical comparisons, By default the value returned by the cf.RTOL function is used.

Returns :
out : bool

Whether or not the two fields’ data arrays are equivalent.

Examples

>>> f.equivalent_data(g)

Previous topic

cf.Field.equivalent

Next topic

cf.Field.expand_dims

This Page