API reference

This page provides an auto-generated summary of regionmask’s API.

Top-level functions

`mask_geopandas`(geodataframe, lon_or_obj[, ...])	create a 2D float mask of a set of regions for the given lat/ lon grid
`mask_3D_geopandas`(geodataframe, lon_or_obj)	create a 3D boolean mask of a set of regions for the given lat/ lon grid
`from_geopandas`(geodataframe, *[, numbers, ...])	Create `regionmask.Regions` from a `geopandas.GeoDataFrame`.
`flatten_3D_mask`(mask_3D)	flatten 3D masks
`plot_3D_mask`(mask_3D, **kwargs)	flatten and plot 3D masks
`set_options`(**kwargs)	Set options for regionmask in a controlled context.
`get_options`()	Get options for regionmask.

Regions(outlines[, numbers, names, abbrevs, ...])

class for plotting regions and creating region masks

map from names and abbrevs of the regions to numbers

subset of Regions or Region

`Regions.plot`(*[, ax, projection, add_label, ...])	plot region on cartopy axes
`Regions.plot_regions`(*[, ax, add_label, ...])	plot regions on regular axes

`Regions.mask`(lon_or_obj[, lat, method, ...])	create a 2D float mask of a set of regions for the given lat/ lon grid
`Regions.mask_3D`(lon_or_obj[, lat, drop, ...])	create a 3D boolean mask of a set of regions for the given lat/ lon grid
`Regions.mask_3D_frac_approx`(lon_or_obj[, ...])	create a 3D fractional mask of a set of regions for the given lat/ lon grid

`Regions.to_dataframe`()	Convert this region into a pandas.DataFrame, excluding polygons.
`Regions.to_geodataframe`()	Convert this region into a geopandas.GeoDataFrame.
`Regions.to_geoseries`()	Convert this region into a geopandas.GeoSeries.
`Regions.from_geodataframe`(df, *[, name, ...])	Convert a `geopandas.GeoDataFrame` created with `to_geodataframe` back to `regionmask.Region` (round trip)

`Regions.abbrevs`	list of abbreviations of the regions
`Regions.names`	list of names of the regions
`Regions.numbers`	list of the numbers of the regions
`Regions.polygons`	list of shapely Polygon/ MultiPolygon of the regions
`Regions.centroids`	list of the center of mass of the regions
`Regions.bounds`	list of the bounds of the regions (min_lon, min_lat, max_lon, max_lat)
`Regions.bounds_global`	global bounds over all regions (min_lon, min_lat, max_lon, max_lat)
`Regions.lon_180`	if the regions extend from -180 to 180
`Regions.lon_360`	if the regions extend from 0 to 360

_OneRegion(number, name, abbrev, outline)

a single Region, used as member of Regions

`_OneRegion.coords`	numpy array of the region
`_OneRegion.bounds`	bounds of the regions (Multi)Polygon.bounds (min_lon, min_lat, max_lon, max_lat)

`core.utils._wrapAngle360`(lon)	wrap angle to [0, 360[.
`core.utils._wrapAngle180`(lon)	wrap angle to [-180, 180[.
`core.utils._wrapAngle`(lon[, wrap_lon, ...])	wrap the angle to the other base
`core.utils._is_180`(lon_min, lon_max, *[, ...])