pyguymer3.geo.add_GSHHG_map_underlay¶

pyguymer3.geo.add_GSHHG_map_underlay(ax, /, *, background=True, debug=True, fov=None, iceOcean=True, islandLake=True, lakeLand=True, landOcean=True, linewidth=0.5, onlyValid=False, pondIsland=True, repair=False, resolution='i')[source]¶

Add an underlay to a Cartopy axis from the Global Self-Consistent Hierarchical High-Resolution Geography dataset

Parameters:

ax (cartopy.mpl.geoaxes.GeoAxesSubplot) – the axis
background (bool, optional) – add background
debug (bool, optional) – print debug messages
fov (None or shapely.geometry.polygon.Polygon, optional) – clip the plotted shapes to the provided field-of-view to work around occaisional MatPlotLib or Cartopy plotting errors when shapes much larger than the field-of-view are plotted
iceOcean (bool, optional) – add ice-ocean boundaries
islandLake (bool, optional) – add island-lake boundaries
lakeLand (bool, optional) – add lake-land boundaries
landOcean (bool, optional) – add land-ocean boundaries
linewidth (float, optional) – the linewidth to draw the boundaries with
onlyValid (bool, optional) – only return valid Polygons (checks for validity can take a while, if being called often)
pondIsland (bool, optional) – add pond-island boundaries
repair (bool, optional) – attempt to repair invalid Polygons
resolution (str, optional) – the resolution of the boundaries

Notes

There is one argument relating to the Global Self-Consistent Hierarchical High-Resolution Geography dataset :

resolution.

There are five resolutions to choose from:

crude (“c”);
low (“l”);
intermediate (“i”);
high (“h”); and
full (“f”).

References