geovista.geometry#

Provide Natural Earth geometry support.

Notes#

Added in version 0.1.0.

Module Contents#

Functions#

coastlines([resolution, radius, zlevel, zscale])

Create or fetch the cached mesh of the coastlines.

load_coastline_geometries([resolution])

Download Natural Earth coastline shapefile for the required resolution.

load_coastlines([resolution, radius, zlevel, zscale])

Create a mesh of coastline geometries at the specified resolution.

geovista.geometry.coastlines(resolution=None, radius=None, zlevel=None, zscale=None)[source]#

Create or fetch the cached mesh of the coastlines.

Parameters:
resolutionstr, optional

The resolution of the Natural Earth coastlines, which may be either 110m, 50m, or 10m. Defaults to geovista.common.COASTLINES_RESOLUTION.

radiusfloat, optional

The radius of the sphere. Defaults to geovista.common.RADIUS.

zlevelint, default=1

The z-axis level. Used in combination with the zscale to offset the radius by a proportional amount i.e., radius * zlevel * zscale.

zscalefloat, optional

The proportional multiplier for z-axis zlevel. Defaults to geovista.common.ZLEVEL_SCALE.

Returns:
PolyData

A mesh of the coastlines.

Notes

Added in version 0.1.0.

geovista.geometry.load_coastline_geometries(resolution=None)[source]#

Download Natural Earth coastline shapefile for the required resolution.

If the geometries are not already available within the cartopy cache, then they will be downloaded.

The 2-D longitude (φ) and latitude (λ) xy coastline geometries will be unpacked as 3-D xy0 coordinates i.e., φλ0.

Parameters:
resolutionstr, optional

The resolution of the Natural Earth coastlines, which may be either 110m, 50m or 10m. Defaults to geovista.common.COASTLINES_RESOLUTION.

Returns:
list of np.ndarray

A list containing one or more coastline xy0 geometries.

Notes

Added in version 0.1.0.

geovista.geometry.load_coastlines(resolution=None, radius=None, zlevel=None, zscale=None)[source]#

Create a mesh of coastline geometries at the specified resolution.

Parameters:
resolutionstr, optional

The resolution of the Natural Earth coastlines, which may be either 110m, 50m, or 10m. Default to geovista.common.COASTLINES_RESOLUTION.

radiusfloat, optional

The radius of the sphere. Defaults to geovista.common.RADIUS.

zlevelint, default=0

The z-axis level. Used in combination with the zscale to offset the radius by a proportional amount i.e., radius * zlevel * zscale.

zscalefloat, optional

The proportional multiplier for z-axis zlevel. Defaults to geovista.common.ZLEVEL_SCALE.

Returns:
PolyData

A mesh of the coastlines.

Notes

Added in version 0.1.0.

Calls load_coastline_geometries() to download the original coastline geometries.