regionmask.mask_geopandas

regionmask.mask_geopandas(geodataframe, lon_or_obj, lat=None, lon_name='lon', lat_name='lat', numbers=None, method=None, wrap_lon=None)

create a grid as mask of a set of regions for given lat/ lon grid

Parameters

  • geodataframe (GeoDataFrame or GeoSeries) – Object providing the region definitions (outlines).

  • lon_or_obj (object or array_like) – Can either be a longitude array and then lat needs to be given. Or an object where the longitude and latitude can be retrived as: lon = lon_or_obj[lon_name] and lat = lon_or_obj[lat_name]

  • lat (array_like, optional) – If lon_or_obj is a longitude array, the latitude needs to be specified here.

  • lon_name (str, optional) – Name of longitude in ‘lon_or_obj’. Default: ‘lon’.

  • lat_name (str, optional) – Name of latgitude in ‘lon_or_obj’. Default: ‘lat’.

  • numbers (str, optional) – Name of the column to use for numbering the regions. This column must not have duplicates. If None (default), takes geodataframe.index.values.

  • method (None | "rasterize" | "shapely") – Method used to determine whether a gridpoint lies in a region. Both methods should lead to the same result. If None (default) automatically choosen depending on the grid spacing.

  • wrap_lon (None | bool | 180 | 360, optional) – Whether to wrap the longitude around, inferred automatically. If the regions and the provided longitude do not have the same base (i.e. one is -180..180 and the other 0..360) one of them must be wrapped. If wrap_lon is None autodetects whether the longitude needs to be wrapped. If wrap_lon is False, nothing is done. If wrap_lon is True, longitude data is wrapped to 360 if its minimum is smaller than 0 and wrapped to 180 if its maximum is larger than 180.

Returns

mask (ndarray or xarray DataArray)

References

See https://regionmask.readthedocs.io/en/stable/notebooks/method.html