Array ordering for 2D calculations #392
Merged
Conversation
This file contains 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
By fixing the array ordering of these functions as xy, users are most frequently needing a large amount of transposes. Instead, we make it possible to specify the ordering. For now, we keep the same default, but issue a warning because we will change in 0.6. Add a decorator to change all incoming arrays as necessary based on the dim_order kwarg, and make all calculations assume y, x order so that they operate most efficiently on the common case.
Ensure that they work with asymmetric fields (to catch transpose problems). Also add a test for the warning when using the default array order.
dopplershift
added
Area: Calc
Closed
jrleeman
approved these changes
Apr 17, 2017
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 #389 . Adds a kwarg
dim_orderthat can be set to either'xy','yx', orNone, which uses the default. Currently the default is left to'xy', but a warning is issued if the default is used. Refactor all the calculations to use yx ordering internally (to be most efficient for the common case), and added a decorator to flip all incoming arrays based on dim_order.Also added some more tests to ensure that we're handling the transposes correctly (old tests had a lot of symmetric data).