piel.analysis.signals.time.core.metrics

piel.analysis.signals.time.core.metrics#

Functions#

extract_mean_metrics_list(...)

Extracts scalar metrics from a collection of rising edge signals. Standard deviation is not calculated as this just

extract_peak_to_peak_metrics_list(...)

Extracts peak-to-peak metrics from a collection of signals. The peak-to-peak value is defined as the

extract_multi_time_signal_statistical_metrics(...)

Extracts scalar metrics from a collection of rising edge signals.

extract_statistical_metrics_collection(...)

Extracts a collection of scalar metrics from a collection of rising edge signals based on multiple analysis types.

Module Contents#

extract_mean_metrics_list(multi_data_time_signal: piel.types.MultiTimeSignalData, **kwargs) → piel.types.ScalarMetricCollection[source]#

Extracts scalar metrics from a collection of rising edge signals. Standard deviation is not calculated as this just computes individual metrics list.

Parameters:

multi_data_time_signal (List[TimeSignalData]) – A list of rising edge signals.

Returns:

A collection of ScalarMetric instances containing the extracted metrics.

Return type:

ScalarMetricCollection

extract_peak_to_peak_metrics_list(multi_data_time_signal: piel.types.MultiTimeSignalData, metric_kwargs_list: list[dict] = None, **kwargs) → piel.types.ScalarMetricCollection[source]#

Extracts peak-to-peak metrics from a collection of signals. The peak-to-peak value is defined as the difference between the maximum and minimum values of the signal.

Parameters:

multi_data_time_signal (MultiTimeSignalData) – A collection of time signals to analyze.

Returns:

A collection of ScalarMetric instances containing the peak-to-peak values

for each signal.

Return type:

ScalarMetricCollection

Raises:

ValueError – If the input list is empty or any signal has an empty data array.

extract_multi_time_signal_statistical_metrics(multi_data_time_signal: piel.types.MultiTimeSignalData, analysis_type: piel.types.EdgeTransitionAnalysisTypes = 'peak_to_peak', **kwargs) → piel.types.ScalarMetric[source]#

Extracts scalar metrics from a collection of rising edge signals.

Parameters:

  • multi_data_time_signal (List[TimeSignalData]) – A list of rising edge signals.

  • analysis_type (piel.types.EdgeTransitionAnalysisTypes) – The type of analysis to perform.

Returns:

Aggregated ScalarMetrics instance containing the extracted metrics.

Return type:

ScalarMetric

extract_statistical_metrics_collection(multi_data_time_signal: piel.types.MultiTimeSignalData, analysis_types: list[piel.types.EdgeTransitionAnalysisTypes], **kwargs) → piel.types.ScalarMetricCollection[source]#

Extracts a collection of scalar metrics from a collection of rising edge signals based on multiple analysis types.

Parameters:

  • multi_data_time_signal (MultiTimeSignalData) – A collection of rising edge signals.

  • analysis_types (list[EdgeTransitionAnalysisTypes], optional) – The types of analyses to perform. Defaults to [“peak_to_peak”].

Returns:

A collection of aggregated ScalarMetric instances for each analysis type.

Return type:

ScalarMetricCollection

Contents