Skip to content

Fixes#17

Merged
tomsail merged 4 commits intomainfrom
fixes
Nov 3, 2025
Merged

Fixes#17
tomsail merged 4 commits intomainfrom
fixes

Conversation

@tomsail
Copy link
Copy Markdown
Contributor

@tomsail tomsail commented Oct 23, 2025

@tomsail
Copy link
Copy Markdown
Contributor Author

tomsail commented Oct 23, 2025

The renaming is as follows:

Old name New name Change summary
(new) Rx R1 or R3 is now a signed difference
Rx Rx_abs Rx_abs is an absolute difference.
Rx_norm Rx_abs_norm Clarified that it’s based on absolute difference and normalized.
diff error diff becomes error and is a signed difference
error abs_error abs_error is an absolute difference
error_norm abs_error_norm Renamed for clarity

It should also be well explained in the README:

The storm metrics: a PoT selection is done on the observed signal (using the match_extremes() function). Function returns the decreasing extreme event peak values for observed and modeled signals (and time lag between events).

  • R1: Difference between observed and modelled for the biggest storm
  • R1_abs: Absolute difference between observed and modelled for the biggest storm
  • R1_abs_norm: Absolute normalized difference between observed and modelled for the biggest storm
  • R3: Averaged difference between observed and modelled for the three biggest storms
  • R3_abs: Averaged absolute difference between observed and modelled for the three biggest storms
  • R3_abs_norm: Averaged normalised absolute difference between observed and modelled for the three biggest storms
  • error: Averaged difference between modelled values and observed detected storms
  • abs_error: Averaged absolute difference between modelled values and observed detected storms
  • abs_error_norm: Averaged normalised absolute difference between modelled values and observed detected storms

NB: for R1_abs/R3_abs/abs_error note that it is Averaged of the absolute and not Absolute of the averaged

@tomsail
Copy link
Copy Markdown
Contributor Author

tomsail commented Oct 23, 2025

@JackReevesEyre-NOAA I've added you as a reviewer too so could check the changes that might affect your pipelines.
Let me know if there is anything unclear

Copy link
Copy Markdown
Contributor

@JackReevesEyre-NOAA JackReevesEyre-NOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of minor documentation suggestions/queries. The calculation changes all look good. (And TBH I'm not too sure about the packaging/testing changes, so will just have to trust you that that's right!). Thanks!

- `R3_abs_norm`: Normalized R3 (R3 divided by observed value)
- `error`: Averaged difference between modelled values and observed detected storms
- `abs_error`: Averaged absolute difference between modelled values and observed detected storms
- `abs_error_norm`: Averaged normalised absolute difference between modelled values and observed detected storms
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this "averaged normalized" or "normalized averaged"?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I guess that doesn't make a difference....

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's "average of the normalized values". Each storm being normalized to the observed value.
I'm not sure how we could normalize all peaks to one observed value, that's why it cannot be "norm of the averaged values".
I think this important to precise this

Co-authored-by: JackReevesEyre-NOAA <104237899+JackReevesEyre-NOAA@users.noreply.github.com>
@tomsail tomsail merged commit 7ea1e05 into main Nov 3, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants