cf.FieldList.equivalent_domain

FieldList.equivalent_domain(other, rtol=None, atol=None, traceback=False)[source]

Return True if two fields have equivalent data domains.

Parameters:

other : cf.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.

traceback : bool, optional

If True then print a traceback highlighting where the two domains differ.

Returns:
out : bool

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

Examples:
>>> f.equivalent_domain(g)

Previous topic

cf.FieldList.equivalent_data

Next topic

cf.FieldList.binary_mask

This Page