unifhy.BritishNationalGrid.is_space_equal_to

BritishNationalGrid.is_space_equal_to(field, ignore_z=False)

Compare equality between the BritishNationalGrid and the spatial (X, Y, and Z) dimension coordinate in a cf.Field.

The coordinate values, the bounds, the units, and the coordinate conversion and its datum of the field are compared against those of the BritishNationalGrid.

Parameters

field: cf.Field

The field that needs to be compared against BritishNationalGrid.

ignore_z: bool, optional

Option to ignore the dimension coordinate along the Z axis. If not provided, set to default False (i.e. Z is not ignored).

Returns

bool