Merge pull request #1073 from CLIMADA-project/feature/plot_intensity_efficiency

speed-up the function to add country borders and coastlines

Author: timschmi95

CHANGELOG.md

@@ -22,7 +22,8 @@ Removed:
 - `ImpactFunc` and `ImpactFuncSet` now support equality comparisons via `==` [#1027](https://github.com/CLIMADA-project/climada_python/pull/1027)
 
 ### Changed
-
+- Changed the default mask_distance in `util.plot.geo_im_from_array` to 0.03 to avoid white gaps in gridded hazard data with comparably low resolution (>80 centroids per axis) [#1073](https://github.com/CLIMADA-project/climada_python/pull/1073)
+- Increased speed of `util.plot.add_shapes` by avoiding for loops, substantially speeding up `Hazard.plot_intensity` and other functions. [#1073](https://github.com/CLIMADA-project/climada_python/pull/1073)
 - `Hazard.local_exceedance_intensity`, `Hazard.local_return_period` and `Impact.local_exceedance_impact`, `Impact.local_return_period`, using the `climada.util.interpolation` module: New default (no binning), binning on decimals, and faster implementation [#1012](https://github.com/CLIMADA-project/climada_python/pull/1012)
 - World Bank indicator data is now downloaded directly from their API via the function `download_world_bank_indicator`, instead of relying on the `pandas-datareader` package [#1033](https://github.com/CLIMADA-project/climada_python/pull/1033)
 - `Exposures.write_hdf5` pickles geometry data in WKB format, which is faster and more sustainable. [#1051](https://github.com/CLIMADA-project/climada_python/pull/1051)

climada/engine/impact.py

@@ -1178,7 +1178,7 @@ def plot_rp_imp(
         return_periods=(25, 50, 100, 250),
         log10_scale=True,
         axis=None,
-        mask_distance=0.01,
+        mask_distance=0.03,
         kwargs_local_exceedance_impact=None,
         **kwargs,
     ):
@@ -1198,8 +1198,8 @@ def plot_rp_imp(
         mask_distance: float, optional
             Only regions are plotted that are closer to any of the data points than this distance,
             relative to overall plot size. For instance, to only plot values
-            at the centroids, use mask_distance=0.01. If None, the plot is not masked.
-            Default is 0.01.
+            at the centroids, use mask_distance=0.03. If None, the plot is not masked.
+            Default is 0.03.
         kwargs_local_exceedance_impact: dict
             Dictionary of keyword arguments for the method impact.local_exceedance_impact.
         kwargs : dict, optional

climada/hazard/plot.py

@@ -40,7 +40,7 @@ def plot_rp_intensity(
         self,
         return_periods=(25, 50, 100, 250),
         axis=None,
-        mask_distance=0.01,
+        mask_distance=0.03,
         kwargs_local_exceedance_intensity=None,
         **kwargs,
     ):
@@ -60,8 +60,8 @@ def plot_rp_intensity(
         mask_distance: float, optional
             Only regions are plotted that are closer to any of the data points than this distance,
             relative to overall plot size. For instance, to only plot values
-            at the centroids, use mask_distance=0.01. If None, the plot is not masked.
-            Default is 0.01.
+            at the centroids, use mask_distance=0.03. If None, the plot is not masked.
+            Default is 0.03.
         kwargs: optional
             arguments for pcolormesh matplotlib function used in event plots
 
@@ -111,7 +111,7 @@ def plot_intensity(
         smooth=True,
         axis=None,
         adapt_fontsize=True,
-        mask_distance=0.01,
+        mask_distance=0.03,
         **kwargs,
     ):
         """Plot intensity values for a selected event or centroid.
@@ -138,8 +138,8 @@ def plot_intensity(
         mask_distance: float, optional
             Only regions are plotted that are closer to any of the data points than this distance,
             relative to overall plot size. For instance, to only plot values
-            at the centroids, use mask_distance=0.01. If None, the plot is not masked.
-            Default is 0.01.
+            at the centroids, use mask_distance=0.03. If None, the plot is not masked.
+            Default is 0.03.
         kwargs: optional
             arguments for pcolormesh matplotlib function
             used in event plots or for plot function used in centroids plots
@@ -181,7 +181,7 @@ def plot_fraction(
         centr=None,
         smooth=True,
         axis=None,
-        mask_distance=0.01,
+        mask_distance=0.03,
         **kwargs,
     ):
         """Plot fraction values for a selected event or centroid.
@@ -208,8 +208,8 @@ def plot_fraction(
         mask_distance: float, optional
             Relative distance (with respect to maximal map extent in longitude or latitude) to data
             points above which plot should not display values. For instance, to only plot values
-            at the centroids, use mask_distance=0.01. If None, the plot is not masked.
-            Default is None.
+            at the centroids, use mask_distance=0.03. If None, the plot is not masked.
+            Default is 0.03.
         kwargs: optional
             arguments for pcolormesh matplotlib function
             used in event plots or for plot function used in centroids plots
@@ -252,7 +252,7 @@ def _event_plot(
         axis=None,
         figsize=(9, 13),
         adapt_fontsize=True,
-        mask_distance=0.01,
+        mask_distance=0.03,
         **kwargs,
     ):
         """Plot an event of the input matrix.
@@ -277,8 +277,8 @@ def _event_plot(
         mask_distance: float, optional
             Only regions are plotted that are closer to any of the data points than this distance,
             relative to overall plot size. For instance, to only plot values
-            at the centroids, use mask_distance=0.01. If None, the plot is not masked.
-            Default is None.
+            at the centroids, use mask_distance=0.03. If None, the plot is not masked.
+            Default is 0.03.
         kwargs: optional
             arguments for pcolormesh matplotlib function
 

climada/util/plot.py

@@ -35,6 +35,7 @@
 from textwrap import wrap
 
 import cartopy.crs as ccrs
+import cartopy.feature as cfeature
 import geopandas as gpd
 import matplotlib as mpl
 import matplotlib.patches as mpatches
@@ -338,7 +339,7 @@ def geo_im_from_array(
     axes=None,
     figsize=(9, 13),
     adapt_fontsize=True,
-    mask_distance=0.01,
+    mask_distance=0.03,
     **kwargs,
 ):
     """Image(s) plot defined in array(s) over input coordinates.
@@ -373,8 +374,8 @@ def geo_im_from_array(
     mask_distance: float, optional
         Only regions are plotted that are closer to any of the data points than this distance,
         relative to overall plot size. For instance, to only plot values
-        at the centroids, use mask_distance=0.01. If None, the plot is not masked.
-        Default is 0.01.
+        at the centroids, use mask_distance=0.03. If None, the plot is not masked.
+        Default is 0.03.
     **kwargs
         arbitrary keyword arguments for pcolormesh matplotlib function
 
@@ -725,24 +726,15 @@ def make_map(num_sub=1, figsize=(9, 13), proj=ccrs.PlateCarree(), adapt_fontsize
 
 def add_shapes(axis):
     """
-    Overlay Earth's countries coastlines to matplotlib.pyplot axis.
+    Overlay Earth's countries and coastlines to matplotlib.pyplot axis.
 
     Parameters
     ----------
     axis : cartopy.mpl.geoaxes.GeoAxesSubplot
         Cartopy axis
-    projection : cartopy.crs projection, optional
-        Geographical projection.
-        The default is PlateCarree.
     """
-    shp_file = shapereader.natural_earth(
-        resolution="10m", category="cultural", name="admin_0_countries"
-    )
-    shp = shapereader.Reader(shp_file)
-    for geometry in shp.geometries():
-        axis.add_geometries(
-            [geometry], crs=ccrs.PlateCarree(), facecolor="none", edgecolor="dimgray"
-        )
+    axis.add_feature(cfeature.BORDERS.with_scale("10m"), edgecolor="dimgrey")
+    axis.add_feature(cfeature.COASTLINE.with_scale("10m"), edgecolor="dimgrey")
 
 
 def _ensure_utf8(val):
@@ -1104,7 +1096,7 @@ def plot_from_gdf(
     axis=None,
     figsize=(9, 13),
     adapt_fontsize=True,
-    mask_distance=0.01,
+    mask_distance=0.03,
     **kwargs,
 ):
     """Plot several subplots from different columns of a GeoDataFrame, e.g., for
@@ -1130,8 +1122,8 @@ def plot_from_gdf(
     mask_distance: float, optional
         Relative distance (with respect to maximal map extent in longitude or latitude) to data
         points above which plot should not display values. For instance, to only plot values
-        at the centroids, use mask_distance=0.01. If None, the plot is not masked.
-        Default is 0.01.
+        at the centroids, use mask_distance=0.03. If None, the plot is not masked.
+        Default is 0.03.
     kwargs: optional
         Arguments for pcolormesh matplotlib function used in event plots.