sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-09-01 17:41:54 +01:00
Code Issues Releases Wiki Activity

derived: DerivedMeasurments now return DerivedMetrics

Browse Source 
DerivedMeasurments processors now return DerviedMetrics rather than
measurments. The notion of an InstrumentChannel doesn't really make
sense in the context of DerivedMeasurments, which are not directly
measured on the target. Since Measurement's require a channel, a simpler
DerviedMetric is added that only requires a name and a type.
This commit is contained in:
Sergei Trofimov
2017-09-07 11:13:34 +01:00
parent 8479af48c4
commit dd26b43ac5
4 changed files with 79 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
doc/derived_measurements.rst
View File

@@ -9,7 +9,7 @@ Example
-------
The following example shows how to use an implementation of a
:class:`DerivedMeasurement` to obtain a list of calculated ``Measurements``.
:class:`DerivedMeasurement` to obtain a list of calculated ``DerivedMetric``'s.
.. code-block:: ipython
@@ -42,9 +42,39 @@ Derived Measurements
.. method:: DerivedMeasurements.process(measurement_csv)
Returns a list of :class:`Measurement` objects that have been calculated.
Returns a list of :class:`DerivedMetric` objects that have been calculated.
Derived Metric
~~~~~~~~~~~~~~
.. class:: DerivedMetric
Represents a metric derived from previously collected ``Measurement``s.
Unlike, a ``Measurement``, this was not measured directly from the target.
.. attribute:: DerivedMetric.name
The name of the derived metric. This uniquely defines a metric -- two
``DerivedMetric`` objects with the same ``name`` represent to instances of
the same metric (e.g. computed from two different inputs).
.. attribute:: DerivedMetric.value
The ``numeric`` value of the metric that has been computed for a particular
input.
.. attribute:: DerivedMetric.measurement_type
The ``MeasurementType`` of the metric. This indicates which conceptual
category the metric falls into, its units, and conversions to other
measurement types.
.. attribute:: DerivedMetric.units
The units in which the metric's value is expressed.
Available Derived Measurements
-------------------------------
@@ -63,7 +93,7 @@ Available Derived Measurements
.. method:: DerivedEnergyMeasurements.process(measurement_csv)
Returns a list of :class:`Measurement` objects that have been calculated for
Returns a list of :class:`DerivedMetric` objects that have been calculated for
the average power and cumulative energy for each site.