add kwarg to local exceedance intensity to change value ordering - #1285
ValentinGebhart wants to merge 2 commits into
Conversation
Sorry, something went wrong.
|
Example usage: client = Client()
haz_tc_haiti = client.get_hazard(
"tropical_cyclone",
properties={
"country_name": "Haiti",
"climate_scenario": "historical",
"nb_synth_tracks": "10",
},
)
local_exceedance_intensity, title, column_label = (
haz_tc_haiti.local_exceedance_intensity(return_periods=[50, 200])
)
axes = plot_from_gdf(local_exceedance_intensity, title, column_label, figsize=(8, 4))
2. Hazard with negative values but usual ordering (e.g., Temperatures in degrees Celsius) shift_intensity = -100.0
haz_neg_usual_order = copy.deepcopy(haz_tc_haiti)
haz_neg_usual_order.intensity = sparse.csr_matrix(
haz_tc_haiti.intensity.toarray() + shift_intensity
)
local_exceedance_intensity, title, column_label = (
haz_neg_usual_order.local_exceedance_intensity(
return_periods=[50, 200],
min_intensity=-1e10,
log_intensity=False,
log_frequency=False,
)
)
axes = plot_from_gdf(local_exceedance_intensity, title, column_label, figsize=(8, 4))
3. Hazard with negative values and inverse ordering (e.g., more negative is more serious, like the SPIE drought index) haz_neg_inverse_order = copy.deepcopy(haz_tc_haiti)
haz_neg_usual_order.intensity = -1 * haz_tc_haiti.intensity
local_exceedance_intensity, title, column_label = (
haz_neg_usual_order.local_exceedance_intensity(
return_periods=[50, 200],
min_intensity=-1e10,
log_intensity=False,
log_frequency=False,
reverse=True,
)
)
axes = plot_from_gdf(
local_exceedance_intensity, title, column_label, figsize=(8, 4), cmap="viridis_r"
)
|
Sorry, something went wrong.
luseverin
left a comment
There was a problem hiding this comment.
I've had a look and it looks sensible to me. The examples added in the notebook are helpful. I would also add in the Notes section of the docstrings of the functions when you are supposed to set reverse=True, e.g.
Use reverse=True when smaller hazard intensities correspond to higher impacts, e.g. in the case of negative winter temperatures or drought indices such as SPEI.
or something similar. Otherwise it looks good to me.
Sorry, something went wrong.
|
there is only one test with reverse=False parameter and this one fails. can we have some more tests? |
Sorry, something went wrong.
Changes proposed in this PR:
This PR addresses #1257.
PR Author Checklist
PR Reviewer Checklist