From ed3c3194b1c4707089eac192a2d72620ea32b494 Mon Sep 17 00:00:00 2001
From: Erik Norvell <erik.norvell@ericsson.com>
Date: Wed, 5 Feb 2025 14:02:03 +0100
Subject: [PATCH 1/2] Clean up histogram summary page, make titles more
 descriptive

---
 ci/basop-pages/create_summary_page.py | 35 ++++++++++++++++++++++-----
 1 file changed, 29 insertions(+), 6 deletions(-)

diff --git a/ci/basop-pages/create_summary_page.py b/ci/basop-pages/create_summary_page.py
index f8ddb00ae8..87ff099ab8 100644
--- a/ci/basop-pages/create_summary_page.py
+++ b/ci/basop-pages/create_summary_page.py
@@ -1,8 +1,16 @@
 import argparse
+from typing import List
 
 from create_report_pages import SUBPAGE_TMPL_CSS, FORMATS
 
-MEASURES = ["MLD","DIFF","SSNR","ODG","DELTA_ODG"]
+
+title = {
+    "MLD": "Maximum MLD across channels",
+    "DIFF": "Maximim absolute difference across channels",
+    "SSNR": "Minimum SSNR across channels",
+    "ODG": "Minimum PEAQ ODG across channels",
+    "DELTA_ODG": "PEAQ ODG using binauralized input and output",
+}
 
 SUMMARY_PAGE_TMPL_HTML = """
 
@@ -12,12 +20,14 @@ SUMMARY_PAGE_TMPL_HTML = """
 
 """
 
+
 def create_summary_page(
     html_out,
     id_current: int,
     job_name: str,
+    measures: List[str],
 ):
-    images = histogram_summary(job_name)
+    images = histogram_summary(job_name, measures)
 
     new_summary_page = SUBPAGE_TMPL_CSS + SUMMARY_PAGE_TMPL_HTML.format(
         id_current=id_current,
@@ -27,13 +37,15 @@ def create_summary_page(
     with open(html_out, "w") as f:
         f.write(new_summary_page)
 
+
 def histogram_summary(
-    job_name:str,
-    ):
+    job_name: str,
+    measures: List[str],
+):
     images = "<hr>"
-    for m in MEASURES:
+    for m in measures:
         images += (
-            f"<h2>{m} summary {job_name}</h2>\n"
+            f"<h2>{title[m]}</h2>\n"
             + " ".join(
                 [f"<img src=images_{job_name}/summary_{m}_{x}.png>" for x in FORMATS]
             )
@@ -41,15 +53,26 @@ def histogram_summary(
         )
     return images
 
+
 if __name__ == "__main__":
     parser = argparse.ArgumentParser()
     parser.add_argument("html_out")
     parser.add_argument("id_current", type=int)
     parser.add_argument("job_name")
+    parser.add_argument(
+        "--measures",
+        nargs="+",
+        help="List of measures to include in summary. Allowed values: MLD DIFF SSNR ODG DELTA_ODG",
+        default=["MLD", "DIFF", "SSNR", "ODG"],
+    )
     args = parser.parse_args()
 
+    if not all([m in title for m in args.measures]):
+        raise ValueError(f"Invalid list of measures: {args.measures}, expected one of {list(title.keys())}")
+
     create_summary_page(
         args.html_out,
         args.id_current,
         args.job_name,
+        args.measures,
     )
-- 
GitLab


From e5a3c4f1b726b953ea68407344ae6c0e059c2746 Mon Sep 17 00:00:00 2001
From: Erik Norvell <erik.norvell@ericsson.com>
Date: Wed, 5 Feb 2025 14:13:07 +0100
Subject: [PATCH 2/2] Fix in argument handling

---
 ci/basop-pages/create_summary_page.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/ci/basop-pages/create_summary_page.py b/ci/basop-pages/create_summary_page.py
index 87ff099ab8..1c2b464802 100644
--- a/ci/basop-pages/create_summary_page.py
+++ b/ci/basop-pages/create_summary_page.py
@@ -62,13 +62,13 @@ if __name__ == "__main__":
     parser.add_argument(
         "--measures",
         nargs="+",
-        help="List of measures to include in summary. Allowed values: MLD DIFF SSNR ODG DELTA_ODG",
+        help=f"List of measures to include in summary. Allowed values: {' '.join(title.keys())}",
         default=["MLD", "DIFF", "SSNR", "ODG"],
     )
     args = parser.parse_args()
 
     if not all([m in title for m in args.measures]):
-        raise ValueError(f"Invalid list of measures: {args.measures}, expected one of {list(title.keys())}")
+        raise ValueError(f"Invalid list of measures: {args.measures}, expected one of {' '.join(title.keys())}")
 
     create_summary_page(
         args.html_out,
-- 
GitLab