QGIS/scripts/parse_dash_results.py
2024-11-29 15:38:02 +01:00

512 lines
18 KiB
Python
Executable File

#!/usr/bin/env python3
"""
***************************************************************************
parse_dash_results.py
---------------------
Date : October 2016
Copyright : (C) 2016 by Nyall Dawson
Email : nyall dot dawson at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************
"""
__author__ = "Nyall Dawson"
__date__ = "October 2016"
__copyright__ = "(C) 2016, Nyall Dawson"
import argparse
import glob
import json
import os
import re
import struct
import sys
import urllib.error
import urllib.parse
import urllib.request
import termcolor
from PyQt5.QtCore import Qt
from PyQt5.QtGui import QColor, QImage, QPixmap, qAlpha, qBlue, qGreen, qRed, qRgb
from PyQt5.QtWidgets import (
QApplication,
QDialog,
QDialogButtonBox,
QDoubleSpinBox,
QGridLayout,
QHBoxLayout,
QLabel,
QLayout,
QListWidget,
QPushButton,
QScrollArea,
QVBoxLayout,
QWidget,
)
dash_url = "https://cdash.orfeo-toolbox.org"
def error(msg):
print(termcolor.colored(msg, "red"))
sys.exit(1)
def colorDiff(c1, c2):
redDiff = abs(qRed(c1) - qRed(c2))
greenDiff = abs(qGreen(c1) - qGreen(c2))
blueDiff = abs(qBlue(c1) - qBlue(c2))
alphaDiff = abs(qAlpha(c1) - qAlpha(c2))
return max(redDiff, greenDiff, blueDiff, alphaDiff)
def imageFromPath(path):
if path[:8] == "https://" or path[:7] == "file://":
# fetch remote image
print(f"Fetching remote ({path})")
data = urllib.request.urlopen(path).read()
image = QImage()
image.loadFromData(data)
else:
print(f"Using local ({path})")
image = QImage(path)
return image
class SelectReferenceImageDialog(QDialog):
def __init__(self, parent, test_name, images):
super().__init__(parent)
self.setWindowTitle("Select reference image")
self.setWindowFlags(Qt.WindowType.Window)
self.button_box = QDialogButtonBox(
QDialogButtonBox.StandardButton.Ok | QDialogButtonBox.StandardButton.Cancel
)
self.button_box.accepted.connect(self.accept)
self.button_box.rejected.connect(self.reject)
layout = QVBoxLayout()
layout.addWidget(
QLabel(f"Found multiple matching reference images for {test_name}")
)
self.list = QListWidget()
layout.addWidget(self.list, 1)
layout.addWidget(self.button_box)
self.setLayout(layout)
for image in images:
self.list.addItem(image)
def selected_image(self):
return self.list.currentItem().text()
class ResultHandler(QDialog):
def __init__(self, parent=None):
super().__init__(parent)
self.setWindowTitle("Dash results")
self.setWindowFlags(Qt.WindowType.Window)
self.control_label = QLabel()
self.rendered_label = QLabel()
self.diff_label = QLabel()
self.mask_label = QLabel()
self.new_mask_label = QLabel()
self.scrollArea = QScrollArea()
self.widget = QWidget()
self.test_name_label = QLabel()
grid = QGridLayout()
grid.addWidget(self.test_name_label, 0, 0)
grid.addWidget(QLabel("Control"), 1, 0)
grid.addWidget(QLabel("Rendered"), 1, 1)
grid.addWidget(QLabel("Difference"), 1, 2)
grid.addWidget(self.control_label, 2, 0)
grid.addWidget(self.rendered_label, 2, 1)
grid.addWidget(self.diff_label, 2, 2)
grid.addWidget(QLabel("Current Mask"), 3, 0)
grid.addWidget(QLabel("New Mask"), 3, 1)
grid.addWidget(self.mask_label, 4, 0)
grid.addWidget(self.new_mask_label, 4, 1)
grid.setSizeConstraint(QLayout.SizeConstraint.SetFixedSize)
self.widget.setLayout(grid)
self.scrollArea.setWidget(self.widget)
v_layout = QVBoxLayout()
v_layout.addWidget(self.scrollArea, 1)
next_image_button = QPushButton()
next_image_button.setText("Skip")
next_image_button.pressed.connect(self.load_next)
self.overload_spin = QDoubleSpinBox()
self.overload_spin.setMinimum(1)
self.overload_spin.setMaximum(255)
self.overload_spin.setValue(1)
self.overload_spin.valueChanged.connect(
lambda: save_mask_button.setEnabled(False)
)
preview_mask_button = QPushButton()
preview_mask_button.setText("Preview New Mask")
preview_mask_button.pressed.connect(self.preview_mask)
preview_mask_button.pressed.connect(lambda: save_mask_button.setEnabled(True))
save_mask_button = QPushButton()
save_mask_button.setText("Save New Mask")
save_mask_button.pressed.connect(self.save_mask)
add_ref_image_button = QPushButton()
add_ref_image_button.setText("Add Reference Image")
add_ref_image_button.pressed.connect(self.add_reference_image)
button_layout = QHBoxLayout()
button_layout.addWidget(next_image_button)
button_layout.addWidget(QLabel("Mask diff multiplier:"))
button_layout.addWidget(self.overload_spin)
button_layout.addWidget(preview_mask_button)
button_layout.addWidget(save_mask_button)
button_layout.addWidget(add_ref_image_button)
button_layout.addStretch()
v_layout.addLayout(button_layout)
self.setLayout(v_layout)
def closeEvent(self, event):
self.reject()
def parse_url(self, url):
parts = urllib.parse.urlsplit(url)
apiurl = urllib.parse.urlunsplit(
(
parts.scheme,
parts.netloc,
"/api/v1/testDetails.php",
parts.query,
parts.fragment,
)
)
print(f"Fetching dash results from api: {apiurl}")
page = urllib.request.urlopen(apiurl)
content = json.loads(page.read().decode("utf-8"))
# build up list of rendered images
measurement_img = [
img
for img in content["test"]["images"]
if img["role"].startswith("Rendered Image")
]
images = {}
for img in measurement_img:
m = re.search(r"Rendered Image (.*?)(\s|$)", img["role"])
test_name = m.group(1)
rendered_image = "displayImage.php?imgid={}".format(img["imgid"])
images[test_name] = f"{dash_url}/{rendered_image}"
if images:
print("Found images:\n")
for title, url in images.items():
print(" " + termcolor.colored(title, attrs=["bold"]) + " : " + url)
else:
print(termcolor.colored("No images found\n", "yellow"))
self.images = images
self.load_next()
def load_next(self):
if not self.images:
# all done
self.accept()
exit(0)
test_name, rendered_image = self.images.popitem()
self.test_name_label.setText(test_name)
print(termcolor.colored("\n" + test_name, attrs=["bold"]))
control_image = self.get_control_image_path(test_name)
if not control_image:
self.load_next()
return
self.mask_image_path = control_image[:-4] + "_mask.png"
self.load_images(control_image, rendered_image, self.mask_image_path)
def load_images(self, control_image_path, rendered_image_path, mask_image_path):
self.control_image = imageFromPath(control_image_path)
if not self.control_image:
error(f"Could not read control image {control_image_path}")
self.rendered_image = imageFromPath(rendered_image_path)
if not self.rendered_image:
error(f"Could not read rendered image {rendered_image_path}")
if (
not self.rendered_image.width() == self.control_image.width()
or not self.rendered_image.height() == self.control_image.height()
):
print(
"Size mismatch - control image is {}x{}, rendered image is {}x{}".format(
self.control_image.width(),
self.control_image.height(),
self.rendered_image.width(),
self.rendered_image.height(),
)
)
max_width = min(self.rendered_image.width(), self.control_image.width())
max_height = min(self.rendered_image.height(), self.control_image.height())
# read current mask, if it exist
self.mask_image = imageFromPath(mask_image_path)
if self.mask_image.isNull():
print(f"Mask image does not exist, creating {mask_image_path}")
self.mask_image = QImage(
self.control_image.width(),
self.control_image.height(),
QImage.Format.Format_ARGB32,
)
self.mask_image.fill(QColor(0, 0, 0))
self.diff_image = self.create_diff_image(
self.control_image, self.rendered_image, self.mask_image
)
if not self.diff_image:
self.load_next()
return
self.control_label.setPixmap(QPixmap.fromImage(self.control_image))
self.control_label.setFixedSize(self.control_image.size())
self.rendered_label.setPixmap(QPixmap.fromImage(self.rendered_image))
self.rendered_label.setFixedSize(self.rendered_image.size())
self.mask_label.setPixmap(QPixmap.fromImage(self.mask_image))
self.mask_label.setFixedSize(self.mask_image.size())
self.diff_label.setPixmap(QPixmap.fromImage(self.diff_image))
self.diff_label.setFixedSize(self.diff_image.size())
self.preview_mask()
def preview_mask(self):
self.new_mask_image = self.create_mask(
self.control_image,
self.rendered_image,
self.mask_image,
self.overload_spin.value(),
)
self.new_mask_label.setPixmap(QPixmap.fromImage(self.new_mask_image))
self.new_mask_label.setFixedSize(self.new_mask_image.size())
def save_mask(self):
self.new_mask_image.save(self.mask_image_path, "png")
self.load_next()
def add_reference_image(self):
if os.path.abspath(self.control_images_base_path) == os.path.abspath(
self.found_control_image_path
):
images = glob.glob(os.path.join(self.found_control_image_path, "*.png"))
default_path = os.path.join(self.found_control_image_path, "set1")
os.makedirs(default_path)
for image in images:
imgname = os.path.basename(image)
os.rename(image, os.path.join(default_path, imgname))
for i in range(2, 100):
new_path = os.path.join(self.control_images_base_path, "set" + str(i))
if not os.path.exists(new_path):
break
else:
raise RuntimeError(
"Could not find a suitable directory for another set of reference images"
)
os.makedirs(new_path)
control_image_name = os.path.basename(self.found_image)
self.rendered_image.save(os.path.join(new_path, control_image_name))
self.load_next()
def create_mask(self, control_image, rendered_image, mask_image, overload=1):
max_width = min(rendered_image.width(), control_image.width())
max_height = min(rendered_image.height(), control_image.height())
new_mask_image = QImage(
control_image.width(), control_image.height(), QImage.Format.Format_ARGB32
)
new_mask_image.fill(QColor(0, 0, 0))
# loop through pixels in rendered image and compare
mismatch_count = 0
linebytes = max_width * 4
for y in range(max_height):
control_scanline = control_image.constScanLine(y).asstring(linebytes)
rendered_scanline = rendered_image.constScanLine(y).asstring(linebytes)
mask_scanline = mask_image.scanLine(y).asstring(linebytes)
for x in range(max_width):
currentTolerance = qRed(
struct.unpack("I", mask_scanline[x * 4 : x * 4 + 4])[0]
)
if currentTolerance == 255:
# ignore pixel
new_mask_image.setPixel(
x, y, qRgb(currentTolerance, currentTolerance, currentTolerance)
)
continue
expected_rgb = struct.unpack("I", control_scanline[x * 4 : x * 4 + 4])[
0
]
rendered_rgb = struct.unpack("I", rendered_scanline[x * 4 : x * 4 + 4])[
0
]
difference = min(
255, int(colorDiff(expected_rgb, rendered_rgb) * overload)
)
if difference > currentTolerance:
# update mask image
new_mask_image.setPixel(
x, y, qRgb(difference, difference, difference)
)
mismatch_count += 1
else:
new_mask_image.setPixel(
x, y, qRgb(currentTolerance, currentTolerance, currentTolerance)
)
return new_mask_image
def get_control_image_path(self, test_name):
if os.path.isfile(test_name):
return test_name
# else try and find matching test image
script_folder = os.path.dirname(os.path.realpath(sys.argv[0]))
control_images_folder = os.path.join(
script_folder, "../tests/testdata/control_images"
)
matching_control_images = [
x[0]
for x in os.walk(control_images_folder)
if test_name + "/" in x[0] or x[0].endswith(test_name)
]
self.control_images_base_path = os.path.commonprefix(matching_control_images)
if len(matching_control_images) > 1:
for item in matching_control_images:
print(" - " + item)
dlg = SelectReferenceImageDialog(self, test_name, matching_control_images)
if not dlg.exec():
return None
self.found_control_image_path = dlg.selected_image()
elif len(matching_control_images) == 0:
print(
termcolor.colored(
f"No matching control images found for {test_name}", "yellow"
)
)
return None
else:
self.found_control_image_path = matching_control_images[0]
# check for a single matching expected image
images = glob.glob(os.path.join(self.found_control_image_path, "*.png"))
filtered_images = [i for i in images if not i[-9:] == "_mask.png"]
if len(filtered_images) > 1:
error(f"Found multiple matching control images for {test_name}")
elif len(filtered_images) == 0:
error(f"No matching control images found for {test_name}")
self.found_image = filtered_images[0]
print(f"Found matching control image: {self.found_image}")
return self.found_image
def create_diff_image(self, control_image, rendered_image, mask_image):
# loop through pixels in rendered image and compare
mismatch_count = 0
max_width = min(rendered_image.width(), control_image.width())
max_height = min(rendered_image.height(), control_image.height())
linebytes = max_width * 4
diff_image = QImage(
control_image.width(), control_image.height(), QImage.Format.Format_ARGB32
)
diff_image.fill(QColor(152, 219, 249))
for y in range(max_height):
control_scanline = control_image.constScanLine(y).asstring(linebytes)
rendered_scanline = rendered_image.constScanLine(y).asstring(linebytes)
mask_scanline = mask_image.scanLine(y).asstring(linebytes)
for x in range(max_width):
currentTolerance = qRed(
struct.unpack("I", mask_scanline[x * 4 : x * 4 + 4])[0]
)
if currentTolerance == 255:
# ignore pixel
continue
expected_rgb = struct.unpack("I", control_scanline[x * 4 : x * 4 + 4])[
0
]
rendered_rgb = struct.unpack("I", rendered_scanline[x * 4 : x * 4 + 4])[
0
]
difference = colorDiff(expected_rgb, rendered_rgb)
if difference > currentTolerance:
# update mask image
diff_image.setPixel(x, y, qRgb(255, 0, 0))
mismatch_count += 1
if mismatch_count:
return diff_image
else:
print(termcolor.colored("No mismatches", "green"))
return None
def main():
app = QApplication(sys.argv)
parser = argparse.ArgumentParser(
description="""A tool to automatically update test image masks based on results submitted to cdash.
It will take local control images from the QGIS source and rendered images from test results
on cdash to create a mask.
When using it, carefully check, that the rendered images from the test results are acceptable and
that the new masks will only mask regions on the image that indeed allow for variation.
If the resulting mask is too tolerant, consider adding a new control image next to the existing one.
"""
)
parser.add_argument(
"dash_url",
help="URL to a dash result with images. E.g. https://cdash.orfeo-toolbox.org/testDetails.php?test=15052561&build=27712",
)
args = parser.parse_args()
w = ResultHandler()
w.parse_url(args.dash_url)
w.exec()
if __name__ == "__main__":
main()