geovista.geoplotter

`geovista.geoplotter`#

Provide specialisation to support a geospatial aware plotter.

See pyvista.Plotter.

Notes#

Added in version 0.1.0.

Module Contents#

Classes#

`GeoPlotter`	A geospatial aware plotter.
`GeoPlotterBase`	Base class with common behaviour for a geospatial aware plotter.

Attributes#

`ADD_POINTS_STYLE`	The valid 'style' options for adding points.
`BASE_ZLEVEL_SCALE`	Proportional multiplier for z-axis levels/offsets of base-layer mesh.
`COASTLINES_RTOL`	Coastlines relative tolerance for values close to longitudinal wrap base + period.
`GRATICULE_LABEL_FONT_SIZE`	The default font size for graticule labels.
`GRATICULE_SHOW_LABELS`	Whether to rendering graticule labels by default.
`OPACITY_BLACKLIST`	Known GPU renderer and version combinations that don't support opacity.

class geovista.geoplotter.GeoPlotter(*args, crs=None, **kwargs)[source]#

Bases: GeoPlotterBase, pv

A geospatial aware plotter.

See geovista.geoplotter.GeoPlotterBase and pyvista.Plotter.

Notes#

Added in version 0.1.0.

Create geospatial aware plotter.

Parameters:

*argstuple, optional: See pyvista.Plotter for further details.
crsstr or CRSLike, optional: The target CRS to render geolocated meshes added to the plotter.
**kwargsdict, optional: See pyvista.Plotter for further details.

Notes

Added in version 0.1.0.

class geovista.geoplotter.GeoPlotterBase(*args, crs=None, **kwargs)[source]#

Base class with common behaviour for a geospatial aware plotter.

See pyvista.Plotter.

Notes#

Added in version 0.1.0.

Create geospatial aware plotter.

Parameters:

*argstuple, optional: See pyvista.Plotter for further details.
crsstr or CRSLike, optional: The target CRS to render geolocated meshes added to the plotter.
**kwargsdict, optional: See pyvista.Plotter for further details.

Notes

Added in version 0.1.0.

add_base_layer(mesh=None, resolution=None, radius=None, zlevel=None, zscale=None, rtol=None, atol=None, **kwargs)[source]#

Generate a cubed-sphere base layer mesh and add to the plotter scene.

Optionally, a mesh may be provided, which better fits the geometry of the surface mesh.

Parameters:

meshPolyData, optional: Use the provided mesh as the base layer.
resolutionstr, optional: The resolution of the cubed-sphere to generate as the base layer, which may be either c48, c96 or c192. Defaults to geovista.pantry.meshes.LFRIC_RESOLUTION. Alternatively, generate a regular grid using a format of rN, where N is the number of cells in latitude, and N * 1.5 cells in longitude. When adding a base layer to a projection, the default is to use a regular grid with resolution geovista.pantry.meshes.REGULAR_RESOLUTION.
radiusfloat, optional: The radius of the spherical mesh to generate as the base layer. 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 BASE_ZLEVEL_SCALE.
rtolfloat, optional: The relative tolerance for values close to longitudinal geovista.common.wrap() base + period.
atolfloat, optional: The absolute tolerance for values close to longitudinal geovista.common.wrap() base + period.
**kwargsdict, optional: See pyvista.Plotter.add_mesh().

Returns:

Actor: The rendered actor added to the plotter scene.

Notes

Added in version 0.1.0.

add_coastlines(resolution=None, radius=None, zlevel=None, zscale=None, rtol=None, atol=None, **kwargs)[source]#

Generate coastlines and add to the plotter scene.

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.
rtolfloat, optional: The relative tolerance for values close to longitudinal geovista.common.wrap() base + period.
atolfloat, optional: The absolute tolerance for values close to longitudinal geovista.common.wrap() base + period.
**kwargsdict, optional: See pyvista.Plotter.add_mesh().

Returns:

Actor: The rendered actor added to the plotter scene.

Notes

Added in version 0.1.0.

add_graticule(lon_start=None, lon_stop=None, lon_step=None, lat_start=None, lat_stop=None, lat_step=None, poles_parallel=None, poles_label=None, show_labels=None, radius=None, zlevel=None, zscale=None, mesh_args=None, point_labels_args=None)[source]#

Generate a graticule and add to the plotter scene.

This involves generating lines of constant latitude (parallels) and lines of constant longitude (meridians), which together form the graticule.

Parameters:

lon_startfloat, optional: The first line of longitude (degrees). The graticule will include this meridian. Defaults to geovista.gridlines.LONGITUDE_START.
lon_stopfloat, optional: The last line of longitude (degrees). The graticule will include this meridian when it is a multiple of lon_step. Also see closed_interval. Defaults to geovista.gridlines.LONGITUDE_STOP.
lon_stepfloat, optional: The delta (degrees) between neighbouring meridians. Defaults to geovista.gridlines.LONGITUDE_STEP.
lat_startfloat, optional: The first line of latitude (degrees). The graticule will include this parallel. Also see poles_parallel. Defaults to geovista.gridlines.LATITUDE_START.
lat_stopfloat, optional: The last line of latitude (degrees). The graticule will include this parallel when it is a multiple of lat_step. Defaults to geovista.gridlines.LATITUDE_STOP.
lat_stepfloat, optional: The delta (degrees) between neighbouring parallels. Defaults to geovista.gridlines.LATITUDE_STEP.
poles_parallelbool, optional: Whether to create a line of latitude at the north/south poles. Defaults to geovista.gridlines.LATITUDE_POLES_PARALLEL.
poles_labelbool, optional: Whether to create a single north/south pole label. Only applies when poles_parallel=False. Defaults to geovista.gridlines.LATITUDE_POLES_LABEL.
show_labelsbool, optional: Whether to render the labels of the parallels and meridians. Defaults to GRATICULE_SHOW_LABELS.
radiusfloat, optional: The radius of the sphere. Defaults to geovista.common.RADIUS.
zlevelint, optional: The z-axis level. Used in combination with the zscale to offset the radius by a proportional amount i.e., radius * zlevel * zscale. Defaults to geovista.gridlines.GRATICULE_ZLEVEL.
zscalefloat, optional: The proportional multiplier for z-axis zlevel. Defaults to geovista.common.ZLEVEL_SCALE.
mesh_argsdict, optional: Arguments to pass through to pyvista.Plotter.add_mesh().
point_labels_argsdict, optional: Arguments to pass through to pyvista.Plotter.add_point_labels().

Notes

Added in version 0.3.0.

add_meridian(lon, lat_step=None, n_samples=None, show_labels=None, radius=None, zlevel=None, zscale=None, mesh_args=None, point_labels_args=None)[source]#

Generate a line of constant longitude and add to the plotter scene.

Parameters:

lonfloat: The constant line of longitude (degrees) to generate.
lat_stepfloat, optional: The delta (degrees) between neighbouring parallels. Defaults to geovista.gridlines.LATITUDE_STEP.
n_samplesint, optional: The number of points in a single line of longitude. Defaults to geovista.gridlines.LONGITUDE_N_SAMPLES.
show_labelsbool, optional: Whether to render the meridian label. Defaults to GRATICULE_SHOW_LABELS.
radiusfloat, optional: The radius of the sphere. Defaults to geovista.common.RADIUS.
zlevelint, optional: The z-axis level. Used in combination with the zscale to offset the radius by a proportional amount i.e., radius * zlevel * zscale. Defaults to geovista.gridlines.GRATICULE_ZLEVEL.
zscalefloat, optional: The proportional multiplier for z-axis zlevel. Defaults to geovista.common.ZLEVEL_SCALE.
mesh_argsdict, optional: Arguments to pass through to pyvista.Plotter.add_mesh().
point_labels_argsdict, optional: Arguments to pass through to pyvista.Plotter.add_point_labels().

Notes

Added in version 0.3.0.

add_meridians(start=None, stop=None, step=None, lat_step=None, n_samples=None, show_labels=None, radius=None, zlevel=None, zscale=None, mesh_args=None, point_labels_args=None)[source]#

Generate lines of constant longitude and add to the plotter scene.

Parameters:

startfloat, optional: The first line of longitude (degrees). The graticule will include this meridian. Defaults to geovista.gridlines.LONGITUDE_START.
stopfloat, optional: The last line of longitude (degrees). The graticule will include this meridian when it is a multiple of step. Also see closed_interval. Defaults to geovista.gridlines.LONGITUDE_STOP.
stepfloat, optional: The delta (degrees) between neighbouring meridians. Defaults to geovista.gridlines.LONGITUDE_STEP.
lat_stepfloat, optional: The delta (degrees) between neighbouring parallels. Defaults to geovista.gridlines.LATITUDE_STEP.
n_samplesint, optional: The number of points in a single line of longitude. Defaults to geovista.gridlines.LONGITUDE_N_SAMPLES.
show_labelsbool, optional: Whether to render the labels of the meridians. Defaults to GRATICULE_SHOW_LABELS.
radiusfloat, optional: The radius of the sphere. Defaults to geovista.common.RADIUS.
zlevelint, optional: The z-axis level. Used in combination with the zscale to offset the radius by a proportional amount i.e., radius * zlevel * zscale. Defaults to geovista.gridlines.GRATICULE_ZLEVEL.
zscalefloat, optional: The proportional multiplier for z-axis zlevel. Defaults to geovista.common.ZLEVEL_SCALE.
mesh_argsdict, optional: Arguments to pass through to pyvista.Plotter.add_mesh().
point_labels_argsdict, optional: Arguments to pass through to pyvista.Plotter.add_point_labels().

Notes

Added in version 0.3.0.

add_mesh(mesh, radius=None, zlevel=None, zscale=None, rtol=None, atol=None, **kwargs)[source]#

Add the mesh to the plotter scene.

See pyvista.Plotter.add_mesh().

Parameters:

meshPolyData: The mesh to add to the plotter.
radiusfloat, optional: The radius of the sphere. Defaults to geovista.common.RADIUS.
zlevelint or ArrayLike, default=0: The z-axis level. Used in combination with the zscale to offset the radius/vertical by a proportional amount e.g., radius * zlevel * zscale. If zlevel is not a scalar, then its shape must match or broadcast with the shape of the mesh.points.
zscalefloat, optional: The proportional multiplier for z-axis zlevel. Defaults to geovista.common.ZLEVEL_SCALE.
rtolfloat, optional: The relative tolerance for values close to longitudinal geovista.common.wrap() base + period.
atolfloat, optional: The absolute tolerance for values close to longitudinal geovista.common.wrap() base + period.
**kwargsdict, optional: See pyvista.Plotter.add_mesh().

Returns:

Actor: The rendered actor added to the plotter scene.

Notes

Added in version 0.1.0.

add_parallel(lat, lon_step=None, n_samples=None, poles_parallel=None, show_labels=None, radius=None, zlevel=None, zscale=None, mesh_args=None, point_labels_args=None)[source]#

Generate a line of constant latitude and add to the plotter scene.

Parameters:

latfloat: The constant line of latitude (degrees) to generate.
lon_stepfloat, optional: The delta (degrees) between neighbouring meridians. Defaults to geovista.gridlines.LONGITUDE_STEP.
n_samplesint, optional: The number of points in a single line of latitude. Defaults to geovista.gridlines.LATITUDE_N_SAMPLES.
poles_parallelbool, optional: Whether to create a line of latitude at the north/south poles. Defaults to geovista.gridlines.LATITUDE_POLES_PARALLEL.
show_labelsbool, optional: Whether to render the parallel label. Defaults to GRATICULE_SHOW_LABELS.
radiusfloat, optional: The radius of the sphere. Defaults to geovista.common.RADIUS.
zlevelint, optional: The z-axis level. Used in combination with the zscale to offset the radius by a proportional amount i.e., radius * zlevel * zscale. Defaults to geovista.gridlines.GRATICULE_ZLEVEL.
zscalefloat, optional: The proportional multiplier for z-axis zlevel. Defaults to geovista.common.ZLEVEL_SCALE.
mesh_argsdict, optional: Arguments to pass through to pyvista.Plotter.add_mesh().
point_labels_argsdict, optional: Arguments to pass through to pyvista.Plotter.add_point_labels().

Notes

Added in version 0.3.0.

add_parallels(start=None, stop=None, step=None, lon_step=None, n_samples=None, poles_parallel=None, poles_label=None, show_labels=None, radius=None, zlevel=None, zscale=None, mesh_args=None, point_labels_args=None)[source]#

Generate lines of constant latitude and add to the plotter scene.

Parameters:

startfloat, optional: The first line of latitude (degrees). The graticule will include this parallel. Also see poles_parallel. Defaults to geovista.gridlines.LATITUDE_START.
stopfloat, optional: The last line of latitude (degrees). The graticule will include this parallel when it is a multiple of step. Also see poles_parallel. Defaults to geovista.gridlines.LATITUDE_STOP.
stepfloat, optional: The delta (degrees) between neighbouring parallels. Defaults to geovista.gridlines.LATITUDE_STEP.
lon_stepfloat, optional: The delta (degrees) between neighbouring meridians. Defaults to geovista.gridlines.LONGITUDE_STEP.
n_samplesint, optional: The number of points in a single line of latitude. Defaults to geovista.gridlines.LATITUDE_N_SAMPLES.
poles_parallelbool, optional: Whether to create a line of latitude at the north/south poles. Defaults to geovista.gridlines.LATITUDE_POLES_PARALLEL.
poles_labelbool, optional: Whether to create a single north/south pole label. Only applies when poles_parallel=False. Defaults to geovista.gridlines.LATITUDE_POLES_LABEL.
show_labelsbool, optional: Whether to render the labels of the parallels. Defaults to GRATICULE_SHOW_LABELS.
radiusfloat, optional: The radius of the sphere. Defaults to geovista.common.RADIUS.
zlevelint, optional: The z-axis level. Used in combination with the zscale to offset the radius by a proportional amount i.e., radius * zlevel * zscale. Defaults to geovista.gridlines.GRATICULE_ZLEVEL.
zscalefloat, optional: The proportional multiplier for z-axis zlevel. Defaults to geovista.common.ZLEVEL_SCALE.
mesh_argsdict, optional: Arguments to pass through to pyvista.Plotter.add_mesh().
point_labels_argsdict, optional: Arguments to pass through to pyvista.Plotter.add_point_labels().

Notes

Added in version 0.3.0.

add_points(points=None, xs=None, ys=None, scalars=None, crs=None, radius=None, style=None, zlevel=None, zscale=None, **kwargs)[source]#

Add points to the plotter scene.

See pyvista.Plotter.add_mesh().

Parameters:

pointsArrayLike or PolyData, optional: Array of xyz points, in canonical crs units, or the points of the mesh to be rendered.
xsArrayLike, optional: A 1-D, 2-D or 3-D array of point-cloud x-values, in canonical crs units. Must have the same shape as the ys.
ysArrayLike: A 1-D, 2-D or 3-D array of point-cloud y-values, in canonical crs units. Must have the same shape as the xs.
scalarsstr or ArrayLike, optional: Values used to color the points. Either, the string name of an array that is present on the points mesh or an array equal to the number of points. Alternatively, an array of values equal to the number of points to be rendered. If both color and scalars are None, then the active scalars on the points mesh are used.
crsCRSLike, optional: The Coordinate Reference System of the provided points, or xs and ys. May be anything accepted by pyproj.crs.CRS.from_user_input(). Defaults to EPSG:4326 i.e., WGS 84.
radiusfloat, optional: The radius of the mesh point-cloud. Defaults to geovista.common.RADIUS.
stylestr, optional: Visualization style of the points to be rendered. Maybe either points or points_gaussian. The points_gaussian option maybe controlled with the emissive and render_points_as_spheres options.
zlevelint or ArrayLike, 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. If zlevel is not a scalar, then its shape must match or broadcast with the shape of the xs and ys.
zscalefloat, optional: The proportional multiplier for z-axis zlevel. Defaults to geovista.common.ZLEVEL_SCALE.
**kwargsdict, optional: See pyvista.Plotter.add_mesh().

Returns:

Actor: The rendered actor added to the plotter scene.

Notes

Added in version 0.4.0.

geovista.geoplotter.ADD_POINTS_STYLE: list[str, str] = ['points', 'points_gaussian']#: The valid ‘style’ options for adding points.

geovista.geoplotter.BASE_ZLEVEL_SCALE: int = 0.001#: Proportional multiplier for z-axis levels/offsets of base-layer mesh.

geovista.geoplotter.COASTLINES_RTOL: float = 1e-08#: Coastlines relative tolerance for values close to longitudinal wrap base + period.

geovista.geoplotter.GRATICULE_LABEL_FONT_SIZE: int = 9#: The default font size for graticule labels.

geovista.geoplotter.GRATICULE_SHOW_LABELS: bool = True#: Whether to rendering graticule labels by default.

geovista.geoplotter.OPACITY_BLACKLIST = [('llvmpipe (LLVM 7.0, 256 bits)', '3.3 (Core Profile) Mesa 18.3.4')]#: Known GPU renderer and version combinations that don’t support opacity.

geovista.geoplotter

On this page

geovista.geoplotter#

Notes#

Module Contents#

Classes#

Attributes#

Notes#

Notes#

`geovista.geoplotter`#