change default value of mask parameter and update changelog

Author: ValentinGebhart

CHANGELOG.md

@@ -16,7 +16,7 @@ Removed:
 
 ### Added
 - Added optional parameter to `geo_im_from_array`, `plot_from_gdf`, `plot_rp_imp`, `plot_rp_intensity`,
-`plot_intensity`, `plot_fraction`, `_event_plot` to mask plotting when regions are too far from data points [#1047](https://github.com/CLIMADA-project/climada_python/pull/1047).
+`plot_intensity`, `plot_fraction`, `_event_plot` to mask plotting when regions are too far from data points [#1047](https://github.com/CLIMADA-project/climada_python/pull/1047). To recreate previous plots (no masking), the parameter can be set to None.
 - Added instructions to install Climada petals on Euler cluster in `doc.guide.Guide_Euler.ipynb` [#1029](https://github.com/CLIMADA-project/climada_python/pull/1029)
 
 ### Changed

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=None,
+        mask_distance=0.01,
         kwargs_local_exceedance_impact=None,
         **kwargs,
     ):
@@ -1199,7 +1199,7 @@ def plot_rp_imp(
             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.
+            Default is 0.01.
         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=None,
+        mask_distance=0.01,
         kwargs_local_exceedance_intensity=None,
         **kwargs,
     ):
@@ -61,7 +61,7 @@ def plot_rp_intensity(
             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.
+            Default is 0.01.
         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=None,
+        mask_distance=0.01,
         **kwargs,
     ):
         """Plot intensity values for a selected event or centroid.
@@ -139,7 +139,7 @@ def plot_intensity(
             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.
+            Default is 0.01.
         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=None,
+        mask_distance=0.01,
         **kwargs,
     ):
         """Plot fraction values for a selected event or centroid.
@@ -252,7 +252,7 @@ def _event_plot(
         axis=None,
         figsize=(9, 13),
         adapt_fontsize=True,
-        mask_distance=None,
+        mask_distance=0.01,
         **kwargs,
     ):
         """Plot an event of the input matrix.

climada/util/plot.py

@@ -338,7 +338,7 @@ def geo_im_from_array(
     axes=None,
     figsize=(9, 13),
     adapt_fontsize=True,
-    mask_distance=None,
+    mask_distance=0.01,
     **kwargs,
 ):
     """Image(s) plot defined in array(s) over input coordinates.
@@ -374,7 +374,7 @@ def geo_im_from_array(
         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.
+        Default is 0.01.
     **kwargs
         arbitrary keyword arguments for pcolormesh matplotlib function
 
@@ -1104,7 +1104,7 @@ def plot_from_gdf(
     axis=None,
     figsize=(9, 13),
     adapt_fontsize=True,
-    mask_distance=None,
+    mask_distance=0.01,
     **kwargs,
 ):
     """Plot several subplots from different columns of a GeoDataFrame, e.g., for
@@ -1131,7 +1131,7 @@ def plot_from_gdf(
         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.
+        Default is 0.01.
     kwargs: optional
         Arguments for pcolormesh matplotlib function used in event plots.