Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork8.1k
Plot limit with transform#731
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
jdh2358 commentedMar 17, 2012
Hey Phil, I just did a quick read through of this PR and it will take me much more time for me to have something intelligent to say. While I wrote the original transformations infrastructure,@mdboom did a thorough revamp of it for mpl 0.98 and he is the resident expert. So hopefully he will chime in here shortly. From my read, it is obvious that this is very careful, well thought out and well tested work, so congrats on successfully diving into one of the hairiest parts of the codebase. I don't use any exotic non-affine transformations in my own work, just the plain vanilla logarithmic scales, so I am not intimately familiar with many of the issues arising there. I do use the blended transformations quite a bit, and this leads me to my question. In the original bug you discuss: which produces incorrect datalim, you write "The result should be [10, 10, 20, 20]". It is not obvious to me that mpl is producing the incorrect result here. I'm not really disagreeing with you here, mainly looking to be educated. In the simple case of a "blended transformation" produced by axvline: In this case, even though the axvline has y coords in [0, 1], this does not affect the axes datalim y limits, because using the blended transform (x is data, y is axes) we do not consider the y coordinate to be in the data system at all. The line will span the y space regardless of the x data limits or view limits. Obviously when presented with a generic transformation, there is no way for mpl to infer this, so we give it a hint with the x_isdata and y_isdata which is then respected by update_from_path. I see you support this behavior in your comment about backwards compatibility in _update_line_limits Now this breaks down if I create the blended transformation on my own and do not set these x_isdata/y_isdata hints: In the original (pre-Michael refactor) transformation scheme, the dataLim gave the bounding box of theuntransformed data, the viewLim gave the bounding box of the view port, and the transformation took you from data limits to figure pixels. The reason the y-data in the blended axes lines like axvline were not considered was because these were already considered "pre-transformed" if you will, and hence not part of the data limits. Ie, only the raw, untransformed data were included in the datalim. This early scheme obviously wasn't robust enough to handle all the wonderful transformations we can now support following Michael's refactor, but he left those attributes (dataLim, viewLim) in for backwards compatibility, and I think some of the weirdness we are now seeing is a result of a more thorough treatment of transformations trying to maintain as much backwards compatibility as possible. I mention all of this just for historical context so you might understand why some of the weird things you are seeing are in there. I am not advocating slavish backwards compatibility, because I'd rather have a correct and robust system going forward, and you've done an admirable job in your patch supporting these idiosyncracies already. What I'm trying to understand is why the dataLim in the case of the initial bug you proposed should utilize the transform at all, when the dataLim in the other cases we have considered (log scales, polar transforms, funky blended transforms from axvline etc), all ignore the transformation. I haven't yet gotten to your second "quite confusing bug" :-) |
mdboom commentedMar 19, 2012
I have to agree with John that a lot of work has clearly been put into this pull request on some of the trickiest parts of the code, without much guidance from the original author (I've been busy on many non-matplotlib things lately). I hope we can (over time) simplify rather than further complicate the transforms system -- in the long term even by breaking backward compatibility if there's good benefits to doing so. Let me address each bug independently.
http://matplotlib.sourceforge.net/devel/add_new_projection.html?highlight=new%20projection And, as defining a scale is somewhat heavyweight, providing a new interface to handle the simple case where one just wants to provide a 1D transformation function would be a nice new features, IMHO. It's is also possible to transform the data before passing it to matplotlib. But of course, understanding your use case here better may help us arrive at an even better solution. As for 2): I agree it's a bug. Is there anyway you could pull out independently the solution just for that part? Also note you say the first result is correct -- I tend to agree, but with this pull request the former returns the same erroneous results as the latter.
Thanks for all your work on this -- it's great to have someone picking it apart and this level of detail. I hope I don't come across as discouraging pull requests -- in fact I'd love to pass this baton along and I think there's a lot of food for thought here. As for next steps, I think it might be most helpful to have an independent pull request just for#2, and continue to discuss ways of supporting the use case suggested by#1 (perhaps on a new issue). |
pelson commentedMar 20, 2012
Mike, John, Firstly, thank you very much for all of your time looking at this non trivial pull request, your feedback is massively valuable and I really appreciate it. I should add that normally when I say the word bug, it tends to mean "it is not behaving asI would expect"; I guess that is not its strict definition in the dictionary :-) .
Not at all. The beauty of github is that we can have in-depth discussions about how code should look and behave and I only see benefit from your input. John, your example is a good one. In my opinion the current behaviour is undesirable: It is my opinion that the
I guess this is the fundamental shift that this pull request is trying to achieve. The way the transform framework has been implemented means that there is great flexibility when it comes to handling data in different coordinate systems on the same plot (or projection in your terms) without having to "re-project" in advance (i.e. I can work in each datum's "native" coordinate system). Thanks to this I am able to plot polar data with a theta origin at This code pretty much just works with v1.1, except for the data limit calculation which currently assumes that I don't want to make this post to long, so I will leave it there for now with the hope that this has been sufficient to explain why I made this pull request and that it will help inform our discussion further. All the best, |
pelson commentedMay 1, 2012
Woops, I added (and have subsequently removed) a commit which I didn't intend to include. |
pelson commentedAug 5, 2012
@mdboom: I am still keen to get this functionality in before the 20th. It will need a little work to address some of your concerns, and I hope to avoid the need for |
pelson commentedAug 13, 2012
@mdboom: I have rebased and removed the use of The things which I think need discussion (please add more if you have anything) are:
I suggest we have these discussions in this PR, but try to keep the posts short-ish. If it gets a bit noisy, we can always use the devel mailing list. |
pelson commentedAug 13, 2012
A usecase for "pre-transforming" ones dataThe example I gave previously is my primary usecase for making it possible to plot data which is not necessarily in the The beauty of this interface is that it is so familiar to a mpl user that they can just pick it up and run. Apart from the need for me to expose a |
pelson commentedAug 13, 2012
Note: currently failing on py3 (http://travis-ci.org/#!/pelson/matplotlib/jobs/2109696) |
mdboom commentedAug 14, 2012
Ok --@pelson: does that mean you're working on a fix? I think, if we can, it would be nice to include this before the freeze to get it lots of random user testing before the release. This is one of the more "open heart surgery" PR's in the pipe. |
pelson commentedAug 14, 2012
No, but I will do in the next 3 hours or so.
Ha. I see what you mean. I agree that, because the unit tests don't have full coverage, the only way we can have confidence with code is to put it out in the wild. |
lib/matplotlib/patches.py Outdated
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.
@mdboom: Would you know what these (get_patch_transform andget_data_transform) are for? I would like to get a one liner for their purpose.
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.
Needs resolving before merging.
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.
data_transform maps the data coordinates to physical coordinates.
patch_transform maps the native coordinates of the patch to physical coordinates. For example, to draw a circle with a radius of 2, the original circle goes from (-1, -1) to (1, 1) (i.e. radius == 1), and the patch transform would scale it up to 2.
pelson commentedAug 14, 2012
Ok. I think this is in a good state now (changelog and tests polished a little). |
doc/api/api_changes.rst Outdated
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.
version number is wrong. Should be 1.2
pelson commentedAug 20, 2012
@mdboom: I don't know when you last read this, so I am holding back from rebasing as the only way you can have confidence in the rebase is to re-read the whole lot. Merging by hand at this point is probably a better bet. Are you happy to do this, or would you like me to do it? |
mdboom commentedAug 20, 2012
Why don't you address the small documentation changes and do a rebase -- it's probably easiest to comment on the rebase here as a pull request than in a manual merge. |
pelson commentedAug 20, 2012
Ok. Will do shortly. Just working on pickle PR. |
…shot is that the dataLim determination is now working.
…g (and updated appropriate test).
pelson commentedAug 20, 2012
Ok. The conflicts were to do with the test_transform.py and api_changes.rst and were pretty straight forward. This is now good to go as far as I can see. |
mdboom commentedAug 20, 2012
Thanks for the rebase -- I'll have another look at this today, but it may not be until later in the day. |
lib/matplotlib/lines.py Outdated
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.
Too long line.
mdboom commentedAug 21, 2012
Ok -- I think other than my nit about line length and filling in the docstrings for get_data_transform and get_patch_transform, I think this is good to go. |
pelson commentedAug 21, 2012
Thanks Mike. All done. |
This pull request represents a significant chunk of work to address a simple bug:
The result should be
[10, 10, 20, 20], but the offset transform has not been taken into account.Since a path transformation can be costly, it made sense to use the created Line's cached transform concept.
This threw up another, quite confusing bug:
The numbers themselves aren't important, suffice to say that the former is correct.
Additionally, the need for non-affine Transform subclasses to implement
transform_non_affineand also copy this definition intotransformtoo is confusing/obfuscating e.g.:This latter complaint is the result of an optimisation that will see little benefit (transform stacks are typically mostly Affine, and the non-affine part is easily cached).
Therefore this pull request represents a simplification (at the cost of a couple more function calls) of the current Transform framework. Whilst it is my opinion that the Transform class heirachy remains non-optimally representative of the problem space, I have tried to be pragmatic in my changes for both backwards compatibility and size of review considerations.
This pull request is independent of the invalidation mechanism upgrade being discussed in#723, and a merge between the two should be straight forward.
The tests run exactly the same as they did before commencing this work (they weren't passing on my machine in the first place, but the RMS values have not changed at all). The run time has gone up 5 seconds up to 458 seconds (~1% slower), but this includes the new tests as a result of this pull.
Note this change subtly affects the way one should implement a Transform. If you are implementing a non affine transformation, then you should
override the transform_non_affine, rather than overriding the transform & copying the transform into transform_non_affine too. e.g.:
The documentation is still representative of this change, hence there are few documentation changes included in this pull request.