Add Axes.fill_disjoint to make invert fill_between easier #24742
Conversation
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
There was a problem hiding this comment.
Thank you for this! I just left some minor comments for now.
The image test.png should be removed as it is not used(?).
This is a good start (and the code quality is high, with good documentation!), but expect that there are things to be discussed.
For your info: we are in the final stages of feature freezing 3.7, so it may take a while before you get proper feedback (or it may not).
This could also do with a release note. Although in some sense it is OK to wait with that until the reviews start to converge, it can also be a good option to highlight the feature. For example, showing off different options and capabilities. See, e.g., https://github.com/matplotlib/matplotlib/blob/main/doc/users/next_whats_new/ellipse_annotation.rst what it may look like. (In your case I would go with a subplot with few different plots.)
lib/matplotlib/patches.py
Outdated
| @@ -1066,6 +1066,123 @@ def set_data(self, values=None, edges=None, baseline=None): | |||
| self.stale = True | |||
|
|
|||
|
|
|||
| class Lines(Patch): | |||
There was a problem hiding this comment.
I think this needs a better name. BoundedSemiplane?
lib/matplotlib/patches.py
Outdated
| """ | ||
| *xy* is a numpy array with shape Nx2. | ||
|
|
||
| If *direction* is *True*, the patch is lower bounded by the polyline. |
There was a problem hiding this comment.
I wonder if there is a better name for direction? lowerbounded? lower? lower_bounded?
lib/matplotlib/tests/test_axes.py
Outdated
| @@ -45,6 +45,30 @@ | |||
| # different baseline images to prevent race conditions when pytest runs | |||
| # the tests with multiple threads. | |||
|
|
|||
| @image_comparison(['fill_disjoint'], remove_text=False) | |||
There was a problem hiding this comment.
| @image_comparison(['fill_disjoint'], remove_text=False) | |
| @image_comparison(['fill_disjoint.png'], remove_text=False, style='mpl20') |
lib/matplotlib/tests/test_axes.py
Outdated
| fig, ax = plt.subplots() | ||
| plt.plot(xRng, [f1(x) for x in xRng], 'b-') | ||
| plt.plot(xRng, [f2(x) for x in xRng], 'r-') | ||
| # Uncomment below line to test other configs |
There was a problem hiding this comment.
I think this should be removed. Or simply just add another test.
…baseline generation code
|
Thank you so much @oscargus for these helpful suggestions. We just included them in our most recent commit. |
Co-authored-by: Oscar Gustafsson <[email protected]>
Co-authored-by: Oscar Gustafsson <[email protected]>
Co-authored-by: Oscar Gustafsson <[email protected]>
…ean to {'top', 'bottom'}
|
This is failing all the tests. Can you include a description in the PR of what this does with code? Maybe also argue for the need for the extra complexity - it's not clear to me we should add all this. Finally, the new tests probably don't need to be in all the different file types? |
|
I'll move to draft, but feel free to move back when ready to move forward (if desired). Thanks! |
PR Summary
This PR fixes #23768, which asks for an easy solution to invert the fill between 2 lines. In this PR, we wrote a new patch called Lines which bounds the y axis and fixes the unbounded limits problem discussed in the issue. We also wrote the function fill_disjoint which fills in the area excluding the region in between the lines bounded by (x, y1) and (x, y2), which are inputted into the function. Thus, these changes allow users to invert fill of simple shapes composed of straight lines.
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst