derived: DerivedMeasurments now return DerivedMetrics
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.
diff --git a/doc/derived_measurements.rst b/doc/derived_measurements.rst
index fcd497c..02a6daa 100644
--- a/doc/derived_measurements.rst
+++ b/doc/derived_measurements.rst
@@ -9,7 +9,7 @@
-------
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 @@
.. 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 @@
.. 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.