compute_pep_performance_metrics#

pepbench.data_handling.compute_pep_performance_metrics(results_per_sample: DataFrame, *, num_heartbeats: DataFrame | None = None, metrics: Sequence[str] | None = None, sortby: str_t | None = ('absolute_error_per_sample_ms', 'mean'), ascending: bool | None = True) → DataFrame[source]#

Compute the performance metrics for the PEP values.

Parameters:
results_per_samplepandas.DataFrame

The results-per-sample dataframe.

num_heartbeatspandas.DataFrame, optional

Dataframe containing the number of heartbeats (to include in the output). Default: None.

metricslist of str, optional

List of metrics to compute. Default: [“mean”, “std”].

sortbystr, optional

The column to sort the results by. Default: (“absolute_error_per_sample_ms”, “mean”).

ascendingbool, optional

Whether to sort the results in ascending order. Default: True.