Merge pull request #6 from tweigel-dev/master

Visualization of Frames (currently only IWLFrame). Pending amendments.

CSIKit/csi/__init__.py

@@ -1,3 +1,5 @@
-from CSIKit.csi.csimetadata import CSIMetadata
+from CSIKit.csi.csidata import CSIData
 from CSIKit.csi.csiframe import CSIFrame
-from CSIKit.csi.csidata import CSIData
+from CSIKit.csi.frames.iwl import IWLCSIFrame
+from CSIKit.csi.csimetadata import CSIMetadata
+

CSIKit/csi/csidata.py

@@ -1,5 +1,5 @@
-from CSIKit.csi import CSIFrame
-from CSIKit.csi import CSIMetadata
+from CSIKit.csi.csiframe import CSIFrame
+from CSIKit.csi.csimetadata import CSIMetadata
 from CSIKit.util.csitools import get_CSI
 
 class CSIData:

CSIKit/visualization/graph.py

@@ -0,0 +1,305 @@
+import math
+import matplotlib.pyplot as plt
+import numpy as np
+
+from typing import Dict, Tuple
+
+from CSIKit.visualization.metric import Metric
+from matplotlib.colors import BoundaryNorm, LinearSegmentedColormap
+from matplotlib.ticker import MaxNLocator
+
+class Graph:
+
+    def __init__(self, metric: Metric):
+        self.metric = metric
+        self._axes = []
+        super().__init__()
+
+    def plot(self, values_per_measurement):
+        """
+        function to plot the visualization into the axes.
+        return axes[] 
+        """
+        self._axes = []
+        self._plot_axes(values_per_measurement)
+        if not isinstance(self._axes,list):
+            raise Exception("return value is not list")
+        return self._axes
+
+    def _plot_axes(self, values_per_measurement):
+        """
+        Abstract function.
+        This function has to fill self.axes
+        It should call self._create_new_ax
+        """
+        raise Exception("Not implemented function plot")
+
+    def _create_new_ax(self):
+        """
+        return new axes and appends it to self.axes
+        """
+        ax = plt.subplot()
+        self._axes.append(ax)
+        return ax
+
+class TupleGraph:
+    pass
+
+class PlotBox(Graph):
+
+    def _plot_axes(self, values_per_measurement):
+
+        axes = self._create_new_ax()
+
+        data = list(values_per_measurement.values())
+        labels = list(values_per_measurement.keys())
+
+        if all(isinstance(k, int) for k in labels):  # if name is metric
+            width = max(list(values_per_measurement.keys())) / \
+                (2*len(list(values_per_measurement.keys())))
+            axes.boxplot(data, positions=labels, labels=labels,  widths=width)
+
+        else:
+            width = 0.5
+            axes.boxplot(data, labels=labels, widths=width)
+
+            ind = np.arange(1, len(values_per_measurement)+1)
+            axes.set_xticks(ind)
+            axes.set_xticklabels(
+                tuple(values_per_measurement.keys()), rotation=45, ha="right")
+        mini = min({min(ar) for ar in data})
+        maxi = max({max(ar) for ar in data})
+        if maxi > 0 and mini > 0:
+            axes.set_ylim(bottom=0)
+
+        elif maxi < 0 and mini < 0:
+            axes.set_ylim(top=0)
+
+        axes.set_ylabel(f"{self.metric.get_name()}[{self.metric.get_unit()}]")
+        axes.set_xlabel('Measurement')
+
+class PlotCandle(Graph):
+    def __init__(self, metric):
+        super().__init__(metric)
+        self.plot_wick = True
+
+    @classmethod
+    def _calc_average(_cls, values_per_measurement):
+        averages = {}
+        for mes_name in values_per_measurement.copy():
+            values = values_per_measurement[mes_name]
+            averages[mes_name] = (sum(values)/len(values))
+        return averages
+
+    @classmethod
+    def _calc_std_errs(cls, values_per_measurement):
+        """returns standard diviation of each measurement """
+        val_per_meas = values_per_measurement.copy()
+        std_errs = {}
+        for name in val_per_meas:
+            std_errs[name] = np.std(val_per_meas[name])
+
+        return std_errs
+
+    @classmethod
+    def _calc_confidence_diff(cls, variance, interval=0.95):
+        """ Retruns the  +- confidenz delta of the meassrements"""
+        INTERVALS = {
+            0.90: 1.645,
+            0.95: 1.96,
+            0.98: 2.326,
+            0.99: 2.576
+        }
+        if not interval in INTERVALS:
+            raise Exception(f"Invalid interval {interval}")
+
+        confidenz_errors = {}
+        for name in variance:
+            std_err = math.sqrt(variance[name])
+            confidenz = INTERVALS[interval] * \
+                (std_err / math.sqrt(len(variance[name])))
+            confidenz_errors[name] = confidenz
+        return confidenz_errors
+
+    def _plot_axes(self, values_per_measurement, plot_wick=True):
+        axes = self._create_new_ax()
+        if all(isinstance(k, int) for k in values_per_measurement.keys()):  # if name is metric
+            width = max(list(values_per_measurement.keys())) / \
+                (2*len(list(values_per_measurement.keys())))
+            #width = 4
+            # for name in self._values_per_measurement: # for each measurement
+            self._plot_candle(axes, values_per_measurement,
+                             width=width, plot_wick=plot_wick)
+
+        else:  # else plot by name
+            width = 0.4
+            self._plot_candle(axes, values_per_measurement,
+                             width=width, plot_wick=plot_wick)
+            ind = np.arange(len(values_per_measurement))
+            # plot unique text at the center of each candle
+            axes.set_xticks(ind)
+            axes.set_xticklabels(
+                tuple(values_per_measurement.keys()), rotation=45, ha="right")
+        axes.set_ylabel(f"{self.metric.get_name()}[{self.metric.get_unit()}]")
+        axes.set_xlabel('Measurement')
+
+    @classmethod
+    def _plot_candle(cls, axes, values_per_measurement, width=4, color="#008000", x_offset=0, plot_wick=True):
+        averages = cls._calc_average(values_per_measurement)
+        if len(values_per_measurement) == 1:
+            plot_wick = False
+        if plot_wick:
+            std_errors = cls._calc_std_errs(values_per_measurement)
+        # confidences = cls._calc_confidence_diff(self._values_per_measurement)
+        wick_width = 4
+
+        if all(isinstance(k, int) for k in values_per_measurement.keys()):  # if name is metric
+
+            # for name in self._values_per_measurement: # for each measurement
+            x_arr = values_per_measurement.keys()
+
+            if x_offset != 0:
+                x_arr = [i+x_offset for i in x_arr]  # add offset to x plot
+            if plot_wick:
+                axes.bar(x_arr, averages.values(), width=width, yerr=std_errors.values(
+                ), error_kw=dict(linewidth=wick_width), color=color)
+            else:
+                axes.bar(x_arr, averages.values(), width=width,
+                         error_kw=dict(linewidth=wick_width), color=color)
+        else:  # else plot by name
+            ind = np.arange(len(values_per_measurement))
+            ind = [i+x_offset for i in ind]  # add offset to x plot
+
+            if plot_wick:
+                axes.bar(ind, averages.values(), width=width, yerr=std_errors.values(
+                ), error_kw=dict(linewidth=wick_width), color=color)
+            else:
+                axes.bar(ind, averages.values(), width=width,
+                         error_kw=dict(linewidth=wick_width), color=color)
+
+class PlotCandleTuple(TupleGraph, PlotCandle):
+    """
+    Abstract class to plot group of bars by datatype tuple
+    """
+
+    def __init__(self, metric):
+        super().__init__(metric)
+        self._values_per_measurement: Dict[str, Tuple] = {}
+    COLORS = ['#008000', 'red',  'blue']
+
+    def _plot_axes(self, values_per_measurement, plot_wick=True):
+        axes = self._create_new_ax()
+        axes.set_autoscalex_on(True)
+        # gets the size of the contained tuple
+        tuple_size = len(list(values_per_measurement.values())[0][0])
+
+        if all(isinstance(k, int) for k in values_per_measurement.keys()):  # if name is metric
+            width = (max(list(values_per_measurement.keys())) /
+                     (2*len(list(values_per_measurement.keys()))))/tuple_size
+            # for name in self._values_per_measurement: # for each measurement
+
+            for tuple_i in range(tuple_size):
+                self._plot_candle(axes, self._get_measurement_by_tuple_index(values_per_measurement, tuple_i), width, x_offset=(
+                    tuple_i-1)*width, color=self.COLORS[tuple_i], plot_wick=plot_wick)
+
+        else:  # else plot by name
+            width = 0.8 / tuple_size
+
+            # plot each bar of group per tuple
+            for tuple_i in range(tuple_size):
+                self._plot_candle(axes, self._get_measurement_by_tuple_index(values_per_measurement, tuple_i), width, x_offset=(
+                    tuple_i-1)*width, color=self.COLORS[tuple_i], plot_wick=plot_wick)
+            # unique label per candle group
+            ind = np.arange(len(values_per_measurement))
+            axes.set_xticks(ind)
+            axes.set_xticklabels(
+                tuple(values_per_measurement.keys()), rotation=45, ha="right")
+        axes.set_ylabel(f"{self.metric.get_name()}[{self.metric.get_unit()}]")
+        axes.set_xlabel('Measurement')
+
+    @classmethod
+    def _get_measurement_by_tuple_index(cls, values_per_measurement, tuple_index):
+        """
+        this function returns a "normal" measurement dict like used at CandlePlot to reuse the CandlePlot._plot_candle()
+        returns Dict[str, list[int]]
+        """
+        measurements = values_per_measurement.copy()
+        result = {}
+        for name in measurements:
+            measurement = measurements[name]
+            result[name] = [i[tuple_index] for i in measurement]
+
+        return result
+
+class PlotCandleTuple_Phase(PlotCandleTuple):
+
+    def _plot_axes(self,  values_per_measurement, plot_wick=False):  # set wick false
+        super()._plot_axes( values_per_measurement, plot_wick=plot_wick)
+        {ax._axes.set_ylim((0, np.pi)) for ax in self._axes}
+
+class PlotColorMap(Graph):
+
+    def __init__(self, metric):
+        super().__init__(metric)
+        self.vmin=None
+        self.vmax=None
+        self.cmap = plt.cm.plasma
+        self.color_legend = True
+
+    def _plot_axes(self,  values_per_measurement):
+
+        for measur_name in values_per_measurement:
+            axes = self._create_new_ax()
+            amplitude_per_sub = values_per_measurement[measur_name]
+            amplitude_per_sub = np.matrix(np.array(amplitude_per_sub))
+             # plot
+            cmap= self.cmap
+            if not self.vmin is None and not self.vmax is None:
+                pcmap = axes.pcolormesh(amplitude_per_sub, cmap=cmap,  vmin=self.vmin, vmax=self.vmax,rasterized=True)
+            else:
+                pcmap = axes.pcolormesh(amplitude_per_sub, cmap=cmap, rasterized=True)
+            if self.color_legend:
+                plt.colorbar(pcmap, ax=axes)
+            axes.set_xlabel(f"subcarrier")
+            axes.set_ylabel('measurement')
+            plt.show()
+
+class PlotColorMap_Phase(PlotColorMap):
+
+    def __init__(self, metric):
+        super().__init__(metric)
+        colors = ["#008000", "white", "#008000"]
+        cmap_custom = LinearSegmentedColormap.from_list("mycmap", colors)
+
+        self.cmap = cmap_custom
+        self.vmax = np.pi/2
+        self.vmin = 0
+        self.color_legend = True
+
+class PlotColorMap_Amplitude(PlotColorMap):
+
+    def __init__(self, metric):
+        super().__init__(metric)
+        self.vmax = 150
+        self.vmin = 0
+        self.cmap = plt.cm.gist_ncar
+        self.color_legend = True
+
+class PlotPhaseDiff(Graph):
+
+    def _plot_axes(self,  values_per_measurement):
+
+        COLORS = ['red', '#008000', 'blue']
+        for measur_name in values_per_measurement:
+            axes = self._create_new_ax()
+            diffs_entry = values_per_measurement[measur_name]
+            for diffs in diffs_entry[:100]:
+                for pair_index in range(len(diffs)):
+                    axes.plot(range(len(diffs[pair_index])), diffs[pair_index]
+                            , color=COLORS[pair_index])
+
+            #axes.title('Phase diff', fontsize=16)
+            axes.set_xlabel('Subcarrier index')
+            axes.set_ylabel('phase')
+            axes.set_ylim(0,2*np.pi)
+            plt.show()