Source code for perun.io.util

"""IO Util."""

from typing import Tuple

from perun.data_model.data import Stats
from perun.data_model.measurement_type import Magnitude, MetricMetaData, Number, Unit




[docs]
def getTFactorMag(value: Number, metric_md: MetricMetaData) -> Tuple[float, Magnitude]:
    """Get transformation factor and magnitude to improve string formating.

    Parameters
    ----------
    value : Number
        Reference value
    metric_md : MetricMetaData
        Value description

    Returns
    -------
    Tuple[float, Magnitude]
        Scaling factor and Magnitude Enum
    """
    if (
        metric_md.unit == Unit.WATT
        or metric_md.unit == Unit.JOULE
        or metric_md.unit == Unit.BYTE
    ):
        transformFactor = 1
        for mag in reversed(Magnitude):
            if value > mag.value:
                transformFactor = mag.value
                break

        newMag = Magnitude(metric_md.mag.value * transformFactor)
        return transformFactor, newMag

    elif metric_md.unit == Unit.PERCENT:
        return 1.0, metric_md.mag
    elif metric_md.unit == Unit.SECOND:
        return 1.0, Magnitude.ONE
    else:
        return 1.0, metric_md.mag






[docs]
def value2ValueUnitStr(value: Number, metric_md: MetricMetaData) -> str:
    """Return a printable representation as [Value:.3f][mag][unit] (e.g. 3.05mV) of the value based on its metric metadata.

    Parameters
    ----------
    value : Number
        Value to apply formating to.
    metric_md : MetricMetaData
        Value metadata.

    Returns
    -------
    str
        String represenation
    """
    tfactor, new_mag = getTFactorMag(value, metric_md)
    return f"{value / tfactor:.3f} {new_mag.symbol}{metric_md.unit.value}"






[docs]
def value2MeanStdStr(stats: Stats) -> str:
    """Return a printable representation as [Value:.3f]±[std:.3f][mag][unit] (e.g. 3.05±0.1mV) of the value based on its metric metadata.

    Parameters
    ----------
    stats : Stats obj
        Stats to apply formating to.
    metric_md : MetricMetaData
        Value metadata.

    Returns
    -------
    str
        String represenation
    """
    tfactor, new_mag = getTFactorMag(stats.mean, stats.metric_md)
    return f"{stats.mean / tfactor:.2f} ± {stats.std / tfactor:.2f} {new_mag.symbol}{stats.metric_md.unit.value}"