-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
[ENH] Implement dynamic clipping to axes limits for 3D plots #27349
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
Data in 3D plots can now be dynamically clipped to the axes view limits | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
All 3D plotting functions now support the *axlim_clip* keyword argument, which | ||
will clip the data to the axes view limits, hiding all data outside those | ||
bounds. This clipping will be dynamically applied in real time while panning | ||
and zooming. | ||
|
||
Please note that if one vertex of a line segment or 3D patch is clipped, then | ||
the entire segment or patch will be hidden. Not being able to show partial | ||
lines or patches such that they are "smoothly" cut off at the boundaries of the | ||
view box is a limitation of the current renderer. | ||
|
||
.. plot:: | ||
:include-source: true | ||
:alt: Example of default behavior (left) and axlim_clip=True (right) | ||
|
||
import matplotlib.pyplot as plt | ||
import numpy as np | ||
|
||
fig, ax = plt.subplots(subplot_kw={"projection": "3d"}) | ||
np.random.seed(1) | ||
xyz = np.random.rand(25, 3) | ||
|
||
# Note that when a line has one vertex outside the view limits, the entire | ||
# line is hidden. The same is true for 3D patches (not shown). | ||
ax.plot(xyz[:, 0], xyz[:, 1], xyz[:, 2], '-o') | ||
ax.plot(xyz[:, 0], xyz[:, 1], xyz[:, 2], '--*', axlim_clip=True) | ||
ax.set(xlim=(0.25, 0.75), ylim=(0, 1), zlim=(0, 1)) | ||
ax.legend(['axlim_clip=False (default)', 'axlim_clip=True']) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
""" | ||
===================================== | ||
Clip the data to the axes view limits | ||
===================================== | ||
|
||
Demonstrate clipping of line and marker data to the axes view limits. The | ||
``axlim_clip`` keyword argument can be used in any of the 3D plotting | ||
functions. | ||
""" | ||
|
||
import matplotlib.pyplot as plt | ||
import numpy as np | ||
|
||
fig, ax = plt.subplots(subplot_kw={"projection": "3d"}) | ||
|
||
# Generate the random data | ||
np.random.seed(1) | ||
xyz = np.random.rand(25, 3) | ||
|
||
# Default behavior is axlim_clip=False | ||
ax.plot(xyz[:, 0], xyz[:, 1], xyz[:, 2], '-o') | ||
|
||
# When axlim_clip=True, note that when a line segment has one vertex outside | ||
# the view limits, the entire line is hidden. The same is true for 3D patches | ||
# if one of their vertices is outside the limits (not shown). | ||
ax.plot(xyz[:, 0], xyz[:, 1], xyz[:, 2], '--*', axlim_clip=True) | ||
|
||
ax.set(xlim=(0.25, 0.75), ylim=(0, 1), zlim=(-1, 1)) | ||
ax.legend(['axlim_clip=False (default)', 'axlim_clip=True']) | ||
|
||
plt.show() |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see what this is likely for, but as these conditions appear uncovered by tests, I'm wondering what actually needed this change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe this is covered by
ax.text()
intest_axlim_clip
?