windkit.plot.spatial_structure_2d

windkit.plot.spatial_structure_2d(ds, ax=None, subsample: int = 1, marker_size: float = 30, color: str = 'steelblue', alpha: float = 0.8)

Plan-view (2D) plot of a WindKit spatial structure.

Plots the horizontal footprint of a spatial dataset. All height levels collapse onto the same (west_east, south_north) plane.

Parameters:

• ds (xarray.Dataset or xarray.DataArray) – WindKit spatial object. Recognised structures: point, stacked_point, raster, cuboid.

• ax (matplotlib.axes.Axes, optional) – Axes to draw on. A new figure is created when None.

• subsample (int, optional) – Plot every n-th point. Useful for large rasters or cuboids.

• marker_size (float, optional) – Marker area in points squared (passed as s to scatter).

• color (str, optional) – Marker face colour.

• alpha (float, optional) – Marker transparency (0–1).

Returns:

The axes object that was drawn on.

Return type:

matplotlib.axes.Axes

Raises:

• ValueError – If the spatial structure cannot be determined.

• NotImplementedError – If an unrecognised spatial structure is encountered.