windkit.plot.landcover_map

windkit.plot.landcover_map(gdf, plot_endpoints=False, landcover_table=None, cmap=None, norm=None, ignore_collisions=True, color_lines=False, side='left', **kwargs)[source]

Plot the polygons or lines dataframe as a map.

Parameters:

  • gdf (GeoDataFrame) – the dataframe to plot.

  • plot_endpoints (bool, optional. Default: False) – Whether or not to plot the endpoints of the lines / intersections of the polygons.

  • landcover_table (windkit LandCoverTable or dict or None. Default: None) – Map ids to roughness values.

  • cmap (matplotlib.colors.Colormap, optional. Default: None) – If cmap and norm are set to None, use a default colormap.

  • norm (matplotlib.colors.BoundaryNorm, optional. Default: None) – If cmap and norm are set to None, use a default norm.

  • ignore_collisions (bool, optional. Default: True) – If ignore_collisions is False and thedefault colormap is used, the function will raise an error if two different rougness values are mapped to the same colors.

  • color_lines (bool or string, optional. Default: False) – Used only for plotting lines geodataframe. If set to “z0” or “id”, use the corresponding value to color lines. If True, use “z0” if available else “id”.

  • side (str, optional. Default: "left") – Used only for plotting lines geodataframe. Whether to use the left or right id or roughness value to color the lines, if they are colored.