piel.analysis.metrics.join

Functions

concatenate_metrics_collection(...)

Concatenates multiple ScalarMetricCollection instances into a single ScalarMetricCollection.

Module Contents

concatenate_metrics_collection(metrics_collection_list: list[piel.types.ScalarMetricCollection], **kwargs) → piel.types.ScalarMetricCollection

Concatenates multiple ScalarMetricCollection instances into a single ScalarMetricCollection.

Parameters:

metrics_collection_list (List[ScalarMetricCollection]) – List of ScalarMetricCollection instances to concatenate.

Returns:

A new ScalarMetricCollection containing all metrics from the input collections.

Return type:

ScalarMetricCollection

Raises:

ValueError – If the input list is empty.