Modify ci definition and parsing

CI values are now defined as columns with name '<VALUE_NAME>-CI', csv-test files adjusted for this change, added commentary for CI integration

Author: Mirco

.gitignore

@@ -105,3 +105,6 @@ example_simulation_data
 
 #additional data logs
 datDec/
+
+# macos
+.DS_STORE

src/rdplot/SimulationDataItemClasses/CsvLogs.py

@@ -54,14 +54,32 @@ def __init__(self, config, header, line):
             # skip the header entries
             if i in [sequence_idx, qp_idx, rate_idx]:
                 continue
-            # check if a value has a confidence interval
-            if line[i].find('+-') == -1:
-                data[header[i]] = [(rate, float(line[i]))]
+            # check if value is a confidence value (CI)
+            # if entry is a ci-value we can skip it, since
+            # it will be later processed with the according value
+            if header[i].find('-ci') != -1:
                 continue
             else:
-                ci_value = line[i].split('+-')
-                data[header[i]] = [(rate, float(ci_value[0]), float(ci_value[1]))]
-                continue
+                # Check if CI value can be found, else just read the data.
+                # In case that a CI value is found, store its header index.
+                # Afterwards store the value and CI into a tuple with three
+                # entries (rate, value, ci-value). Otherwise we will just
+                # store the data in a tuple with two entries (rate, value).
+                # CI columns are always labeled as '<VALUE_NAME>-CI'.
+                ci_idx = -1
+                for j in range(0, len(header)):
+                    if header[j].find(header[i]+'-ci') != -1:
+                        ci_idx = j
+                        break
+
+                if ci_idx == -1:
+                    # Read only the data (no CI available)
+                    data[header[i]] = [(rate, float(line[i]))]
+                    continue
+                else:
+                    # Read the data and CI in one tuple
+                    data[header[i]] = [(rate, float(line[i]), float(line[ci_idx]))]
+                    continue
 
         self.summary_data = data
 

src/rdplot/Widgets/MainWindow.py

@@ -476,7 +476,9 @@ def change_table_temporal(self, plot_data_collect):
         header = legend[0]
 
         for plot_data in plot_data_collection:
-            # check if confidence interval is used
+            # check if plot_data value has a confidence interval
+            # confidence intervals are stored in tuples with three entries
+            # (rate, value, ci-value) instead of (rate, value) in the default case
             if len(plot_data.values[0]) == 2:
                 values = ((float(x), float(y)) for (x, y) in plot_data.values)
             else:
@@ -537,7 +539,9 @@ def change_table_summary(self, plot_data_collect):
 
         for plot_data in plot_data_collection:
 
-            # check if confidence interval is used
+            # check if plot_data value has a confidence interval
+            # confidence intervals are stored in tuples with three entries
+            # (rate, value, ci-value) instead of (rate, value) in the default case
             if len(plot_data.values[0]) == 2:
                 values = ((float(x), float(y)) for (x, y) in plot_data.values)
             else:

src/rdplot/Widgets/PlotWidget.py

@@ -163,7 +163,9 @@ def change_plot(self, plot_data_collection, user_generated_curves=False):
             l = legend[plot_count] #" ".join([i for i in plot_data.identifiers] + plot_data.path)
 
             # Convert list of pairs of strings to two sorted lists of floats
-            # Check if a confidence interval is given
+            # Check if plot_data value has a confidence interval
+            # Confidence intervals are stored in tuples with three entries
+            # (rate, value, ci-value) instead of (rate, value) in the default case
             try:
                 if len(plot_data.values[0]) == 2:
                     values = ((float(x), float(y)) for (x, y) in plot_data.values)
@@ -175,16 +177,18 @@ def change_plot(self, plot_data_collection, user_generated_curves=False):
 
                     plot_count += 1
                 else:
+                    # A confidence interval is included in the data
                     values = ((float(x), float(y), float(z)) for (x, y, z) in plot_data.values)
                     sorted_value_pairs = sorted(values, key=lambda pair: pair[0])
                     [xs, ys, zs] = list(zip(*sorted_value_pairs))
 
-                    # plot the current plot data
+                    # calculate the lower and upper boundaries of the CI
                     ys_low = np.subtract(ys, zs)
                     ys_up = np.add(ys, zs)
                     ys_ci = np.concatenate((ys_low, ys_up[::-1]))
                     xs_ci = np.concatenate((xs, xs[::-1]))
 
+                    # plot the curve and afterwards the CI as polygon
                     curve = self.ax.plot(xs, ys, label=l)
                     curve_ci = self.ax.fill(xs_ci, ys_ci, alpha=0.3, ec='black')
 

src/rdplot/tests/test_logs/exampleCsv/CSV_CI/test_ci1.csv

@@ -1,25 +1,25 @@
-Sequence;QP;Bitrate;MOS
-Sequence01;27;15544.26;7.65+-0.31
-Sequence01;32;8207.94;5.12+-0.44
-Sequence01;37;4677.54;3.53+-0.24
-Sequence01;42;2696.16;2.08+-0.32
-Sequence02;30;11802.85;6.92+-0.27
-Sequence02;34;7243.2;5.03+-0.37
-Sequence02;38;4695.95;3.12+-0.43
-Sequence02;42;3090.75;2.02+-0.33
-Sequence03;28;17165.46;6.75+-0.27
-Sequence03;32;9502.2;4.82+-0.25
-Sequence03;36;5767.26;3.72+-0.25
-Sequence03;42;3628.44;2.54+-0.28
-Sequence04;30;7664.7;6.82+-0.22
-Sequence04;34;4649.76;4.33+-0.3
-Sequence04;38;3449.92;2.44+-0.39
-Sequence04;42;2492.52;0.55+-0.41
-Sequence05;26;2705.64;7.02+-0.48
-Sequence05;30;1723.74;5.72+-0.38
-Sequence05;34;1139.64;4.73+-0.52
-Sequence05;40;636.96;3.12+-0.38
-Sequence06;28;3651.72;7.2+-0.46
-Sequence06;32;2014.02;5.64+-0.61
-Sequence06;36;1166.88;4.21+-0.45
-Sequence06;40;678.06;2.53+-0.55
+Sequence;QP;Bitrate;MOS;MOS-CI
+Sequence01;27;15544.26;7.65;0.31
+Sequence01;32;8207.94;5.12;0.44
+Sequence01;37;4677.54;3.53;0.24
+Sequence01;42;2696.16;2.08;0.32
+Sequence02;30;11802.85;6.92;0.27
+Sequence02;34;7243.2;5.03;0.37
+Sequence02;38;4695.95;3.12;0.43
+Sequence02;42;3090.75;2.02;0.33
+Sequence03;28;17165.46;6.75;0.27
+Sequence03;32;9502.2;4.82;0.25
+Sequence03;36;5767.26;3.72;0.25
+Sequence03;42;3628.44;2.54;0.28
+Sequence04;30;7664.7;6.82;0.22
+Sequence04;34;4649.76;4.33;0.3
+Sequence04;38;3449.92;2.44;0.39
+Sequence04;42;2492.52;0.55;0.41
+Sequence05;26;2705.64;7.02;0.48
+Sequence05;30;1723.74;5.72;0.38
+Sequence05;34;1139.64;4.73;0.52
+Sequence05;40;636.96;3.12;0.38
+Sequence06;28;3651.72;7.2;0.46
+Sequence06;32;2014.02;5.64;0.61
+Sequence06;36;1166.88;4.21;0.45
+Sequence06;40;678.06;2.53;0.55

src/rdplot/tests/test_logs/exampleCsv/CSV_CI/test_ci2.csv

@@ -1,25 +1,25 @@
-Sequence;QP;Bitrate;MOS
-Sequence01;23;10620.9;7.35+-0.24
-Sequence01;28;5359.38;5.77+-0.24
-Sequence01;33;2883.36;3.82+-0.27
-Sequence01;37;1834.08;3.01+-0.27
-Sequence02;26;7284.9;7.48+-0.3
-Sequence02;29;4694.9;6.12+-0.46
-Sequence02;33;2732.7;4.23+-0.34
-Sequence02;37;1722.8;2.95+-0.39
-Sequence03;24;12248.78;6.73+-0.42
-Sequence03;28;6779.34;5.04+-0.2
-Sequence03;31;4517.04;3.68+-0.24
-Sequence03;35;2738.34;3.07+-0.35
-Sequence04;24;4522.26;7.23+-0.26
-Sequence04;28;3005.34;6.04+-0.27
-Sequence04;31;2296.86;5.12+-0.34
-Sequence04;34;1788.42;4.24+-0.29
-Sequence05;24;1724.46;7.48+-0.3
-Sequence05;26;1306.98;6.42+-0.56
-Sequence05;30;796.2;4.41+-0.62
-Sequence05;32;618.9;3.4+-0.51
-Sequence06;25;2410.56;7.43+-0.33
-Sequence06;27;1677.3;6.39+-0.35
-Sequence06;30;1034.4;4.41+-0.3
-Sequence06;33;647.1;3.02+-0.57
+Sequence;QP;Bitrate;MOS;MOS-CI
+Sequence01;23;10620.9;7.35;0.24
+Sequence01;28;5359.38;5.77;0.24
+Sequence01;33;2883.36;3.82;0.27
+Sequence01;37;1834.08;3.01;0.27
+Sequence02;26;7284.9;7.48;0.3
+Sequence02;29;4694.9;6.12;0.46
+Sequence02;33;2732.7;4.23;0.34
+Sequence02;37;1722.8;2.95;0.39
+Sequence03;24;12248.78;6.73;0.42
+Sequence03;28;6779.34;5.04;0.2
+Sequence03;31;4517.04;3.68;0.24
+Sequence03;35;2738.34;3.07;0.35
+Sequence04;24;4522.26;7.23;0.26
+Sequence04;28;3005.34;6.04;0.27
+Sequence04;31;2296.86;5.12;0.34
+Sequence04;34;1788.42;4.24;0.29
+Sequence05;24;1724.46;7.48;0.3
+Sequence05;26;1306.98;6.42;0.56
+Sequence05;30;796.2;4.41;0.62
+Sequence05;32;618.9;3.4;0.51
+Sequence06;25;2410.56;7.43;0.33
+Sequence06;27;1677.3;6.39;0.35
+Sequence06;30;1034.4;4.41;0.3
+Sequence06;33;647.1;3.02;0.57