er

Author: Jammy2211

autoarray/config/visualize/mat_wrap_2d.yaml

@@ -32,6 +32,15 @@ Contour:             # wrapper for `plt.contour()`: customize contours plotted o
     total_contours: 10     # Number of contours to plot
     use_log10: true        # If true, contours are plotted with log10 spacing, if False, linear spacing.
     include_values: true   # If true, the values of the contours are plotted on the figure.
+Fill:                # wrapper for `plt.fill()`: customize the appearance of filled areas.
+  figure:
+    alpha: 1.0
+    edgecolor: k
+    facecolor: k
+  subplot:
+    alpha: 0.5
+    edgecolor: k
+    facecolor: k
 BorderScatter:       # wrapper for `plt.scatter()`: customize the apperance of 2D borders.
   figure:
     c: r

autoarray/plot/__init__.py

@@ -22,6 +22,7 @@
 
 from autoarray.plot.wrap.two_d.array_overlay import ArrayOverlay
 from autoarray.plot.wrap.two_d.contour import Contour
+from autoarray.plot.wrap.two_d.fill import Fill
 from autoarray.plot.wrap.two_d.grid_scatter import GridScatter
 from autoarray.plot.wrap.two_d.grid_plot import GridPlot
 from autoarray.plot.wrap.two_d.grid_errorbar import GridErrorbar

autoarray/plot/mat_plot/two_d.py

@@ -43,6 +43,7 @@ def __init__(
         legend: Optional[wb.Legend] = None,
         output: Optional[wb.Output] = None,
         array_overlay: Optional[w2d.ArrayOverlay] = None,
+        fill: Optional[w2d.Fill] = None,
         contour: Optional[w2d.Contour] = None,
         grid_scatter: Optional[w2d.GridScatter] = None,
         grid_plot: Optional[w2d.GridPlot] = None,
@@ -117,6 +118,8 @@ def __init__(
             Sets any annotations on the figure and customizes its appearance using `plt.annotate`.
         legend
             Sets whether the plot inclues a legend and customizes its appearance and labels using `plt.legend`.
+        fill
+            Sets the fill of the figure using `plt.fill` and customizes its appearance, such as the color and alpha.
         output
             Sets if the figure is displayed on the user's screen or output to `.png` using `plt.show` and `plt.savefig`
         array_overlay
@@ -178,6 +181,7 @@ def __init__(
             output=output,
         )
 
+        self.fill = fill or w2d.Fill(is_default=True)
         self.array_overlay = array_overlay or w2d.ArrayOverlay(is_default=True)
 
         self.contour = contour or w2d.Contour(is_default=True)

autoarray/plot/visuals/two_d.py

@@ -22,6 +22,7 @@ def __init__(
         mesh_grid: Optional[Grid2D] = None,
         vectors: Optional[VectorYX2DIrregular] = None,
         patches: Optional[List[ptch.Patch]] = None,
+        fill_region: Optional[List] = None,
         array_overlay: Optional[Array2D] = None,
         parallel_overscan=None,
         serial_prescan=None,
@@ -39,6 +40,7 @@ def __init__(
         self.mesh_grid = mesh_grid
         self.vectors = vectors
         self.patches = patches
+        self.fill_region = fill_region
         self.array_overlay = array_overlay
         self.parallel_overscan = parallel_overscan
         self.serial_prescan = serial_prescan
@@ -74,6 +76,11 @@ def plot_via_plotter(self, plotter, grid_indexes=None, mapper=None, geometry=Non
         if self.patches is not None:
             plotter.patch_overlay.overlay_patches(patches=self.patches)
 
+        if self.fill_region is not None:
+            plotter.fill.plot_fill(
+                fill_region=self.fill_region
+            )
+
         if self.lines is not None:
             plotter.grid_plot.plot_grid(grid=self.lines)
 

autoarray/plot/wrap/__init__.py

@@ -20,6 +20,7 @@
 from autoarray.plot.wrap.one_d.fill_between import FillBetween
 
 from autoarray.plot.wrap.two_d.array_overlay import ArrayOverlay
+from autoarray.plot.wrap.two_d.fill import Fill
 from autoarray.plot.wrap.two_d.grid_scatter import GridScatter
 from autoarray.plot.wrap.two_d.grid_plot import GridPlot
 from autoarray.plot.wrap.two_d.grid_errorbar import GridErrorbar

autoarray/plot/wrap/two_d/__init__.py

@@ -1,5 +1,6 @@
 from .array_overlay import ArrayOverlay
 from .contour import Contour
+from .fill import Fill
 from .grid_scatter import GridScatter
 from .grid_plot import GridPlot
 from .grid_errorbar import GridErrorbar

autoarray/plot/wrap/two_d/fill.py

@@ -0,0 +1,38 @@
+import logging
+
+import matplotlib.pyplot as plt
+
+from autoarray.plot.wrap.two_d.abstract import AbstractMatWrap2D
+
+
+logger = logging.getLogger(__name__)
+
+
+class Fill(AbstractMatWrap2D):
+    def __init__(self, **kwargs):
+        """
+        The settings used to customize plots using fill on a figure
+
+        This object wraps the following Matplotlib methods:
+
+        - plt.fill https://matplotlib.org/3.3.2/api/_as_gen/matplotlib.pyplot.fill.html
+
+        Parameters
+        ----------
+        symmetric
+            If True, the colormap normalization (e.g. `vmin` and `vmax`) span the same absolute values producing a
+            symmetric color bar.
+        """
+
+        super().__init__(**kwargs)
+
+    def plot_fill(self, fill_region):
+
+        try:
+            y_fill = fill_region[:, 0]
+            x_fill = fill_region[:, 1]
+        except TypeError:
+            y_fill = fill_region[0]
+            x_fill = fill_region[1]
+
+        plt.fill(x_fill, y_fill, **self.config_dict)