utils.metrics.DetectionMetrics

utils.metrics.DetectionMetrics(
    precision,
    recall,
    f1_score,
    true_positives,
    false_positives,
    false_negatives,
    n_detected,
    n_ground_truth,
    tolerance,
)

Container for transition detection evaluation metrics

Stores precision, recall, F1 score, and detailed counts from comparing detected transitions against ground truth.

Parameters

precision : float

Precision score (TP / (TP + FP))

recall : float

Recall score (TP / (TP + FN))

f1_score : float

F1 score (harmonic mean of precision and recall)

true_positives : int

Number of correct detections

false_positives : int

Number of incorrect detections

false_negatives : int

Number of missed ground truth events

n_detected : int

Total number of detections

n_ground_truth : int

Total number of ground truth events

tolerance : float

Maximum distance for matching detected to ground truth

Methods

Name Description
to_dict Convert metrics to dictionary.

to_dict

utils.metrics.DetectionMetrics.to_dict()

Convert metrics to dictionary.

Returns

: dict

Dictionary containing all metrics.