check_coords

check_coords(
    patch1 ,
    patch2 ,
    check_behavior: Literal[‘warn’, ‘raise’, ‘ignore’] = raise,
    dim_to_ignore = None,
    ignore_dim_eq_shape = True,
    riders_vary: bool = False,
)-> ‘bool’

Return True if the coordinates of two patches are compatible, else False.

Parameters

Parameter	Description
patch1	patch 1
patch2	patch 2
check_behavior	String with ‘raise’ will raise an error if incompatible, ‘warn’ will provide a warning.
dim_to_ignore	None by default (all coordinates must be identical). String specifying a dimension that differences in values, but not shape, are allowed. A coordinate attached to different dimensions in the two patches is never compatible.
riders_vary	If True, coordinates riding `dim_to_ignore` are allowed the same differences as the dimension, for an operation which joins them along it (concatenation); stacking keeps the first patch’s.
ignore_dim_eq_shape	If True, the ignored dims must be equal shape to pass check. If dim_to_ignore is None this has no effect.