piel.analysis.signals.dc.metrics
================================

.. py:module:: piel.analysis.signals.dc.metrics


Functions
---------

.. autoapisummary::

   piel.analysis.signals.dc.metrics.compile_dc_min_max_metrics_from_dc_collection
   piel.analysis.signals.dc.metrics.compile_dc_transition_metrics_from_dc_collection


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

.. py:function:: compile_dc_min_max_metrics_from_dc_collection(collections: list[piel.types.SignalDCCollection], label_list: list[str], label_column_name: str = 'label', threshold_kwargs: dict = None, debug: bool = False, **kwargs) -> pandas.DataFrame

   Compiles DC analysis metrics from a list of SignalDCCollection instances into a final DataFrame.

   :param collections: List of SignalDCCollection instances to analyze.
   :type collections: List[SignalDCCollection]
   :param label_list: List of labels corresponding to each SignalDCCollection.
   :type label_list: List[str]
   :param threshold_kwargs: Threshold kwargs for the transition transmission. Defaults to None.
   :type threshold_kwargs: dict, optional
   :param label_column_name: How the label column should be called. Defaults to "label".
   :type label_column_name: str, optional
   :param debug: If True, raises exceptions during processing. Defaults to False.
   :type debug: bool, optional
   :param \*\*kwargs: Additional keyword arguments for pd.DataFrame.

   :returns: A DataFrame containing the compiled metrics with combined min-max columns.
   :rtype: pd.DataFrame


.. py:function:: compile_dc_transition_metrics_from_dc_collection(collections: list[piel.types.SignalDCCollection], label_list: list[str], label_column_name: str = 'label', threshold_kwargs: dict = None, debug: bool = False, **kwargs) -> pandas.DataFrame

   Compiles DC analysis metrics from a list of SignalDCCollection instances into a final DataFrame.

   :param collections: List of SignalDCCollection instances to analyze.
   :type collections: List[SignalDCCollection]
   :param label_list: List of labels corresponding to each SignalDCCollection.
   :type label_list: List[str]
   :param threshold_kwargs: Threshold kwargs for the transition transmission. Defaults to None.
   :type threshold_kwargs: dict, optional
   :param label_column_name: How the label column should be called. Defaults to "label".
   :type label_column_name: str, optional
   :param debug: If True, raises exceptions during processing. Defaults to False.
   :type debug: bool, optional
   :param \*\*kwargs: Additional keyword arguments for pd.DataFrame.

   :returns: A DataFrame containing the compiled metrics with combined min-max columns.
   :rtype: pd.DataFrame