regionate.grid_conform.mask_from_grid_boundaries¶

regionate.grid_conform.mask_from_grid_boundaries(lons_c, lats_c, grid, along_boundary=False, coordnames={'h': ('geolon', 'geolat')})[source]¶

Find mask bounded by a sequence of cell corner coordinates

Parameters:

longitudes (lons_c [list or np.ndarray] -- cell corner)
latitudes (lats_c [list or np.ndarray] -- cell corner)
grid (grid [xgcm.Grid] -- ocean model)

Returns:

region_grid_mask

Return type:

np.ndarray of bool type