oml-plot-tools 0.9.1__py3-none-any.whl

oml_plot_tools/__init__.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+
+# This file is a part of IoT-LAB oml-plot-tools
+# Copyright (C) 2015 INRIA (Contact: admin@iot-lab.info)
+# Contributor(s) : see AUTHORS file
+#
+# This software is governed by the CeCILL license under French law
+# and abiding by the rules of distribution of free software.  You can  use,
+# modify and/ or redistribute the software under the terms of the CeCILL
+# license as circulated by CEA, CNRS and INRIA at the following URL
+# http://www.cecill.info.
+#
+# As a counterpart to the access to the source code and  rights to copy,
+# modify and redistribute granted by the license, users are provided only
+# with a limited warranty  and the software's author,  the holder of the
+# economic rights,  and the successive licensors  have only  limited
+# liability.
+#
+# The fact that you are presently reading this means that you have had
+# knowledge of the CeCILL license and that you accept its terms.
+
+"""List of tools to display iot-lab oml generated files"""
+
+__version__ = "0.9.1"

oml_plot_tools/common.py

@@ -0,0 +1,172 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# This file is a part of IoT-LAB oml-plot-tools
+# Copyright (C) 2015 INRIA (Contact: admin@iot-lab.info)
+# Contributor(s) : see AUTHORS file
+#
+# This software is governed by the CeCILL license under French law
+# and abiding by the rules of distribution of free software.  You can  use,
+# modify and/ or redistribute the software under the terms of the CeCILL
+# license as circulated by CEA, CNRS and INRIA at the following URL
+# http://www.cecill.info.
+#
+# As a counterpart to the access to the source code and  rights to copy,
+# modify and redistribute granted by the license, users are provided only
+# with a limited warranty  and the software's author,  the holder of the
+# economic rights,  and the successive licensors  have only  limited
+# liability.
+#
+# The fact that you are presently reading this means that you have had
+# knowledge of the CeCILL license and that you accept its terms.
+
+"""Common functions for all oml types"""
+
+# Issues with numpy
+# pylint:disable=no-member
+
+from collections import OrderedDict, namedtuple
+
+import matplotlib.pyplot as plt
+import numpy
+
+OML_HEADER_LEN = 9
+
+OML_TYPES = {
+    "consumption": 1,
+    "radio": 2,
+    "event": 3,
+    "sniffer": 4,
+    "robot_pose": 10,
+}
+
+TIMESTAMP_LABEL = "Sample Time (sec)"
+OML_FIELDS = [
+    ("timestamp", float),
+    ("type", numpy.str_, 16),
+    ("num", int),
+    ("t_s", int),
+    ("t_us", int),
+]
+
+MeasureTuple = namedtuple("MeasureTuple", ["name", "type", "label"])
+
+
+def measures_dict(*measures_tuples):
+    """Create a dict of 'MeasuresTuple' with given measures"""
+    measures_list = [(m[0], MeasureTuple(*m)) for m in measures_tuples]
+    return OrderedDict(measures_list)
+
+
+def oml_load(filename, meas_type, measures):
+    """Load oml file
+    :returns: numpy array
+    :measures: list of MeasureTuple"""
+
+    meas_dtypes = [(m.name, m.type) for m in measures]
+
+    try:
+        data = _oml_read(filename, meas_type, meas_dtypes)
+    except IOError as err:
+        raise ValueError(f"Error opening oml file:\n{err}\n")
+    except (ValueError, StopIteration, IndexError) as err:
+        raise ValueError(f"Error reading oml file:\n{err}\n")
+    except TypeError as err:
+        raise ValueError(f"{err}")
+
+    # No error when only one value
+    data = numpy.atleast_1d(data)
+
+    # No empty measures
+    # I think not reproducible anymore with genfromtxt however.
+    if array_empty(data):  # pragma: no cover
+        raise ValueError("No values, not an oml file")
+
+    return data
+
+
+def oml_plot_clock(data, title="Clock time verification"):
+    """Print clock diff between measures
+    :params data: oml_load returned array
+    """
+    time = data["timestamp"]
+    clock_diff = numpy.diff(time) * 1000
+
+    print(f"Time from {time[0]:f} to {time[-1]:f}")
+    print("NB Points      =", len(time))
+    print("Duration    (s)=", time[-1] - time[0])
+    print("Steptime   (ms)=", 1000 * (time[-1] - time[0]) / len(time))
+    print("Clock mean (ms)=", numpy.mean(clock_diff))
+    print("Clock std  (ms)=", numpy.std(clock_diff))
+    print("Clock max  (ms)=", numpy.max(clock_diff))
+    print("Clock min  (ms)=", numpy.min(clock_diff))
+
+    plt.figure()
+    plt.title(title)
+    plt.grid()
+    plt.plot(clock_diff)
+
+    return True
+
+
+def plot(data, title, field, ylabel, xlabel=TIMESTAMP_LABEL):
+    """Plot data"""
+    plt.title(title)
+    plt.grid()
+    plt.xlabel(xlabel)
+    plt.ylabel(ylabel)
+    plt.plot(data["timestamp"], data[field])
+
+
+def plot_show():
+    """Show image."""
+    plt.tight_layout()
+    plt.show()
+
+
+# Help functions
+
+
+def _oml_read(filename, meas_type, fields_dtypes=()):
+    """Read oml file
+    :measures: list of MeasureTuple"""
+
+    # Select values
+    dtypes = OML_FIELDS + list(fields_dtypes)
+    names = [entry[0] for entry in dtypes]
+
+    # Read values from file
+    c_meas_type = {names.index("type"): _valid_oml_f(meas_type)}
+    data = numpy.genfromtxt(
+        filename,
+        skip_header=OML_HEADER_LEN,
+        names=names,
+        dtype=dtypes,
+        converters=c_meas_type,
+        invalid_raise=False,
+    )
+
+    # Update 'timestamp' field with the cn calculated timestamp
+    for row in numpy.nditer(data, op_flags=["readwrite"]):
+        timestamp = row["t_s"] + row["t_us"] / 1e6
+        row["timestamp"] = timestamp
+
+    return data
+
+
+def _valid_oml_f(meas_type):
+    """Return a function that validates oml type"""
+
+    def _validate(value):
+        """Check that 'meas_type' column matchs requested"""
+        value = int(value)
+        if int(value) == OML_TYPES[meas_type]:
+            return meas_type
+        raise TypeError(f"OML file is not: {meas_type}")
+
+    return _validate
+
+
+def array_empty(array):
+    """Test if array is not None or not empty."""
+    return array is None or len(array) == 0

oml_plot_tools/consum.py

@@ -0,0 +1,187 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# This file is a part of IoT-LAB oml-plot-tools
+# Copyright (C) 2015 INRIA (Contact: admin@iot-lab.info)
+# Contributor(s) : see AUTHORS file
+#
+# This software is governed by the CeCILL license under French law
+# and abiding by the rules of distribution of free software.  You can  use,
+# modify and/ or redistribute the software under the terms of the CeCILL
+# license as circulated by CEA, CNRS and INRIA at the following URL
+# http://www.cecill.info.
+#
+# As a counterpart to the access to the source code and  rights to copy,
+# modify and redistribute granted by the license, users are provided only
+# with a limited warranty  and the software's author,  the holder of the
+# economic rights,  and the successive licensors  have only  limited
+# liability.
+#
+# The fact that you are presently reading this means that you have had
+# knowledge of the CeCILL license and that you accept its terms.
+
+
+"""
+usage: plot_oml_consum [-h] -i DATA [-l TITLE] [-b BEGIN] [-e END] [-a] [-p]
+                       [-v] [-c] [-t]
+
+Plot iot-lab consumption OML files
+
+options:
+  -h, --help         show this help message and exit
+  -i, --input DATA   Node consumption values
+  -l, --label TITLE  Graph title
+  -b, --begin BEGIN  Sample start
+  -e, --end END      Sample end
+
+plot:
+  Plot selection
+
+  -a, --all          Plot power/voltage/current on one figure (default)
+  -p, --power        Plot power
+  -v, --voltage      Plot voltage
+  -c, --current      Plot current
+  -t, --time         Plot time verification
+"""  # noqa: E501
+
+import argparse
+import sys
+
+import matplotlib.pyplot as plt
+
+from . import common
+
+# Selection variables
+_POWER = "power"
+_VOLTAGE = "voltage"
+_CURRENT = "current"
+_ALL = "all"
+_TIME = "time"
+_TITLE = "Node"
+
+
+MEASURES_D = common.measures_dict(
+    (_POWER, float, "Power (W)"),
+    (_VOLTAGE, float, "Voltage (V)"),
+    (_CURRENT, float, "Current (A)"),
+)
+
+
+def oml_load(filename):
+    """Load consumption oml file"""
+    data = common.oml_load(filename, "consumption", MEASURES_D.values())
+    return data
+
+
+PARSER = argparse.ArgumentParser(
+    prog="plot_oml_consum", description="Plot iot-lab consumption OML files"
+)
+PARSER.add_argument(
+    "-i",
+    "--input",
+    dest="data",
+    type=oml_load,
+    required=True,
+    help="Node consumption values",
+)
+PARSER.add_argument("-l", "--label", dest="title", default=_TITLE, help="Graph title")
+PARSER.add_argument("-b", "--begin", default=0, type=int, help="Sample start")
+PARSER.add_argument("-e", "--end", default=-1, type=int, help="Sample end")
+
+_PLOT = PARSER.add_argument_group("plot", "Plot selection")
+_PLOT.add_argument(
+    "-a",
+    "--all",
+    dest="plot",
+    const=_ALL,
+    action="append_const",
+    help="Plot power/voltage/current on one figure (default)",
+)
+_PLOT.add_argument(
+    "-p", "--power", dest="plot", const=_POWER, action="append_const", help="Plot power"
+)
+_PLOT.add_argument(
+    "-v",
+    "--voltage",
+    dest="plot",
+    const=_VOLTAGE,
+    action="append_const",
+    help="Plot voltage",
+)
+_PLOT.add_argument(
+    "-c",
+    "--current",
+    dest="plot",
+    const=_CURRENT,
+    action="append_const",
+    help="Plot current",
+)
+_PLOT.add_argument(
+    "-t",
+    "--time",
+    dest="plot",
+    const=_TIME,
+    action="append_const",
+    help="Plot time verification",
+)
+
+
+def consumption_plot(data, title, selection):
+    """Plot consumption values according to selection
+
+    :param data: numpy array returned by oml_read
+    :param title: Subplots title base
+    :param selection: with values in
+        'power', 'voltage', 'current': plot on different windows
+        'all': plot all three on the same window
+        'time': plot time verification
+    """
+
+    # Single selection of 'p/v/c'
+    for value in (_POWER, _VOLTAGE, _CURRENT):
+        if value in selection:
+            oml_plot(data, title, [MEASURES_D[value]])
+
+    # Plot all on the same window
+    if _ALL in selection:
+        oml_plot(data, title, MEASURES_D.values())
+
+    # Clock verification
+    if "time" in selection:
+        common.oml_plot_clock(data)
+
+    common.plot_show()
+
+
+def oml_plot(data, title, meas_tuples):
+    """Plot consumption value for 'meas_tuples'
+
+    :param data: numpy array returned by oml_read
+    :param title: Subplots title base
+    :param meas_tuples: numpy.dtypesplots separated on different windows
+    """
+
+    nbplots = len(meas_tuples)
+    plt.figure()
+
+    for num, meas in enumerate(meas_tuples, start=1):
+        plt.subplot(nbplots, 1, num)
+
+        _title = f"{title} {meas.name}"
+        common.plot(data, _title, meas.name, meas.label)
+
+
+def main(args=None):
+    """iotlab-plot consum command"""
+    args = args or sys.argv[1:]
+
+    opts = PARSER.parse_args(args)
+    # default to plot all
+    selection = opts.plot or (_ALL)
+    # select samples
+    data = opts.data[opts.begin : opts.end]
+    consumption_plot(data, opts.title, selection)
+
+
+if __name__ == "__main__":
+    main()

oml_plot_tools/main.py

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+
+# This file is a part of IoT-LAB oml-plot-tools
+# Copyright (C) 2015 INRIA (Contact: admin@iot-lab.info)
+# Contributor(s) : see AUTHORS file
+#
+# This software is governed by the CeCILL license under French law
+# and abiding by the rules of distribution of free software.  You can  use,
+# modify and/ or redistribute the software under the terms of the CeCILL
+# license as circulated by CEA, CNRS and INRIA at the following URL
+# http://www.cecill.info.
+#
+# As a counterpart to the access to the source code and  rights to copy,
+# modify and redistribute granted by the license, users are provided only
+# with a limited warranty  and the software's author,  the holder of the
+# economic rights,  and the successive licensors  have only  limited
+# liability.
+#
+# The fact that you are presently reading this means that you have had
+# knowledge of the CeCILL license and that you accept its terms.
+
+"""Main parser."""
+
+import sys
+from argparse import ArgumentParser
+
+import oml_plot_tools.consum
+import oml_plot_tools.radio
+import oml_plot_tools.traj
+
+
+def main(args=None):
+    """'iotlab' main function."""
+    args = args or sys.argv[1:]
+
+    commands = {
+        "consum": oml_plot_tools.consum.main,
+        "radio": oml_plot_tools.radio.main,
+        "traj": oml_plot_tools.traj.main,
+        "help": None,
+    }
+
+    parser = ArgumentParser()
+    parser.add_argument("command", nargs="?", choices=commands.keys(), default="help")
+    commands["help"] = lambda args: parser.print_help()
+
+    opts, args = parser.parse_known_args(args)
+
+    return commands[opts.command](args)

oml_plot_tools/radio.py

@@ -0,0 +1,184 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# This file is a part of IoT-LAB oml-plot-tools
+# Copyright (C) 2015 INRIA (Contact: admin@iot-lab.info)
+# Contributor(s) : see AUTHORS file
+#
+# This software is governed by the CeCILL license under French law
+# and abiding by the rules of distribution of free software.  You can  use,
+# modify and/ or redistribute the software under the terms of the CeCILL
+# license as circulated by CEA, CNRS and INRIA at the following URL
+# http://www.cecill.info.
+#
+# As a counterpart to the access to the source code and  rights to copy,
+# modify and redistribute granted by the license, users are provided only
+# with a limited warranty  and the software's author,  the holder of the
+# economic rights,  and the successive licensors  have only  limited
+# liability.
+#
+# The fact that you are presently reading this means that you have had
+# knowledge of the CeCILL license and that you accept its terms.
+
+
+"""
+usage: plot_oml_radio [-h] -i DATA [-l TITLE] [-b BEGIN] [-e END] [-a] [-p]
+                      [-t]
+
+Plot iot-lab radio OML files
+
+options:
+  -h, --help         show this help message and exit
+  -i, --input DATA   Node radio values
+  -l, --label TITLE  Graph title
+  -b, --begin BEGIN  Sample start
+  -e, --end END      Sample end
+
+plot:
+  Plot selection
+
+  -a, --all          Plot all channels in one window (default)
+  -p, --plot         Plot channels in different windows
+  -t, --time         Plot time verification
+"""
+
+import argparse
+import sys
+
+import matplotlib.pyplot as plt
+
+from . import common
+
+MEASURES_D = common.measures_dict(
+    ("channel", int, "Channel"),
+    ("rssi", int, "RSSI (dBm)"),
+)
+
+
+def oml_load(filename):
+    """Load radio oml file"""
+    data = common.oml_load(filename, "radio", MEASURES_D.values())
+    return data
+
+
+# Selection variables
+_JOINED = "joined"
+_SEPARATED = "separated"
+_TIME = "time"
+
+
+PARSER = argparse.ArgumentParser(
+    prog="plot_oml_radio", description="Plot iot-lab radio OML files"
+)
+PARSER.add_argument(
+    "-i", "--input", dest="data", type=oml_load, required=True, help="Node radio values"
+)
+PARSER.add_argument("-l", "--label", dest="title", default="Node", help="Graph title")
+PARSER.add_argument("-b", "--begin", default=0, type=int, help="Sample start")
+PARSER.add_argument("-e", "--end", default=-1, type=int, help="Sample end")
+
+_PLOT = PARSER.add_argument_group("plot", "Plot selection")
+_PLOT.add_argument(
+    "-a",
+    "--all",
+    dest="plot",
+    const=_JOINED,
+    action="append_const",
+    help="Plot all channels in one window (default)",
+)
+_PLOT.add_argument(
+    "-p",
+    "--plot",
+    dest="plot",
+    const=_SEPARATED,
+    action="append_const",
+    help="Plot channels in different windows",
+)
+_PLOT.add_argument(
+    "-t",
+    "--time",
+    dest="plot",
+    const=_TIME,
+    action="append_const",
+    help="Plot time verification",
+)
+
+
+def radio_plot(data, title, selection):
+    """Plot radio values according to selection
+
+    :param data: numpy array returnel by oml_read
+    :param title: Subplots title base
+    :param selection: with values in
+        'joined': plot on the same window
+        'separated': plot on different windows
+        'time': plot time verification
+    """
+
+    if _JOINED in selection:
+        oml_plot_rssi(data, title)
+    if _SEPARATED in selection:
+        oml_plot_rssi(data, title, separated=True)
+
+    # Clock verification
+    if _TIME in selection:
+        common.oml_plot_clock(data)
+
+    common.plot_show()
+
+
+def list_channels(data):
+    """List radio channels used in data"""
+    channels = list(set(data["channel"]))
+    return sorted(channels)
+
+
+def with_channel(data, channel):
+    """Extract data where measured channel == `channel`"""
+    select = data["channel"] == channel
+    return data[select]
+
+
+def oml_plot_rssi(data, title, separated=False):
+    """Plot rssi for all channels.
+
+    :param data: numpy array returned by oml_read
+    :param title: Subplots title base
+    :param separated: plots separated on different windows
+    """
+
+    channels = list_channels(data)
+    nbplots = len(channels)
+    meas = MEASURES_D["rssi"]
+
+    # Only window for all
+    if not separated:
+        plt.figure()
+
+    for num, channel in enumerate(channels, start=1):
+        # Select data for channel
+        cdata = with_channel(data, channel)
+        _title = f"{title} Channel {channel}"
+
+        # One window per plot
+        if separated:
+            plt.figure()
+
+        plt.subplot(nbplots, 1, num)
+        common.plot(cdata, _title, meas.name, meas.label)
+
+
+def main(args=None):
+    """iotlab-plot radio command"""
+    args = args or sys.argv[1:]
+
+    opts = PARSER.parse_args(args)
+    # default to plot all
+    selection = opts.plot or (_JOINED)
+    # select samples
+    data = opts.data[opts.begin : opts.end]
+    radio_plot(data, opts.title, selection)
+
+
+if __name__ == "__main__":
+    main()

oml_plot_tools/tests/__init__.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+
+# This file is a part of IoT-LAB oml-plot-tools
+# Copyright (C) 2015 INRIA (Contact: admin@iot-lab.info)
+# Contributor(s) : see AUTHORS file
+#
+# This software is governed by the CeCILL license under French law
+# and abiding by the rules of distribution of free software.  You can  use,
+# modify and/ or redistribute the software under the terms of the CeCILL
+# license as circulated by CEA, CNRS and INRIA at the following URL
+# http://www.cecill.info.
+#
+# As a counterpart to the access to the source code and  rights to copy,
+# modify and redistribute granted by the license, users are provided only
+# with a limited warranty  and the software's author,  the holder of the
+# economic rights,  and the successive licensors  have only  limited
+# liability.
+#
+# The fact that you are presently reading this means that you have had
+# knowledge of the CeCILL license and that you accept its terms.
+
+"""oml_plot_tools tests"""