piel.analysis.signals.dc.metrics#

Functions#

`compile_dc_min_max_metrics_from_dc_collection`(...)	Compiles DC analysis metrics from a list of SignalDCCollection instances into a final DataFrame.
`compile_dc_transition_metrics_from_dc_collection`(...)	Compiles DC analysis metrics from a list of SignalDCCollection instances into a final DataFrame.

Module Contents#

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[source]#

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

Parameters:

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

Returns:

A DataFrame containing the compiled metrics with combined min-max columns.

Return type:

pd.DataFrame

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[source]#