ENH: compressed layout #22289

jklymak · 2022-01-22T17:41:50Z

PR Summary

Replaces #20016

We often want a grid of fixed-aspect ratio axes, but constrained_layout and tigt_layout leave large blank spaces between the axes because they only work with the original axes positions, not the aspect-modified versions.

Here I proposed an extension to constrianed_layout that works for simple grids of axes...

Old:

New:

Code

import matplotlib.pyplot as plt
import numpy as np

nrows = 2
ncols = 3
for compress in ['constrained', 'compressed']:
    print('compress?', compress)
    fig, axs = plt.subplots( nrows, ncols, figsize=(4,4),
                            layout=compress,
                            sharex=True, sharey=True)
    fig.patch.set_facecolor("0.9")
    #fig.set_constrained_layout_pads(compress=True)

    for i in range(nrows):
        for j in range(ncols):
            ax = axs[i, j]
            ax.set_aspect(1)
            pc = ax.pcolormesh(np.random.randn(30, 30))
    axs[0, 1].set_xlabel('Boooo')
    fig.colorbar(pc, ax=axs)

Failures...

This isn't perfect, and that is why it is not in "constrained_layout" Folks should be able to turn this off... This example isn't terrible, but its not very good either, though

fig, axs = plt.subplot_mosaic([['A', 'B', 'B'], ['C', 'D', 'E']], layout='compressed',
                            sharex=True, sharey=True)
for k in axs:
    axs[k].imshow(X)

Or:

fig, axs = plt.subplot_mosaic([['A', 'B', 'B'], ['C', 'B', 'B']], layout='compressed',
                            sharex=True, sharey=True, figsize=(3, 7))

PR Checklist

Tests and Styling

Has pytest style unit tests (and pytest passes).
Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

New features are documented, with examples if plot related.
New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
Documentation is sphinx and numpydoc compliant (the docs should build without error).

tacaswell · 2022-01-27T22:46:51Z

lib/matplotlib/layout_engine.py

@@ -205,6 +205,8 @@ def __init__(self, *, h_pad=None, w_pad=None,
                 hspace=mpl.rcParams['figure.constrained_layout.hspace'])
        # set anything that was passed in (None will be ignored):
        self.set(w_pad=w_pad, h_pad=h_pad, wspace=wspace, hspace=hspace)
+        # see CompressedLayoutEngine below...


This comment seems wrong now?

Ooops, yes, I decided against needing a subclass here.

Still needs fixing?

lib/matplotlib/figure.py

tutorials/intermediate/constrainedlayout_guide.py

lib/matplotlib/_constrained_layout.py

lib/matplotlib/figure.py

lib/matplotlib/layout_engine.py

tutorials/intermediate/constrainedlayout_guide.py

lib/matplotlib/_constrained_layout.py

QuLogic · 2022-05-19T07:20:25Z

lib/matplotlib/layout_engine.py

@@ -205,6 +205,8 @@ def __init__(self, *, h_pad=None, w_pad=None,
                 hspace=mpl.rcParams['figure.constrained_layout.hspace'])
        # set anything that was passed in (None will be ignored):
        self.set(w_pad=w_pad, h_pad=h_pad, wspace=wspace, hspace=hspace)
+        # see CompressedLayoutEngine below...


Still needs fixing?

tutorials/intermediate/constrainedlayout_guide.py

lib/matplotlib/_constrained_layout.py

tutorials/intermediate/constrainedlayout_guide.py

QuLogic · 2022-05-19T08:30:14Z

tutorials/intermediate/constrainedlayout_guide.py

+fig, axs = plt.subplots(2, 2, figsize=(5, 3),
+                        sharex=True, sharey=True, layout='compressed')
+for ax in axs.flat:
+    ax.imshow(arr)
+fig.suptitle("fixed-aspect plots, layout='compressed'")


This seems to look the same as the constrained version?

Agreed, https://output.circle-artifacts.com/output/job/4eee1b1a-1268-4881-8d21-61000c011c8e/artifacts/0/doc/build/html/tutorials/intermediate/constrainedlayout_guide.html#grids-of-fixed-aspect-ratio-axes-compressed-layout

but I have no idea what is happening here. This example works fine manually, just using Agg, etc. I'm flummoxed why the sphinx version doesn't work...

Fixed in newest version - there was some weird interactions between the rcParam and subsequent calls. maybe worth chasing down, but I could not reproduce without sphinx-gallery, so I guess sphinx-galery is using some weird rcParam contexts?

See https://output.circle-artifacts.com/output/job/a187bd70-81b0-4ede-ae1c-ab250a32d50c/artifacts/0/doc/build/html/tutorials/intermediate/constrainedlayout_guide.html#grids-of-fixed-aspect-ratio-axes-compressed-layout

I think the context remains the same through a single file.

Yes, but even if I change the rcParam in a normal script, and then specify the kwarg, compress works fine. But in sphinx- gallery it has this weird problem.

tutorials/intermediate/constrainedlayout_guide.py

QuLogic · 2022-06-01T05:13:19Z

tutorials/intermediate/constrainedlayout_guide.py

+fig, axs = plt.subplots(2, 2, figsize=(5, 3),
+                        sharex=True, sharey=True, layout='compressed')
+for ax in axs.flat:
+    ax.imshow(arr)
+fig.suptitle("fixed-aspect plots, layout='compressed'")


I think the context remains the same through a single file.

lib/matplotlib/_constrained_layout.py

oscargus · 2022-06-01T06:28:26Z

lib/matplotlib/_constrained_layout.py

@@ -84,10 +85,13 @@ def do_constrained_layout(fig, h_pad, w_pad,
       A value of 0.2 for a three-column layout would have a space
       of 0.1 of the figure width between each column.
       If h/wspace < h/w_pad, then the pads are used instead.
-


For consistency with above, this empty line should be here (and one added after the rect description) or all above also removed.

Sure, though this is private, so never rendered in the docs ;-)

Adds compress=True to compressed layout engine. Works for compact axes grids.

jklymak · 2022-06-10T12:55:13Z

I've marked merge with single review. This is pretty stand alone, so it shouldn't break anyone. However, happy to get a second review. I'll merge by next Friday if it doesn't attract one.

jklymak · 2022-06-10T21:09:05Z

Thanks everyone for your work on this!

timhoffm · 2022-06-10T21:26:06Z

Thanks everyone for your work on this!

Thanks for creating this! 😄

jklymak mentioned this pull request Jan 22, 2022

ENH: constrained_layout simple compress axes #20016

Closed

7 tasks

jklymak added the topic: geometry manager LayoutEngine, Constrained layout, Tight layout label Jan 22, 2022

jklymak added this to the v3.6.0 milestone Jan 22, 2022

jklymak marked this pull request as draft January 22, 2022 19:54

jklymak marked this pull request as ready for review January 24, 2022 08:35

tacaswell reviewed Jan 27, 2022

View reviewed changes

QuLogic reviewed Feb 24, 2022

View reviewed changes

jklymak force-pushed the enh-compress-layout branch 2 times, most recently from dcca890 to 8175f87 Compare March 24, 2022 14:00

QuLogic reviewed Mar 29, 2022

View reviewed changes

lib/matplotlib/_constrained_layout.py Outdated Show resolved Hide resolved

timhoffm reviewed Mar 29, 2022

View reviewed changes

jklymak force-pushed the enh-compress-layout branch from e445e28 to 777b8ef Compare March 30, 2022 08:45

QuLogic reviewed Mar 30, 2022

View reviewed changes

lib/matplotlib/_constrained_layout.py Outdated Show resolved Hide resolved

jklymak force-pushed the enh-compress-layout branch 2 times, most recently from ead8ac7 to e303fbb Compare May 16, 2022 08:22

QuLogic reviewed May 19, 2022

View reviewed changes

jklymak force-pushed the enh-compress-layout branch from 5380aa1 to dbcb46c Compare May 28, 2022 11:44

jklymak marked this pull request as draft May 28, 2022 17:56

jklymak force-pushed the enh-compress-layout branch from f14b4bb to 1adfa9d Compare May 31, 2022 12:27

jklymak marked this pull request as ready for review May 31, 2022 12:45

jklymak force-pushed the enh-compress-layout branch from 1adfa9d to 421c99e Compare May 31, 2022 12:59

QuLogic reviewed Jun 1, 2022

View reviewed changes

QuLogic approved these changes Jun 1, 2022

View reviewed changes

lib/matplotlib/_constrained_layout.py Outdated Show resolved Hide resolved

oscargus reviewed Jun 1, 2022

View reviewed changes

jklymak force-pushed the enh-compress-layout branch from 421c99e to 1984d55 Compare June 1, 2022 06:53

ENH: simple compressed layout

44df2db

Adds compress=True to compressed layout engine. Works for compact axes grids.

jklymak force-pushed the enh-compress-layout branch from 1984d55 to 44df2db Compare June 1, 2022 06:53

jklymak added the status: merge with single review? label Jun 10, 2022

timhoffm approved these changes Jun 10, 2022

View reviewed changes

timhoffm merged commit b396481 into matplotlib:main Jun 10, 2022

timhoffm removed the status: merge with single review? label Jun 10, 2022

jklymak mentioned this pull request Sep 8, 2022

Consolidate release notes for 3.6 #23814

Merged

2 tasks

rcomer mentioned this pull request Nov 13, 2022

Makefile html-noplot,clean: constrained layout tutorial image handling #24445

Merged

7 tasks

QuLogic mentioned this pull request Nov 24, 2022

[Bug]: AnnotationBbox does not return correct window_extent before first draw #24453

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENH: compressed layout #22289

ENH: compressed layout #22289

jklymak commented Jan 22, 2022

tacaswell Jan 27, 2022

jklymak Jan 28, 2022

QuLogic May 19, 2022

QuLogic May 19, 2022

QuLogic May 19, 2022

jklymak May 28, 2022

jklymak May 31, 2022

jklymak May 31, 2022

QuLogic Jun 1, 2022

jklymak Jun 1, 2022

QuLogic Jun 1, 2022

oscargus Jun 1, 2022

jklymak Jun 1, 2022

jklymak commented Jun 10, 2022

jklymak commented Jun 10, 2022

timhoffm commented Jun 10, 2022

ENH: compressed layout #22289

ENH: compressed layout #22289

Conversation

jklymak commented Jan 22, 2022

PR Summary

Old:

New:

Code

Failures...

PR Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jklymak commented Jun 10, 2022

jklymak commented Jun 10, 2022

timhoffm commented Jun 10, 2022