piel.analysis.metrics.join
==========================

.. py:module:: piel.analysis.metrics.join


Functions
---------

.. autoapisummary::

   piel.analysis.metrics.join.concatenate_metrics_collection


Module Contents
---------------

.. py:function:: concatenate_metrics_collection(metrics_collection_list: list[piel.types.ScalarMetricCollection], **kwargs) -> piel.types.ScalarMetricCollection

   Concatenates multiple ScalarMetricCollection instances into a single ScalarMetricCollection.

   :param metrics_collection_list: List of ScalarMetricCollection instances to concatenate.
   :type metrics_collection_list: List[ScalarMetricCollection]

   :returns: A new ScalarMetricCollection containing all metrics from the input collections.
   :rtype: ScalarMetricCollection

   :raises ValueError: If the input list is empty.