easyclimate.plot.mpas.vertex_contour¶

Contour plots for MPAS vertex data.

Functions¶

`plot_vertex_contourf`(ds, da, *[, ax, lon_min, ...])	Draw filled contour for MPAS vertex-centered scalar field.
`plot_vertex_contour`(ds, da, *[, ax, lon_min, lon_max, ...])	Draw contour lines for MPAS vertex-centered scalar field.

Module Contents¶

easyclimate.plot.mpas.vertex_contour.plot_vertex_contourf(ds, da, *, ax=None, lon_min=None, lon_max=None, lat_min=None, lat_max=None, auto_extent=True, extent_margin=0.05, contour_margin=0.05, global_plot=False, center_lon=None, levels=10, cmap=None, vmin=None, vmax=None, symmetric=False, percentile=98, extend=None, max_triangle_edge=None, use_triangulation_cache=True, input_radians=True, transform=None, add_colorbar=True, cbar_kwargs=None, title=None, xlabel='Longitude', ylabel='Latitude', aspect='auto', lon_name_vertex='lonVertex', lat_name_vertex='latVertex')¶

Draw filled contour for MPAS vertex-centered scalar field.

Parameters¶

dsxarray.Dataset: MPAS dataset containing vertex coordinate variables.
daxarray.DataArray or numpy.ndarray: Vertex-centered scalar values. The data must be one-dimensional on nVertices after any time or vertical-level selection.
axmatplotlib.axes.Axes, optional: Axes on which to draw. By default, use the current axes.
lon_min, lon_max, lat_min, lat_maxfloat, optional: Plot extent in degrees. Cross-dateline longitude windows are supported.
auto_extentbool, default: True: If True and no explicit extent is supplied, infer the extent from valid vertices.
extent_marginfloat, default: 0.05: Fractional margin added to the automatically inferred extent.
contour_marginfloat, default: 0.05: Fractional padding used when selecting source vertices for contouring.
global_plotbool, default: False: If True, draw a global extent centered on center_lon.
center_lonfloat, optional: Longitude center used for wrapping. If None, infer it from the extent or valid vertices.
levelsint or array-like, default: 10: Number of contour levels, or explicit level values.
cmapstr or matplotlib.colors.Colormap, optional: Colormap used for filled contours.
vmin, vmaxfloat, optional: Data limits used by contour levels and color mapping.
symmetricbool, default: False: If True, infer symmetric limits around zero when vmin or vmax is omitted.
percentilefloat, default: 98: Percentile used for automatic data-limit inference.
extend{“neither”, “both”, “min”, “max”}, optional: Colorbar extension mode. If None, infer it from data and levels.
max_triangle_edgefloat, optional: Maximum accepted edge length for triangles. Longer triangles are masked.
use_triangulation_cachebool, default: True: If True, cache the triangulation for repeated calls on the same mesh and extent.
input_radiansbool, default: True: If True, MPAS longitude and latitude variables are interpreted as radians and converted to degrees.
transformcartopy.crs.CRS, optional: Coordinate reference system of the input coordinates for Cartopy axes.
add_colorbarbool, default: True: If True, add a colorbar for the filled contour set.
cbar_kwargsdict, optional: Keyword arguments passed to Figure.colorbar.
titlestr, optional: Axes title. If None, use the data long name.
xlabel, ylabelstr: Axis labels used for plain Matplotlib axes.
aspectstr or float, default: “auto”: Aspect setting used for plain Matplotlib axes.
lon_name_vertex, lat_name_vertexstr: MPAS vertex coordinate variable names.

Returns¶

matplotlib.contour.QuadContourSet: Filled contour set returned by Axes.tricontourf.

MPAS Vertex-centered contour plots

easyclimate.plot.mpas.vertex_contour.plot_vertex_contour(ds, da, *, ax=None, lon_min=None, lon_max=None, lat_min=None, lat_max=None, auto_extent=True, extent_margin=0.05, contour_margin=0.05, global_plot=False, center_lon=None, levels=10, colors=None, linewidths=0.8, linestyles=None, cmap=None, vmin=None, vmax=None, symmetric=False, percentile=98, extend=None, max_triangle_edge=None, use_triangulation_cache=True, input_radians=True, transform=None, title=None, xlabel='Longitude', ylabel='Latitude', aspect='auto', lon_name_vertex='lonVertex', lat_name_vertex='latVertex')¶

Draw contour lines for MPAS vertex-centered scalar field.

Parameters¶

dsxarray.Dataset: MPAS dataset containing vertex coordinate variables.
daxarray.DataArray or numpy.ndarray: Vertex-centered scalar values. The data must be one-dimensional on nVertices after any time or vertical-level selection.
axmatplotlib.axes.Axes, optional: Axes on which to draw. By default, use the current axes.
lon_min, lon_max, lat_min, lat_maxfloat, optional: Plot extent in degrees. Cross-dateline longitude windows are supported.
auto_extentbool, default: True: If True and no explicit extent is supplied, infer the extent from valid vertices.
extent_marginfloat, default: 0.05: Fractional margin added to the automatically inferred extent.
contour_marginfloat, default: 0.05: Fractional padding used when selecting source vertices for contouring.
global_plotbool, default: False: If True, draw a global extent centered on center_lon.
center_lonfloat, optional: Longitude center used for wrapping. If None, infer it from the extent or valid vertices.
levelsint or array-like, default: 10: Number of contour levels, or explicit level values.
colorscolor or collections.abc.Sequence of colors, optional: Fixed line colors passed to Axes.tricontour. If omitted, use cmap.
linewidths, linestyles: Contour line style options passed to Axes.tricontour.
cmapstr or matplotlib.colors.Colormap, optional: Colormap used when colors is not supplied.
vmin, vmaxfloat, optional: Data limits used by contour levels and color mapping.
symmetricbool, default: False: If True, infer symmetric limits around zero when vmin or vmax is omitted.
percentilefloat, default: 98: Percentile used for automatic data-limit inference.
extend{“neither”, “both”, “min”, “max”}, optional: Contour extension mode. If None, infer it from data and levels.
max_triangle_edgefloat, optional: Maximum accepted edge length for triangles. Longer triangles are masked.
use_triangulation_cachebool, default: True: If True, cache the triangulation for repeated calls on the same mesh and extent.
input_radiansbool, default: True: If True, MPAS longitude and latitude variables are interpreted as radians and converted to degrees.
transformcartopy.crs.CRS, optional: Coordinate reference system of the input coordinates for Cartopy axes.
titlestr, optional: Axes title. If None, use the data long name.
xlabel, ylabelstr: Axis labels used for plain Matplotlib axes.
aspectstr or float, default: “auto”: Aspect setting used for plain Matplotlib axes.
lon_name_vertex, lat_name_vertexstr: MPAS vertex coordinate variable names.

Returns¶

matplotlib.contour.QuadContourSet: Contour set returned by Axes.tricontour.

MPAS Vertex-centered contour plots