Add errorbars to mplot3d #8031
Add errorbars to mplot3d #8031
Conversation
|
(sent this earlier, but it hasn't shown up yet, so I am posting this again) Heads up. There is another PR that is adding a new feature to errorbar that might need to be considered here, too: #6280 This looks neat. The marker problem is difficult to handle correctly and there isn't any framework for dealing with it partly because mplot3d does not properly integrate into the overall transforms system. Markers are actually avoided in Axis3D for ticks partly because of the difficulty in orienting and sizing them correctly. Now, it isn't impossible to get them right. Depending on the marker, they are implemented as PolyCollection or PatchCollection, if I remember correctly. Both of these have 3D analogs as Poly3DCollection and Patch3DCollection. In |
|
@WeatherGod I implemented (read: copied over from #6280) the tuple offsets for
I briefly looked over the marker issue again, but I can't find a way to improve it with the |
|
Not sure why Travis fails, could someone give a tip on how to fix this? Seems unrelated to me. |
|
@vlas-sokolov Let's figure out what to do with #6280 (review) before including the extended version of |
|
@anntzer all right then, standing by. |
|
I completely missed that this PR came in, cool work! What is the current state of this? |
|
@tacaswell all the basic functionality should be there already. There is, however, an issue with using the markers in limit symbols - I didn't figure out how to rotate them in 3d properly, so certain projections look wrong for the marker caps. Perhaps it is wiser to draw the caps / limits with lines instead. Also, following @WeatherGod's suggestion to add |
|
I've finished addressing the remaining issues on the PR, and it's ready for the final review. Here's how the new feature looks at the moment: fig = plt.figure()
ax = fig.gca(projection="3d")
d = [1,2,3,4,5]
e = [.5]*5
f = [[.5]*5, [.2, .1, 1.1, 0.5, .2]]
ax.errorbar(x=d, y=d, z=d, xerr=f, yerr=e, zerr=e, capsize=3,
zuplims=[False, True, False, True, True],
zlolims=[True, False, False, True, False],
yuplims=True,
arrow_length_ratio=0.6,
ecolor='purple', label='Error lines')
ax.legend()
|
Co-authored-by: Eric Wieser <[email protected]>
|
Can someone let me know if I can do anything to make the coveted "Approved" check mark happen sooner? |
|
I've fixed the merge conflict against the latest master branch. |
|
The 2D |
|
@QuLogic I've ported most of the changes over to the 3d version. |
| label=label) | ||
| self.containers.append(errorbar_container) | ||
|
|
||
| return errlines, caplines, limmarks |
There was a problem hiding this comment.
Is there a reason to return these instead of the ErrorbarContainer?
There was a problem hiding this comment.
Yes. The errorbar container here is used only to make the legends work properly. To make this container, I have to "pretend" the data is in 2d, so if we would return the ErrorbarContainer, then we'd lose all the information on the 3rd axis. As per my comment above, I simply could not get the 3D container to work and the containers aren't used in other places in axes3d.py, so I stick to returning a tuple of drawn elements.
| minz, maxz = _digout_minmax(coorderrs, 'z') | ||
| self.auto_scale_xyz((minx, maxx), (miny, maxy), (minz, maxz), had_data) | ||
|
|
||
| # Adapting errorbar containers for 3d case, assuming z-axis points "up" |
There was a problem hiding this comment.
Would it maybe be better to create an Errorbar3DContainer instead?
There was a problem hiding this comment.
I have tried subclassing ErrorbarContainer but it resulted in quite a few errors that I failed to fix. I would suggest postponing that, given that no other axes3d methods rely on containers yet.
|
I would like that we figure out kwarg handling (#17930) before releasing this, but it doesn't have to block merging (I can rebase that and update 3D too.) |
Co-authored-by: Elliott Sales de Andrade <[email protected]>
|
I'm not sure if the latest commit did anything to cause the tests to break - I removed the tolerance from errorbar tests but it doesn't seem the failures came from there? |
|
No there was a pandas incompatibility. Should be fixed if you rebase on master. |
|
Ooops, no this isn't the pandas thing, but some other issue with CI, but not an issue w/ your PR.... |
|
I restarted them; it seems they're fine. |
There was a problem hiding this comment.
I admit to only skimming this, but @QuLogic gave it a long review, and its had input from @eric-wieser If there are follow up fixes we have some time before 3.4
Motivated by the 'new-contributor-friendly' and 'wishlist' tags in #568, and having once asked this question on SO, this PR mimics the errorbar functionality present in the standard lib into
mplot3d.For a demonstration, I have rewritten a short snippet from here into and put in on Gist. It generates the figures below:
The new function was rewritten from its 2D counterpart. I aimed to follow the old structure as close as possible, and I think that most of the optional keywords have been successfully ported.
One issue that I'd like to get input in is the use of markers in error bar caps and (especially) limit symbols. The markers tend to rotate along with the camera position, and a 180 degree rotation along one of the axes may flip the markers into a rather confusing plot. What should be done with this? Is there a framework for projecting the markers in mplot3d?
As I'm a new contributor and might have missed some subtleties in the implementation, any feedback is highly appreciated!