environmentaltools.graphics.pot_lmom

environmentaltools.graphics.pot_lmom(info, nvar, file_name: str = None)[source]

Plot Peaks Over Threshold analysis results using L-moments method.

Generates a comprehensive visualization of POT analysis including parameter stability, goodness-of-fit statistics, and return period estimates across different threshold values.

Parameters:

  • info (dict) – Dictionary containing POT analysis results with keys: - ‘thresholds’: Array of threshold values tested - ‘mean_value_lmom’: Mean parameter estimates (location, shape, scale) - ‘upper_lim’, ‘lower_lim’: Confidence interval bounds - ‘au2_lmom’: Anderson-Ruiz squared statistic values - ‘au2pv_lmom’: Complementary p-values (1 - p_value) - ‘tr_eval’: Return periods evaluated - ‘nyears’: Number of years in dataset

  • nvar – Variable identifier (currently unused).

  • file_name (str, optional) – Path to save the figure. If None, displays interactively. Defaults to None.

Returns:

Displays or saves the plot.

Return type:

None

Note

The optimal threshold is automatically selected as the one minimizing the complementary p-value (au2pv_lmom).