environmentaltools.graphics.flood_map

environmentaltools.graphics.flood_map(data, coast_line, flood_line, points, flood_polygon, title=None, fname=None, ax=None)[source]

Plot coastal flood inundation map.

Visualizes coastal flooding extent showing the initial coastline, flood boundary, reference points, and calculated inundation area.

Parameters:

  • data (xarray.Dataset or dict) – Background spatial data (typically bathymetry/topography).

  • coast_line (pd.DataFrame or gpd.GeoDataFrame) – Initial coastline geometry with x, y coordinates.

  • flood_line (dict or pd.DataFrame) – Flood extent boundary with ‘x’ and ‘y’ coordinates.

  • points (pd.DataFrame or gpd.GeoDataFrame) – Reference points with x, y coordinates.

  • flood_polygon (gpd.GeoDataFrame) – Polygon geometry of flooded area with ‘area’ attribute.

  • title (str, optional) – Plot title. Defaults to None.

  • fname (str, optional) – Filename to save the figure. Defaults to None.

  • ax (matplotlib.axes.Axes, optional) – Axes object to plot on. Defaults to None.

Returns:

The axes object with the plot.

Return type:

matplotlib.axes.Axes