Repository navigation
Conversation
Add a quiverkey_kwargs argument to motionfields.quiver and motion_plot. When given, a reference arrow is drawn with matplotlib's quiverkey. By default its length is the largest plotted vector rounded to one significant digit and the label uses px timestep^-1 units.
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #169
quiver()(andmotion_plot()withplot_type="quiver") now takes an optionalquiverkey_kwargsdict. If it is given, a reference arrow is added with matplotlib'squiverkey(). Anyquiverkey()argument can be passed (X, Y, U, label, labelpos, coordinates, color, ...). With an empty dict you get the defaults:"<U> px timestep$^{-1}$", as suggested in the issue, so it works for any data resolutionThe default (
quiverkey_kwargs=None) adds no key, so existing plots and the return value (the axes) don't change. Passingquiverkey_kwargswith a streamplot raises a ValueError.Example:
Testing: added tests in
pysteps/tests/test_plt_motionfields.pyfor no key by default, default U/label/position, U rounding (including zero and NaN fields), custom kwargs and the streamplot error. They fail on master and pass with this change.black --check .passes.Note: locally two existing tests in that file fail on master too, unrelated to this change (missing MeteoSwiss example data, and the synthetic streamplot case hitting matplotlib 3.11's "'y' must be strictly increasing" check).