Merge pull request #71 from sadielbartholomew/cbar-cutoff-fix

Create & apply testing decorator for plot comparison, w/bug fix
NCAS-CMS · Aug 13, 2024 · 5d6bfe1 · 5d6bfe1
2 parents 4369dfe + 95a15b7
commit 5d6bfe1
Show file tree

Hide file tree

Showing 48 changed files with 128 additions and 197 deletions.
diff --git a/cfplot/cfplot.py b/cfplot/cfplot.py
@@ -9906,54 +9906,46 @@ def cbar(
 
         left, bottom, width, height = this_plot.get_position().bounds
 
-        exclude_vprojs = ["cyl", "lcc", "moll", "merc", "ortho", "robin"]
         if orientation == "horizontal":
-            if (
-                plotvars.plot_type > 1
-                or plotvars.plot == 0
-                or plotvars.proj not in exclude_vprojs
-            ):
+            if plotvars.plot_type > 1 or plotvars.plot == 0:
                 this_plot.set_position(
                     [left, bottom + fraction, width, height - fraction]
                 )
-
-            if plotvars.plot_type == 1 and plotvars.proj in exclude_vprojs:
-                # Move plot up if aspect ratio is < 1.5
-                lonrange = plotvars.lonmax - plotvars.lonmin
-                latrange = plotvars.latmax - plotvars.latmin
-
-                if (lonrange / latrange) <= 1.5:
-                    this_plot.set_position(
-                        [left, bottom + 0.08, width, height - 0.12]
-                    )
-                    left, bottom, width, height = (
-                        this_plot.get_position().bounds
-                    )
-
                 ax1 = plotvars.master_plot.add_axes(
                     [
                         left + width * (1.0 - shrink) / 2.0,
-                        bottom - fraction * (1.0 - anchor),
+                        bottom,
                         width * shrink,
                         thick,
                     ]
                 )
-
-            if plotvars.plot_type > 1 or plotvars.plot_type == 0:
-                this_plot.set_position(
-                    [left, bottom + fraction, width, height - fraction]
+            if plotvars.plot_type == 1:
+                # If the plot is too square in terms of aspect ratio, it
+                # will push the colour bar down and it can be cut off, so
+                # move the plot up in these cases. Use height and width
+                # ratio since this represents the matplotlib object
+                # position differences, so is the best way to measure.
+                left, bottom, width, height = (
+                    this_plot.get_position().bounds
                 )
+                # Empirical sweet spot: roughly where plot area is taller
+                # than it is wide, including when plot area is roughly square
+                if height / width >= 0.9:
+                    this_plot.set_position(
+                        [left, bottom + fraction, width, height - fraction]
+                    )
+                    left, bottom, width, height = (
+                        this_plot.get_position().bounds
+                    )
 
                 ax1 = plotvars.master_plot.add_axes(
                     [
                         left + width * (1.0 - shrink) / 2.0,
-                        # b - fraction * (1.0 - anchor),
-                        bottom,
+                        bottom + fraction * (anchor - 1.0),
                         width * shrink,
                         thick,
                     ]
                 )
-
         else:
             ax1 = plotvars.master_plot.add_axes(
                 [
@@ -10215,7 +10207,7 @@ def irregular_window(field, lons, lats):
     lons_irregular = np.concatenate([lons_irregular, lons_new])
     lats_irregular = np.concatenate([lats_irregular, lats_new])
 
-    # Add to the right if a fiull globe is being plotted
+    # Add to the right if a full globe is being plotted
     # The 359.99 here is needed or Cartopy will map 360 back to 0
 
     if plotvars.lonmax - plotvars.lonmin == 360:

diff --git a/cfplot/test/reference-example-images/ref_fig34.png b/cfplot/test/reference-example-images/ref_fig34.png
diff --git a/cfplot/test/reference-example-images/ref_fig36.png b/cfplot/test/reference-example-images/ref_fig36.png
diff --git a/cfplot/test/reference-example-images/ref_fig37.png b/cfplot/test/reference-example-images/ref_fig37.png
diff --git a/...est/reference-example-images/ref_fig1.png → ...st/reference-example-images/ref_fig_1.png b/...est/reference-example-images/ref_fig1.png → ...st/reference-example-images/ref_fig_1.png
diff --git a/...st/reference-example-images/ref_fig10.png → ...t/reference-example-images/ref_fig_10.png b/...st/reference-example-images/ref_fig10.png → ...t/reference-example-images/ref_fig_10.png
diff --git a/...st/reference-example-images/ref_fig11.png → ...t/reference-example-images/ref_fig_11.png b/...st/reference-example-images/ref_fig11.png → ...t/reference-example-images/ref_fig_11.png
diff --git a/...st/reference-example-images/ref_fig12.png → ...t/reference-example-images/ref_fig_12.png b/...st/reference-example-images/ref_fig12.png → ...t/reference-example-images/ref_fig_12.png
diff --git a/...st/reference-example-images/ref_fig13.png → ...t/reference-example-images/ref_fig_13.png b/...st/reference-example-images/ref_fig13.png → ...t/reference-example-images/ref_fig_13.png
diff --git a/...st/reference-example-images/ref_fig14.png → ...t/reference-example-images/ref_fig_14.png b/...st/reference-example-images/ref_fig14.png → ...t/reference-example-images/ref_fig_14.png
diff --git a/...st/reference-example-images/ref_fig15.png → ...t/reference-example-images/ref_fig_15.png b/...st/reference-example-images/ref_fig15.png → ...t/reference-example-images/ref_fig_15.png
diff --git a/...t/reference-example-images/ref_fig16b.png → .../reference-example-images/ref_fig_16b.png b/...t/reference-example-images/ref_fig16b.png → .../reference-example-images/ref_fig_16b.png
diff --git a/...t/reference-example-images/ref_fig16c.png → .../reference-example-images/ref_fig_16c.png b/...t/reference-example-images/ref_fig16c.png → .../reference-example-images/ref_fig_16c.png
diff --git a/...st/reference-example-images/ref_fig17.png → ...t/reference-example-images/ref_fig_17.png b/...st/reference-example-images/ref_fig17.png → ...t/reference-example-images/ref_fig_17.png
diff --git a/...st/reference-example-images/ref_fig18.png → ...t/reference-example-images/ref_fig_18.png b/...st/reference-example-images/ref_fig18.png → ...t/reference-example-images/ref_fig_18.png
diff --git a/...st/reference-example-images/ref_fig19.png → ...t/reference-example-images/ref_fig_19.png b/...st/reference-example-images/ref_fig19.png → ...t/reference-example-images/ref_fig_19.png
diff --git a/...t/reference-example-images/ref_fig19a.png → .../reference-example-images/ref_fig_19a.png b/...t/reference-example-images/ref_fig19a.png → .../reference-example-images/ref_fig_19a.png
diff --git a/...t/reference-example-images/ref_fig19b.png → .../reference-example-images/ref_fig_19b.png b/...t/reference-example-images/ref_fig19b.png → .../reference-example-images/ref_fig_19b.png
diff --git a/...est/reference-example-images/ref_fig2.png → ...st/reference-example-images/ref_fig_2.png b/...est/reference-example-images/ref_fig2.png → ...st/reference-example-images/ref_fig_2.png
diff --git a/...st/reference-example-images/ref_fig20.png → ...t/reference-example-images/ref_fig_20.png b/...st/reference-example-images/ref_fig20.png → ...t/reference-example-images/ref_fig_20.png
diff --git a/...st/reference-example-images/ref_fig21.png → ...t/reference-example-images/ref_fig_21.png b/...st/reference-example-images/ref_fig21.png → ...t/reference-example-images/ref_fig_21.png
diff --git a/...ference-example-images/ref_fig21other.png → ...erence-example-images/ref_fig_21other.png b/...ference-example-images/ref_fig21other.png → ...erence-example-images/ref_fig_21other.png
diff --git a/...st/reference-example-images/ref_fig22.png → ...t/reference-example-images/ref_fig_22.png b/...st/reference-example-images/ref_fig22.png → ...t/reference-example-images/ref_fig_22.png
diff --git a/...ference-example-images/ref_fig22other.png → ...erence-example-images/ref_fig_22other.png b/...ference-example-images/ref_fig22other.png → ...erence-example-images/ref_fig_22other.png
diff --git a/...st/reference-example-images/ref_fig23.png → ...t/reference-example-images/ref_fig_23.png b/...st/reference-example-images/ref_fig23.png → ...t/reference-example-images/ref_fig_23.png
diff --git a/...ference-example-images/ref_fig23other.png → ...erence-example-images/ref_fig_23other.png b/...ference-example-images/ref_fig23other.png → ...erence-example-images/ref_fig_23other.png
diff --git a/...st/reference-example-images/ref_fig27.png → ...t/reference-example-images/ref_fig_27.png b/...st/reference-example-images/ref_fig27.png → ...t/reference-example-images/ref_fig_27.png
diff --git a/...st/reference-example-images/ref_fig28.png → ...t/reference-example-images/ref_fig_28.png b/...st/reference-example-images/ref_fig28.png → ...t/reference-example-images/ref_fig_28.png
diff --git a/...st/reference-example-images/ref_fig29.png → ...t/reference-example-images/ref_fig_29.png b/...st/reference-example-images/ref_fig29.png → ...t/reference-example-images/ref_fig_29.png
diff --git a/...est/reference-example-images/ref_fig3.png → ...st/reference-example-images/ref_fig_3.png b/...est/reference-example-images/ref_fig3.png → ...st/reference-example-images/ref_fig_3.png
diff --git a/...st/reference-example-images/ref_fig30.png → ...t/reference-example-images/ref_fig_30.png b/...st/reference-example-images/ref_fig30.png → ...t/reference-example-images/ref_fig_30.png
diff --git a/cfplot/test/reference-example-images/ref_fig_34.png b/cfplot/test/reference-example-images/ref_fig_34.png
diff --git a/...st/reference-example-images/ref_fig35.png → ...t/reference-example-images/ref_fig_35.png b/...st/reference-example-images/ref_fig35.png → ...t/reference-example-images/ref_fig_35.png
diff --git a/cfplot/test/reference-example-images/ref_fig_36.png b/cfplot/test/reference-example-images/ref_fig_36.png
diff --git a/cfplot/test/reference-example-images/ref_fig_37.png b/cfplot/test/reference-example-images/ref_fig_37.png
diff --git a/...st/reference-example-images/ref_fig38.png → ...t/reference-example-images/ref_fig_38.png b/...st/reference-example-images/ref_fig38.png → ...t/reference-example-images/ref_fig_38.png
diff --git a/...st/reference-example-images/ref_fig39.png → ...t/reference-example-images/ref_fig_39.png b/...st/reference-example-images/ref_fig39.png → ...t/reference-example-images/ref_fig_39.png
diff --git a/...est/reference-example-images/ref_fig4.png → ...st/reference-example-images/ref_fig_4.png b/...est/reference-example-images/ref_fig4.png → ...st/reference-example-images/ref_fig_4.png
diff --git a/...st/reference-example-images/ref_fig40.png → ...t/reference-example-images/ref_fig_40.png b/...st/reference-example-images/ref_fig40.png → ...t/reference-example-images/ref_fig_40.png
diff --git a/...st/reference-example-images/ref_fig41.png → ...t/reference-example-images/ref_fig_41.png b/...st/reference-example-images/ref_fig41.png → ...t/reference-example-images/ref_fig_41.png
diff --git a/...st/reference-example-images/ref_fig42.png → ...t/reference-example-images/ref_fig_42.png b/...st/reference-example-images/ref_fig42.png → ...t/reference-example-images/ref_fig_42.png
diff --git a/...t/reference-example-images/ref_fig42a.png → .../reference-example-images/ref_fig_42a.png b/...t/reference-example-images/ref_fig42a.png → .../reference-example-images/ref_fig_42a.png
diff --git a/...est/reference-example-images/ref_fig5.png → ...st/reference-example-images/ref_fig_5.png b/...est/reference-example-images/ref_fig5.png → ...st/reference-example-images/ref_fig_5.png
diff --git a/...est/reference-example-images/ref_fig6.png → ...st/reference-example-images/ref_fig_6.png b/...est/reference-example-images/ref_fig6.png → ...st/reference-example-images/ref_fig_6.png
diff --git a/...est/reference-example-images/ref_fig7.png → ...st/reference-example-images/ref_fig_7.png b/...est/reference-example-images/ref_fig7.png → ...st/reference-example-images/ref_fig_7.png
diff --git a/...est/reference-example-images/ref_fig8.png → ...st/reference-example-images/ref_fig_8.png b/...est/reference-example-images/ref_fig8.png → ...st/reference-example-images/ref_fig_8.png
diff --git a/...est/reference-example-images/ref_fig9.png → ...st/reference-example-images/ref_fig_9.png b/...est/reference-example-images/ref_fig9.png → ...st/reference-example-images/ref_fig_9.png