piel.types.metrics

Classes

ScalarMetric	Standard definition for a scalar metrics. It includes the value, mean, min, max, standard deviation and count.
ScalarMetricCollection	A collection of scalar metrics useful when analyzing multiple aspects of a design.

Module Contents

class ScalarMetric(/, **data: Any)

Bases: piel.types.connectivity.abstract.Instance

Standard definition for a scalar metrics. It includes the value, mean, min, max, standard deviation and count.

value: piel.types.core.NumericalTypes | None = None

mean: piel.types.core.NumericalTypes | None = None

min: piel.types.core.NumericalTypes | None = None

max: piel.types.core.NumericalTypes | None = None

standard_deviation: piel.types.core.NumericalTypes | None = None

count: piel.types.core.NumericalTypes | None = None

unit: piel.types.units.Unit

property data

property table

class ScalarMetricCollection(/, **data: Any)

Bases: piel.types.connectivity.abstract.Instance

A collection of scalar metrics useful when analyzing multiple aspects of a design.

metrics: list[ScalarMetric] = []

property data

property table

Composes a full table with the names and all the individual metrics that are part of this collection.

Returns:

A DataFrame containing all scalar metrics with their respective values.

Return type:

pd.DataFrame

__getitem__(index)

Allows for indexing and slicing of the metrics list.

Parameters:

index – An integer or slice object for indexing.

Returns:

A new ScalarMetricCollection containing the specified slice of metrics.