seismometer.plot.mpl.singleROC

seismometer.plot.mpl.singleROC(tpr, fpr, thresholds, conf_region=None, conf_interval=None, *, annotate=False, highlight=None, axis=None)

Creates an ROC plot.

Has the option to include a confidence region visually and interval in the legend. Can have annotations for thresholds generally or highlight specific ones.

Parameters:

  • tpr (pd.Series) – Series of true positive rates.

  • fpr (pd.Series) – Series of false positive rates.

  • thresholds (pd.Series) – Series of thresholds, used for annotations.

  • conf_region (Optional[_RocRegionResults], optional) – When specified, will display a confidence region on the curve, by default None.

  • conf_interval (Optional[ValueWithCI], optional) – When specified, will display the confidence interval on the legend, by default None.

  • annotate (bool, optional) – A flag to add annotations to the plot, by default False.

  • highlight (Optional[list[Number]], optional) – A list of thresholds to highlight on the plot, by default None.

  • axis (Optional[plt.Axes], optional) – The matplotlib axis to draw, by default None; creates a new figure.

Return type:

Figure