API reference
This page provides an auto-generated summary of regionmask’s API.
Top-level functions
|
create a 2D float mask of a set of regions for the given lat/ lon grid |
|
create a 3D boolean mask of a set of regions for the given lat/ lon grid |
|
Create |
|
flatten 3D masks |
|
flatten and plot 3D masks |
|
Set options for regionmask in a controlled context. |
Get options for regionmask. |
Regions
Creating Regions
|
class for plotting regions and creating region masks |
Mapping Number/ Abbreviation/ Name
|
map from names and abbrevs of the regions to numbers |
Selecting
subset of Regions or Region |
Plotting
|
plot region on cartopy axes |
|
plot regions on regular axes |
Creating a Mask
|
create a 2D float mask of a set of regions for the given lat/ lon grid |
|
create a 3D boolean mask of a set of regions for the given lat/ lon grid |
|
create a 3D fractional mask of a set of regions for the given lat/ lon grid |
Conversion
Convert this region into a pandas.DataFrame, excluding polygons. |
|
Convert this region into a geopandas.GeoDataFrame. |
|
Convert this region into a geopandas.GeoSeries. |
|
|
Convert a |
Attributes
list of abbreviations of the regions |
|
list of names of the regions |
|
list of the numbers of the regions |
|
list of shapely Polygon/ MultiPolygon of the regions |
|
list of the center of mass of the regions |
|
list of the bounds of the regions (min_lon, min_lat, max_lon, max_lat) |
|
global bounds over all regions (min_lon, min_lat, max_lon, max_lat) |
|
if the regions extend from -180 to 180 |
|
if the regions extend from 0 to 360 |
_OneRegion
Creating one Region
|
a single Region, used as member of |
Attributes
numpy array of the region |
|
bounds of the regions (Multi)Polygon.bounds (min_lon, min_lat, max_lon, max_lat) |
Private Functions
wrap angle to [0, 360[. |
|
wrap angle to [-180, 180[. |
|
|
wrap the angle to the other base |
|