API reference¶
This page provides an auto-generated summary of regionmask’s API.
Top-level functions¶
|
create the mask of a list of regions, given the lat and lon coords |
|
create a grid as mask of a set of regions for given lat/ lon grid |
|
Create |
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 map with with region outlines |
|
plot map with with srex regions |
Creating a Mask¶
|
create a grid as mask of a set of regions for given lat/ lon grid |
Attributes¶
list of abbreviations of the regions |
|
list of names of the regions |
|
list of the numbers of the regions |
|
dictionary that maps all names and abbrevs to the region number |
|
list of coordinates of the region vertices as numpy array |
|
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 |
|
is there at least one region was passed as (Multi)Polygon |
_OneRegion¶
Creating one Region¶
|
a single Region, used as member of ‘Regions’ |
Attributes¶
numpy array of the region |
|
shapely Polygon or MultiPolygon 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 |
|