nwm_metrics.event_metric_functions#

Functions to compute event-based metrics.

Functions:
  • identify_events: Conduct first-round event detection using hydrotools.events.event_detection.

  • separate_compound_events: Separate compound/multi-peak events into single-peak events.

  • pair_events: One-to-one pairing of observed and model events with optional virtual events.

  • compute_event_metrics: Compute event-based metrics given paired observed and model events.

  • preprocess_series: Resample to hourly and interpolate short gaps.

  • split_into_valid_chunks: Split time series into continuous NaN-free chunks.

  • plot_event_timeseries: Plot observed and simulated streamflow time series with event peak markers.

  • validate_events: Validate event chronology and non-overlap.

  • event_based_metrics: Compute event-based metrics: PKBIAS, PKTE, EVBIAS. Optionally, plot time series with event markers.

  • get_event_peaks: Get observed and modeled event peaks.

Functions

compute_event_metrics

Compute event-based metrics given paired observed and model events.

event_based_metrics

Compute event-based metrics: PKBIAS, PKTE, EVBIAS.

get_event_peaks

Get observed and modeled event peaks.

identify_events

Conduct first-round event detection using hydrotools.events.event_detection.

merge_short_events

Merge events shorter than the minimum duration with the nearest neighboring event.

pair_events

One-to-one pairing of observed and model events with optional virtual events.

plot_event_timeseries

Plot observed and simulated streamflow time series with event peak markers.

preprocess_series

Resample to hourly and interpolate short gaps.

separate_compound_events

Separate compound/multi-peak events into single-peak events.

split_into_valid_chunks

Split time series into continuous NaN-free chunks.

validate_events

Validate event chronology and non-overlap.