Update generate-percentiles Doc String #1923
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
bayliffe
reviewed
Jul 13, 2023
improver/cli/generate_percentiles.py
Outdated
Comment on lines
81
to
87
| be masked. If True, then where the percentile is higher than | ||
| the probability of the diagnostic existing the outputted | ||
| percentile will be masked. | ||
| The probability of being below the final threshold in | ||
| forecast_probabilities is used as the probability of the diagnostic | ||
| existing. | ||
| This is only implemented to work when converting |
There was a problem hiding this comment.
Suggested change
| be masked. If True, then where the percentile is higher than | |
| the probability of the diagnostic existing the outputted | |
| percentile will be masked. | |
| The probability of being below the final threshold in | |
| forecast_probabilities is used as the probability of the diagnostic | |
| existing. | |
| This is only implemented to work when converting | |
| be masked. This masking acts to cap the maximum percentile | |
| that can be generated for any grid point relative to the | |
| probability of exceeding the highest threshold at that point. | |
| For example, if the probability of a temperature exceeding 40C | |
| is 5%, the 95th and above percentiles will all be masked. | |
| Likewise, if at some grid point the probability of the cloud base | |
| being below 15000m (the highest threshold) is 0.7 then every | |
| percentile above the 70th would be masked. | |
| This is only implemented to work when converting |
There was a problem hiding this comment.
I've updated this part with a conglomeration of what you suggested and what I had originally written.
Codecov Report
@@ Coverage Diff @@
## master #1923 +/- ##
=======================================
Coverage 98.37% 98.37%
=======================================
Files 122 122
Lines 11707 11707
=======================================
Hits 11517 11517
Misses 190 190
|
bayliffe
approved these changes
Jul 27, 2023
brhooper
approved these changes
Aug 3, 2023
MoseleyS
pushed a commit
to MoseleyS/improver
that referenced
this pull request
Aug 22, 2024
* Clarifys docstring of generate-percentiles regarding mask_percentiles option * Updates doc string following review --------- Co-authored-by: Marcus Spelman <[email protected]>
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.
This PR updates the doc sting of generate-percentiles and related plugin to clarify the option mask_percentiles. This was requested by @bayliffe in the review of https://github.com/MetOffice/improver_suite/pull/1684
Testing: