perun.io.util
=============

.. py:module:: perun.io.util

.. autoapi-nested-parse::

   IO Util.



Functions
---------

.. autoapisummary::

   perun.io.util.getTFactorMag
   perun.io.util.value2ValueUnitStr
   perun.io.util.value2MeanStdStr


Module Contents
---------------

.. py:function:: getTFactorMag(value: numpy.number, metric_md: perun.data_model.measurement_type.MetricMetaData) -> Tuple[float, perun.data_model.measurement_type.Magnitude]

   Get transformation factor and magnitude to improve string formating.

   Parameters
   ----------
   value : np.number
       Reference value
   metric_md : MetricMetaData
       Value description

   Returns
   -------
   Tuple[float, Magnitude]
       Scaling factor and Magnitude Enum


.. py:function:: value2ValueUnitStr(value: numpy.number, metric_md: perun.data_model.measurement_type.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 : np.number
       Value to apply formating to.
   metric_md : MetricMetaData
       Value metadata.

   Returns
   -------
   str
       String represenation


.. py:function:: value2MeanStdStr(stats: perun.data_model.data.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