piel.analysis.metrics#

Submodules#

Functions#

`aggregate_scalar_metrics_collection`(...)	Aggregates a ScalarMetricCollection into a single ScalarMetrics instance.
`rename_metrics_collection`(...)	Renames each metric in the provided ScalarMetricCollection with the corresponding name from new_names.
`convert_scalar_metric_unit`(→ piel.types.ScalarMetric)	Converts the units of a single ScalarMetrics instance to the target unit.
`convert_metric_collection_units_per_metric`(...)	Converts the units of metrics in a ScalarMetricCollection to the target units.
`convert_metric_collection_per_unit`(...)	Converts the units of metrics in a ScalarMetricCollection based on unit names.
`concatenate_metrics_collection`(...)	Concatenates multiple ScalarMetricCollection instances into a single ScalarMetricCollection.

Package Contents#

aggregate_scalar_metrics_collection(metrics_collection: piel.types.ScalarMetricCollection) → piel.types.ScalarMetric[source]#

Aggregates a ScalarMetricCollection into a single ScalarMetrics instance.

The aggregation is performed as follows: - mean: Weighted mean based on count. - min: Minimum of all min values. - max: Maximum of all max values. - standard_deviation: Combined standard deviation considering individual means and counts. - count: Sum of all counts. - unit: Must be consistent across all ScalarMetrics.

Parameters:: metrics_collection (ScalarMetricCollection) – A ScalarMetricsCollection instances to aggregate.
Returns:: A single ScalarMetrics instance representing the aggregated metrics.
Return type:: ScalarMetric
Raises:: ValueError – If the input list is empty or units are inconsistent.

rename_metrics_collection(collection: piel.types.ScalarMetricCollection, new_names: list[str]) → piel.types.ScalarMetricCollection[source]#

Renames each metric in the provided ScalarMetricCollection with the corresponding name from new_names.

Parameters:

collection (ScalarMetricCollection) – The original metric collection.
new_names (List[str]) – A list of new names for the metrics.

Returns:

A new metric collection with renamed metrics.

Return type:

ScalarMetricCollection

Raises:

ValueError – If the number of new names does not match the number of metrics.

convert_scalar_metric_unit(metric: piel.types.ScalarMetric, target_unit: piel.types.Unit) → piel.types.ScalarMetric[source]#

Converts the units of a single ScalarMetrics instance to the target unit.

Parameters:

metric (ScalarMetric) – The original scalar metric.
target_unit (Unit) – The target unit to convert to.

Returns:

A new ScalarMetrics instance with converted values and updated unit.

Return type:

ScalarMetric

Raises:

ValueError – If the original unit and target unit have different ‘datum’.

convert_metric_collection_units_per_metric(collection: piel.types.ScalarMetricCollection, target_units: dict[str, piel.types.Unit]) → piel.types.ScalarMetricCollection[source]#

Converts the units of metrics in a ScalarMetricCollection to the target units.

Parameters:

collection (ScalarMetricCollection) – The original metric collection.
target_units (dict[str, Unit]) –
- If a dictionary is provided, keys should be metrics names and values are the target Units.

Returns:

A new ScalarMetricCollection with converted metrics.

Return type:

ScalarMetricCollection

Raises:

ValueError – If target_units is a dict and a metric name is missing, or if any unit conversion is invalid.

convert_metric_collection_per_unit(collection: piel.types.ScalarMetricCollection, target_units: dict[str, piel.types.Unit]) → piel.types.ScalarMetricCollection[source]#

Converts the units of metrics in a ScalarMetricCollection based on unit names.

Parameters:

collection (ScalarMetricCollection) – The original metric collection.
target_units (dict[str, Unit])

Returns:

A new ScalarMetricCollection with converted metrics.

Return type:

ScalarMetricCollection

Raises:

ValueError – If target_units is a dict and a metric’s unit name is missing, or if any unit conversion is invalid.

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

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.