Automatically generate a masking function using a OutputVar
#141
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #141 +/- ##
==========================================
+ Coverage 98.22% 98.25% +0.03%
==========================================
Files 11 11
Lines 1125 1149 +24
==========================================
+ Hits 1105 1129 +24
Misses 20 20 ☔ View full report in Codecov by Sentry. |
ph-kev
force-pushed
the
kp/auto-generate-masks
branch
4 times, most recently
from
a418913 to
2640c42
Compare
Refactor `_apply_lonlat_mask` to call `make_lonlat_mask`.
ph-kev
force-pushed
the
kp/auto-generate-masks
branch
2 times, most recently
from
dec436f to
4db1f19
Compare
Sbozzolo
approved these changes
Oct 25, 2024
docs/src/var.md
Outdated
Comment on lines
287
to
288
| `set_to_zero` returns `True`, then the value will be `0` in the mask and if `set_to_zero` | ||
| returns `False`, then the value will be `1` in the mask. See the example below of this |
There was a problem hiding this comment.
Suggested change
| `set_to_zero` returns `True`, then the value will be `0` in the mask and if `set_to_zero` | |
| returns `False`, then the value will be `1` in the mask. See the example below of this | |
| `set_to_zero` returns `true`, then the value will be `0` in the mask and if `set_to_zero` | |
| returns `false`, then the value will be `1` in the mask. See the example below of this |
ph-kev
force-pushed
the
kp/auto-generate-masks
branch
from
4db1f19 to
f3fe7af
Compare
The parameter `mask` for `plot_bias_on_globe!` now takes in either a mask used for visualizing (e.g. `Visualize.landmask`, `Visualize.oceanmask` or a vector of polygons) or a mask function (e.g. `Var.apply_landmask`, `Var.apply_oceanmask`, or a custom masking function).
ph-kev
force-pushed
the
kp/auto-generate-masks
branch
from
f3fe7af to
54daa37
Compare
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 #137 - This PR adds the function
Var.make_lonlat_maskwhich automatically generate a mask from aOutputVar. Additionally, one can specify the masking function when plotting the bias. See the plots below where a custom masking function (for computing the bias) is specified with an ocean mask (for visual purposes) for the plot.The
maskparameter now takes in a masking function or the predefined masksVisualize.oceanmask()andVisualize.landmask(). IfVisualize.oceanmask()andVisualize.landmask()are used, then the corresponding masking function for theOutputVaris chosen. If a masking function is used, then no mask for visual is used. In all other cases, it is assumed that the mask being used is for visuals and a warning is displayed that it will be overplotted and the colorbar might be wrong.