geoprior.scripts.plot_hotspot_analytics

Script helpers for plotting hotspot analytics.

Functions

build_hotspot_tables(*, city, color, ...)	Build point/year hotspot tables for one city.
exceed_prob_from_quantiles(q10, q50, q90, *, ...)
main([argv, prog])
plot_hotspot_analytics(*, cities, ...[, ...])
plot_hotspot_analytics_main([argv, prog])

Classes

CityHotspotData(city, color, years, ...)

geoprior.scripts.plot_hotspot_analytics.exceed_prob_from_quantiles(q10, q50, q90, *, threshold)

Parameters:

• q10 (ndarray)

• q50 (ndarray)

• q90 (ndarray)

• threshold (float)

Return type:

ndarray

class geoprior.scripts.plot_hotspot_analytics.CityHotspotData(city: 'str', color: 'str', years: 'list[int]', base_year: 'int', df_points: 'pd.DataFrame', df_years: 'pd.DataFrame', extent: 'tuple[float, float, float, float]')

Bases: object

Parameters:

• city (str)

• color (str)

• years (list[int])

• base_year (int)

• df_points (DataFrame)

• df_years (DataFrame)

• extent (tuple[float, float, float, float])

city: str

color: str

years: list[int]

base_year: int

df_points: DataFrame

df_years: DataFrame

extent: tuple[float, float, float, float]

__init__(city, color, years, base_year, df_points, df_years, extent)

Parameters:

• city (str)

• color (str)

• years (list[int])

• base_year (int)

• df_points (DataFrame)

• df_years (DataFrame)

• extent (tuple[float, float, float, float])

Return type:

None

geoprior.scripts.plot_hotspot_analytics.build_hotspot_tables(*, city, color, eval_df, fut_df, years, base_year, subsidence_kind, hotspot_q, risk_threshold, use_abs_risk, hotspot_rule, hotspot_abs, risk_min, exposure_df, exposure_col, exposure_default)

Build point/year hotspot tables for one city.

Robust points:

• If kind="cumulative", annual rates are derived via diffs. For the first requested year, the previous year is included automatically when available, preferring future data and otherwise evaluation data.

• The hotspot rule can be percentile, abs, risk, or combo.

• Risk can be exposure-weighted as \(P * |\Delta s| * exposure\).

Returns CityHotspotData with df_points for the requested per-point metrics and df_years for the requested per-year summaries.

Parameters:

• city (str)

• color (str)

• eval_df (DataFrame)

• fut_df (DataFrame)

• years (list[int])

• base_year (int)

• subsidence_kind (str)

• hotspot_q (float)

• risk_threshold (float)

• use_abs_risk (bool)

• hotspot_rule (str)

• hotspot_abs (float | None)

• risk_min (float | None)

• exposure_df (DataFrame | None)

• exposure_col (str)

• exposure_default (float)

Return type:

CityHotspotData

geoprior.scripts.plot_hotspot_analytics.plot_hotspot_analytics(*, cities, focus_year, grid_res, clip, cmap_metric, cmap_prob, persistence_mode, cluster_top, risk_threshold, show_legend, show_title, show_panel_titles, title, out, out_points, out_years, out_clusters, timeline_mode, timeline_overlay_current, dpi, font, cluster_rank, add_persistence, add_compare, compare_metric, hotspot_rule, hotspot_abs, risk_min, ns_future_b=None, zh_future_b=None, gdf=None)

Parameters:

• cities (list[CityHotspotData])

• focus_year (int)

• grid_res (int)

• clip (float)

• cmap_metric (str)

• cmap_prob (str)

• persistence_mode (str)

• cluster_top (int)

• risk_threshold (float)

• show_legend (bool)

• show_title (bool)

• show_panel_titles (bool)

• title (str | None)

• out (str)

• out_points (str | None)

• out_years (str | None)

• out_clusters (str | None)

• timeline_mode (str)

• timeline_overlay_current (bool)

• dpi (int)

• font (int)

• cluster_rank (str)

• add_persistence (bool)

• add_compare (bool)

• compare_metric (str)

• hotspot_rule (str)

• hotspot_abs (float | None)

• risk_min (float | None)

• ns_future_b (str | None)

• zh_future_b (str | None)

• gdf (Any | dict[str, Any] | None)

Return type:

None

geoprior.scripts.plot_hotspot_analytics.plot_hotspot_analytics_main(argv=None, *, prog=None)

Parameters:

• argv (list[str] | None)

• prog (str | None)

Return type:

None

geoprior.scripts.plot_hotspot_analytics.main(argv=None, *, prog=None)

Parameters:

• argv (list[str] | None)

• prog (str | None)

Return type:

None