diff --git a/README.md b/README.md index 2eb9b7a..9dcf0ac 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ # IQM-Vis Image Quality Metric Visualision. An extendable user interface for the assessment of transformations on image metrics. -Head over to the [DOCUMENTATION](https://mattclifford1.github.io/IQM-Vis/) for tutorials and package reference. Read our [PAPER](https://github.com/mattclifford1/IQM-Vis/blob/main/Software_Impacts_IQM_Vis.pdf) for in depth details of the software. +Head over to the [DOCUMENTATION](https://mattclifford1.github.io/IQM-Vis/) for tutorials and package reference. Read our [PAPER](https://github.com/mattclifford1/IQM-Vis/blob/main/docs/resources/Software_Paper.pdf) for in depth details of the software. ### IQM's average sensitivity to tranforms ![Alt text](https://github.com/mattclifford1/IQM-Vis/blob/main/pics/data_graphs.gif?raw=true "Dataset UI") diff --git a/Software_Impacts_IQM_Vis.pdf b/Software_Impacts_IQM_Vis.pdf deleted file mode 100644 index 611a3fb..0000000 Binary files a/Software_Impacts_IQM_Vis.pdf and /dev/null differ diff --git a/tests/todo.md b/dev_resources/todo.md similarity index 100% rename from tests/todo.md rename to dev_resources/todo.md diff --git a/todo.txt b/dev_resources/todo.txt similarity index 100% rename from todo.txt rename to dev_resources/todo.txt diff --git a/docs/_build/doctrees/IQM_Vis.UI.doctree b/docs/_build/doctrees/IQM_Vis.UI.doctree index 8f49b6c..2140c8b 100644 Binary files a/docs/_build/doctrees/IQM_Vis.UI.doctree and b/docs/_build/doctrees/IQM_Vis.UI.doctree differ diff --git a/docs/_build/doctrees/IQM_Vis.doctree b/docs/_build/doctrees/IQM_Vis.doctree index 72510d9..e21d5bb 100644 Binary files a/docs/_build/doctrees/IQM_Vis.doctree and b/docs/_build/doctrees/IQM_Vis.doctree differ diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 85706f2..9950fbf 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree index 72cd070..01e2ce5 100644 Binary files a/docs/_build/doctrees/index.doctree and b/docs/_build/doctrees/index.doctree differ diff --git a/docs/_build/html/IQM_Vis.UI.html b/docs/_build/html/IQM_Vis.UI.html index 77b0dd8..d316f1a 100644 --- a/docs/_build/html/IQM_Vis.UI.html +++ b/docs/_build/html/IQM_Vis.UI.html @@ -453,7 +453,7 @@

Submodules
-class IQM_Vis.UI.main.make_app(app, data_stores: list, transformations: dict, metrics_info_format='graph', metrics_avg_graph=False, metric_range_graph=True, metric_params: dict = {}, image_display_size=300, default_save_dir='/home/matt/IQM-Vis-experiments', restrict_options=None, num_steps_range=11, num_step_experiment=6)[source]
+class IQM_Vis.UI.main.make_app(app, data_stores: list, transformations: dict, metrics_info_format='graph', metrics_avg_graph=False, metric_range_graph=True, metric_params: dict = {}, image_display_size=300, default_save_dir='/home/matt/IQM-Vis-experiments', restrict_options=None, num_steps_range=11, num_step_experiment=6, test=False)[source]

Bases: IQM_Vis.UI.widgets.widgets, IQM_Vis.UI.layout.layout, IQM_Vis.UI.images.images

diff --git a/docs/_build/html/IQM_Vis.html b/docs/_build/html/IQM_Vis.html index 19f6d89..e6cc977 100644 --- a/docs/_build/html/IQM_Vis.html +++ b/docs/_build/html/IQM_Vis.html @@ -179,7 +179,7 @@

Submodules
-class IQM_Vis.ui_wrapper.make_UI(data_store=None, transformations=None, image_list: list = ['/home/matt/projects/IQM-VIS/IQM_Vis/examples/images/waves1.jpeg', '/home/matt/projects/IQM-VIS/IQM_Vis/examples/images/waves2.jpeg', '/home/matt/projects/IQM-VIS/IQM_Vis/examples/images/waves3.jpeg'], metrics: dict = {}, metric_images: dict = {}, metrics_info_format: str = 'graph', metrics_avg_graph: bool = True, metric_params: dict = {}, default_save_dir='/home/matt/IQM-Vis-experiments', restrict_options=None, num_steps_range=11, debug=False)[source]
+class IQM_Vis.ui_wrapper.make_UI(data_store=None, transformations=None, image_list: list = ['/home/matt/projects/IQM-VIS/IQM_Vis/examples/images/waves1.jpeg', '/home/matt/projects/IQM-VIS/IQM_Vis/examples/images/waves2.jpeg', '/home/matt/projects/IQM-VIS/IQM_Vis/examples/images/waves3.jpeg'], metrics: dict = {}, metric_images: dict = {}, metrics_info_format: str = 'graph', metrics_avg_graph: bool = True, metric_params: dict = {}, default_save_dir='/home/matt/IQM-Vis-experiments', restrict_options=None, num_steps_range=11, debug=False, test=False)[source]

Bases: object

diff --git a/docs/_build/html/_modules/IQM_Vis/UI/custom_widgets.html b/docs/_build/html/_modules/IQM_Vis/UI/custom_widgets.html index 5339a2a..bee2b0e 100644 --- a/docs/_build/html/_modules/IQM_Vis/UI/custom_widgets.html +++ b/docs/_build/html/_modules/IQM_Vis/UI/custom_widgets.html @@ -86,6 +86,8 @@

Source code for IQM_Vis.UI.custom_widgets

 ''' Custom SubClasses of PyQt6 widget to extent to the required functionality '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 from PyQt6.QtCore import pyqtSignal
 from PyQt6.QtWidgets import QProgressBar, QLabel
 
diff --git a/docs/_build/html/_modules/IQM_Vis/UI/experiment_mode.html b/docs/_build/html/_modules/IQM_Vis/UI/experiment_mode.html
index b7260f6..c6256a9 100644
--- a/docs/_build/html/_modules/IQM_Vis/UI/experiment_mode.html
+++ b/docs/_build/html/_modules/IQM_Vis/UI/experiment_mode.html
@@ -88,6 +88,8 @@ 
Source code for IQM_Vis.UI.experiment_mode
 create experiment window
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 import os
 import random
 import threading
@@ -185,9 +187,10 @@ 
Source code for IQM_Vis.UI.experiment_mode
             if hasattr(self, 'range_worker'):
                 self.range_worker.stop()
             if hasattr(self, 'image_worker_thread'):
+                if self.image_worker_thread.isRunning():
+                    self.image_worker_thread.quit()
+                    self.image_worker_thread.wait()
                 self.image_change_worker.stop()
-                self.image_worker_thread.quit()
-                self.image_worker_thread.wait()
             self.stop_event.set()
             self.clicked_event.set()
             event.accept()

diff --git a/docs/_build/html/_modules/IQM_Vis/UI/images.html b/docs/_build/html/_modules/IQM_Vis/UI/images.html
index 8099abd..e84911a 100644
--- a/docs/_build/html/_modules/IQM_Vis/UI/images.html
+++ b/docs/_build/html/_modules/IQM_Vis/UI/images.html
@@ -88,6 +88,7 @@ 
Source code for IQM_Vis.UI.images
 UI image functions
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
 
 import os
 import imghdr
diff --git a/docs/_build/html/_modules/IQM_Vis/UI/layout.html b/docs/_build/html/_modules/IQM_Vis/UI/layout.html
index 0e2b1c2..f47a14b 100644
--- a/docs/_build/html/_modules/IQM_Vis/UI/layout.html
+++ b/docs/_build/html/_modules/IQM_Vis/UI/layout.html
@@ -88,6 +88,8 @@ 
Source code for IQM_Vis.UI.layout
 UI create layout
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 import os
 import warnings
 from PyQt6.QtWidgets import (QMainWindow,
@@ -111,7 +113,8 @@ 
Source code for IQM_Vis.UI.layout
         self.main_widget = QWidget()
         self.main_widget.setLayout(self.main_layout)
         self.setCentralWidget(self.main_widget)
-        self.show()

+        self.show()
+        return self

 
     def _init_generic_layout(self):
         '''
diff --git a/docs/_build/html/_modules/IQM_Vis/UI/main.html b/docs/_build/html/_modules/IQM_Vis/UI/main.html
index d073410..1cca417 100644
--- a/docs/_build/html/_modules/IQM_Vis/UI/main.html
+++ b/docs/_build/html/_modules/IQM_Vis/UI/main.html
@@ -88,16 +88,19 @@ 
Source code for IQM_Vis.UI.main
 main entry point to initialise the UI
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
 
 import os
 import time
 from functools import partial
 from PyQt6.QtWidgets import QApplication, QMessageBox, QFileDialog
+from PyQt6.QtCore import QCoreApplication
 import IQM_Vis
 from IQM_Vis.UI import layout, widgets, images, ProgressBar
 
 
[docs]class make_app(widgets, layout, images):
-    def __init__(self, app,
+    def __init__(self, 
+                 app,
                  data_stores: list,
                  transformations: dict,
                  metrics_info_format='graph', # graph or text
@@ -109,6 +112,7 @@ 
Source code for IQM_Vis.UI.main
                  restrict_options=None,
                  num_steps_range=11,
                  num_step_experiment=6,
+                 test=False
                  ):
         super().__init__()
         self.app = app
@@ -116,6 +120,7 @@ 
Source code for IQM_Vis.UI.main
         self.transformations = transformations
         self.num_steps_range = num_steps_range
         self.num_step_experiment = num_step_experiment
+        self.test = test
 
         self.metrics_info_format = metrics_info_format
         self.metrics_avg_graph = metrics_avg_graph
@@ -217,25 +222,37 @@ 
Source code for IQM_Vis.UI.main
         self.construct_UI()

 
 
[docs]    def quit(self):
-        QApplication.instance().quit()

+        # QApplication.instance().quit()
+        self.app.quit()

 
     def __del__(self):
         # garbage collection
         self.range_worker.stop()
 
 
[docs]    def closeEvent(self, event):
+        # self.close_answer = None
+        # if self.test == False:
+
         # Ask for confirmation
-        answer = QMessageBox.question(self,
+        self.close_answer = QMessageBox.question(self,
         "Confirm Exit...",
         "Are you sure you want to exit?\nAll unsaved data will be lost.",
         QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No,
-                                      QMessageBox.StandardButton.Yes)
+                                    QMessageBox.StandardButton.Yes)
 
         event.ignore()
-        if answer == QMessageBox.StandardButton.Yes:
+        # if self.test == True or self.close_answer == QMessageBox.StandardButton.Yes:
+        if self.close_answer == QMessageBox.StandardButton.Yes:
             if hasattr(self, 'range_worker'):
                 self.range_worker.stop()
+
+            if hasattr(self, 'range_worker_thread'):
+                if self.range_worker_thread.isRunning():
+                    self.range_worker_thread.quit()
+                    self.range_worker_thread.wait()
+            
             event.accept()

+            # QCoreApplication.quit()
 
 
[docs]    def get_menu_checkboxes(self):
         ''' list all trans/metrics in the menu drop downs '''
@@ -313,7 +330,7 @@ 
Source code for IQM_Vis.UI.main
         self.init_style()     # layout.py
         self.init_widgets()   # widgets.py
         self.change_data(0, _redo_plots=True)   # images.py
-        self.init_layout()    # layout.py
+        self.main = self.init_layout()    # layout.py
         self.tabs['slider'].setCurrentIndex(tabs_index['slider'])
         self.tabs['graph'].setCurrentIndex(tabs_index['graph'])
         # self.experiments_tab.setCurrentIndex(experi_tabs_index)
diff --git a/docs/_build/html/_modules/IQM_Vis/UI/threads.html b/docs/_build/html/_modules/IQM_Vis/UI/threads.html
index fb791a3..b0fc40e 100644
--- a/docs/_build/html/_modules/IQM_Vis/UI/threads.html
+++ b/docs/_build/html/_modules/IQM_Vis/UI/threads.html
@@ -87,6 +87,8 @@ 
Source code for IQM_Vis.UI.threads
 ''' thread and signal classes to makethe UI smoother
     useful info about PyQt6 threads: https://www.pythontutorial.net/pyqt/pyqt-qthread/'''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 from PyQt6.QtCore import QObject, pyqtSignal, pyqtSlot
 from IQM_Vis.utils import plot_utils
 
diff --git a/docs/_build/html/_modules/IQM_Vis/UI/utils.html b/docs/_build/html/_modules/IQM_Vis/UI/utils.html
index 785215e..4842cc4 100644
--- a/docs/_build/html/_modules/IQM_Vis/UI/utils.html
+++ b/docs/_build/html/_modules/IQM_Vis/UI/utils.html
@@ -84,7 +84,10 @@
            

              
   
Source code for IQM_Vis.UI.utils
-from PyQt6.QtWidgets import QWidget
+# Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
+from PyQt6.QtWidgets import QWidget
 
 
 
[docs]def add_layout_to_tab(tab, layout, name):
diff --git a/docs/_build/html/_modules/IQM_Vis/UI/widgets.html b/docs/_build/html/_modules/IQM_Vis/UI/widgets.html
index 4605ef5..c092459 100644
--- a/docs/_build/html/_modules/IQM_Vis/UI/widgets.html
+++ b/docs/_build/html/_modules/IQM_Vis/UI/widgets.html
@@ -88,6 +88,8 @@ 
Source code for IQM_Vis.UI.widgets
 UI create widgets
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 import re
 from functools import partial
 
diff --git a/docs/_build/html/_modules/IQM_Vis/data_handlers/data_api.html b/docs/_build/html/_modules/IQM_Vis/data_handlers/data_api.html
index 3ae2d67..e7cd29f 100644
--- a/docs/_build/html/_modules/IQM_Vis/data_handlers/data_api.html
+++ b/docs/_build/html/_modules/IQM_Vis/data_handlers/data_api.html
@@ -89,6 +89,8 @@ 
Source code for IQM_Vis.data_handlers.data_api
both use the same image for reference and transformed
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 import os
 import imghdr
 from functools import cache
diff --git a/docs/_build/html/_modules/IQM_Vis/data_handlers/data_api_abstract.html b/docs/_build/html/_modules/IQM_Vis/data_handlers/data_api_abstract.html
index 5e3e130..5760a7b 100644
--- a/docs/_build/html/_modules/IQM_Vis/data_handlers/data_api_abstract.html
+++ b/docs/_build/html/_modules/IQM_Vis/data_handlers/data_api_abstract.html
@@ -88,6 +88,8 @@ 
Source code for IQM_Vis.data_handlers.data_api_abstract
blueprint for data loader API
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 from abc import ABC, abstractmethod
 
 
[docs]class base_dataloader(ABC):
diff --git a/docs/_build/html/_modules/IQM_Vis/examples/all.html b/docs/_build/html/_modules/IQM_Vis/examples/all.html
index 5162d26..3c80c6e 100644
--- a/docs/_build/html/_modules/IQM_Vis/examples/all.html
+++ b/docs/_build/html/_modules/IQM_Vis/examples/all.html
@@ -85,6 +85,9 @@
              
   
Source code for IQM_Vis.examples.all
 ''' run all avaiable metrics/ transforms '''
+# Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 import IQM_Vis
 
 
[docs]def run():
diff --git a/docs/_build/html/_modules/IQM_Vis/examples/dataset.html b/docs/_build/html/_modules/IQM_Vis/examples/dataset.html
index 42096d0..6c1c914 100644
--- a/docs/_build/html/_modules/IQM_Vis/examples/dataset.html
+++ b/docs/_build/html/_modules/IQM_Vis/examples/dataset.html
@@ -84,7 +84,10 @@
            

              
   
Source code for IQM_Vis.examples.dataset
-import os
+# Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
+import os
 import numpy as np
 import IQM_Vis
 
diff --git a/docs/_build/html/_modules/IQM_Vis/examples/dists.html b/docs/_build/html/_modules/IQM_Vis/examples/dists.html
index 4bfc263..d4b3e7e 100644
--- a/docs/_build/html/_modules/IQM_Vis/examples/dists.html
+++ b/docs/_build/html/_modules/IQM_Vis/examples/dists.html
@@ -84,7 +84,10 @@
            

              
   
Source code for IQM_Vis.examples.dists
-import os
+# Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
+import os
 import glob
 import numpy as np
 import torch
diff --git a/docs/_build/html/_modules/IQM_Vis/examples/experiment.html b/docs/_build/html/_modules/IQM_Vis/examples/experiment.html
index ca6c2b8..3645146 100644
--- a/docs/_build/html/_modules/IQM_Vis/examples/experiment.html
+++ b/docs/_build/html/_modules/IQM_Vis/examples/experiment.html
@@ -84,7 +84,10 @@
            

              
   
Source code for IQM_Vis.examples.experiment
-import os
+# Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
+import os
 import numpy as np
 import IQM_Vis
 
diff --git a/docs/_build/html/_modules/IQM_Vis/examples/kodak.html b/docs/_build/html/_modules/IQM_Vis/examples/kodak.html
index 0ca63ab..a795291 100644
--- a/docs/_build/html/_modules/IQM_Vis/examples/kodak.html
+++ b/docs/_build/html/_modules/IQM_Vis/examples/kodak.html
@@ -85,6 +85,9 @@
              
   
Source code for IQM_Vis.examples.kodak
 ''' KODAK dataset '''
+# Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 import os
 import glob
 import IQM_Vis
diff --git a/docs/_build/html/_modules/IQM_Vis/examples/multiple.html b/docs/_build/html/_modules/IQM_Vis/examples/multiple.html
index df86b4e..a46d8a3 100644
--- a/docs/_build/html/_modules/IQM_Vis/examples/multiple.html
+++ b/docs/_build/html/_modules/IQM_Vis/examples/multiple.html
@@ -84,7 +84,10 @@
            

              
   
Source code for IQM_Vis.examples.multiple
-import os
+# Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
+import os
 import numpy as np
 import IQM_Vis
 
diff --git a/docs/_build/html/_modules/IQM_Vis/examples/new_api.html b/docs/_build/html/_modules/IQM_Vis/examples/new_api.html
index 663ad11..1c2d2d8 100644
--- a/docs/_build/html/_modules/IQM_Vis/examples/new_api.html
+++ b/docs/_build/html/_modules/IQM_Vis/examples/new_api.html
@@ -85,6 +85,9 @@
              
   
Source code for IQM_Vis.examples.new_api
 ''' KODAK dataset '''
+# Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 import os
 import glob
 import IQM_Vis
diff --git a/docs/_build/html/_modules/IQM_Vis/examples/simple.html b/docs/_build/html/_modules/IQM_Vis/examples/simple.html
index 57a39da..99f4bf5 100644
--- a/docs/_build/html/_modules/IQM_Vis/examples/simple.html
+++ b/docs/_build/html/_modules/IQM_Vis/examples/simple.html
@@ -84,7 +84,10 @@
            

              
   
Source code for IQM_Vis.examples.simple
-import os
+# Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
+import os
 import numpy as np
 import IQM_Vis
 
diff --git a/docs/_build/html/_modules/IQM_Vis/metrics/IQMs.html b/docs/_build/html/_modules/IQM_Vis/metrics/IQMs.html
index fe4a8ec..20672d2 100644
--- a/docs/_build/html/_modules/IQM_Vis/metrics/IQMs.html
+++ b/docs/_build/html/_modules/IQM_Vis/metrics/IQMs.html
@@ -89,6 +89,8 @@ 
Source code for IQM_Vis.metrics.IQMs
 sample metrics to use with the examples of the UI
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 import torch
 import torch.nn as nn
 import numpy as np
diff --git a/docs/_build/html/_modules/IQM_Vis/metrics/SSIM/ssim.html b/docs/_build/html/_modules/IQM_Vis/metrics/SSIM/ssim.html
index 9d2e37e..0814006 100644
--- a/docs/_build/html/_modules/IQM_Vis/metrics/SSIM/ssim.html
+++ b/docs/_build/html/_modules/IQM_Vis/metrics/SSIM/ssim.html
@@ -88,6 +88,9 @@ 
Source code for IQM_Vis.metrics.SSIM.ssim
 # taken from https://github.com/VainF/pytorch-msssim/blob/master/pytorch_msssim/ssim.py
 # Copyright 2020 by Gongfan Fang, Zhejiang University.
 # All rights reserved.
+# Author: Gongfan Fang
+# Licence: MIT
+
 import warnings
 from typing import List, Optional, Tuple, Union
 
diff --git a/docs/_build/html/_modules/IQM_Vis/transformations/transforms.html b/docs/_build/html/_modules/IQM_Vis/transformations/transforms.html
index 6f735dd..5803265 100644
--- a/docs/_build/html/_modules/IQM_Vis/transformations/transforms.html
+++ b/docs/_build/html/_modules/IQM_Vis/transformations/transforms.html
@@ -89,6 +89,8 @@ 
Source code for IQM_Vis.transformations.transforms
Sample image transformations to get the user started with
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 from skimage.transform import resize, rotate
 from skimage.util import img_as_ubyte
 import cv2
diff --git a/docs/_build/html/_modules/IQM_Vis/ui_wrapper.html b/docs/_build/html/_modules/IQM_Vis/ui_wrapper.html
index 7a65e29..6156699 100644
--- a/docs/_build/html/_modules/IQM_Vis/ui_wrapper.html
+++ b/docs/_build/html/_modules/IQM_Vis/ui_wrapper.html
@@ -89,6 +89,8 @@ 
Source code for IQM_Vis.ui_wrapper
 TODO: write docs on example usage/ what inputs etc. and what attributes that the data_store class needs
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 import subprocess
 import platform
 import sys
@@ -121,7 +123,8 @@ 
Source code for IQM_Vis.ui_wrapper
                  default_save_dir=IQM_Vis.utils.save_utils.DEFAULT_SAVE_DIR,
                  restrict_options=None,
                  num_steps_range=11,
-                 debug=False):
+                 debug=False, 
+                 test=False):
         if data_store == None:
             data_store = IQM_Vis.dataset_holder(image_list,
                                    metrics,
@@ -135,8 +138,10 @@ 
Source code for IQM_Vis.ui_wrapper
         self.restrict_options = restrict_options
         self.num_steps_range = num_steps_range
         self.debug = debug
+        self.test = test
         check_pyqt_install_deps()
         self.show()
+        self.showing = True
 
 
[docs]    def show(self):
         self._check_restrict_options()
@@ -144,8 +149,8 @@ 
Source code for IQM_Vis.ui_wrapper
         self._check_trans()
         if self.debug:
             self._check_inputs()
-        app = QApplication(sys.argv)
-        window = make_app(app,
+        self.app = QApplication(sys.argv)
+        self.window = make_app(self.app,
                           self.data_store,
                           self.transformations,
                           metrics_info_format=self.metrics_info_format,
@@ -153,8 +158,10 @@ 
Source code for IQM_Vis.ui_wrapper
                           metric_params=self.metric_params,
                           default_save_dir=self.default_save_dir,
                           restrict_options=self.restrict_options,
-                          num_steps_range=self.num_steps_range)
-        sys.exit(app.exec())

+                          num_steps_range=self.num_steps_range,
+                          test=self.test)
+        if self.test == False:
+            sys.exit(self.app.exec())

 
     def _check_restrict_options(self):
         if self.restrict_options == None:
diff --git a/docs/_build/html/_modules/IQM_Vis/utils/gui_utils.html b/docs/_build/html/_modules/IQM_Vis/utils/gui_utils.html
index 53b1af6..00eabef 100644
--- a/docs/_build/html/_modules/IQM_Vis/utils/gui_utils.html
+++ b/docs/_build/html/_modules/IQM_Vis/utils/gui_utils.html
@@ -88,6 +88,8 @@ 
Source code for IQM_Vis.utils.gui_utils
 Utils for PyQt6 image, text and graph widgets
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 try:
     from PyQt6.QtGui import QPixmap, QImage
     import matplotlib; matplotlib.use('Qt5Agg')
diff --git a/docs/_build/html/_modules/IQM_Vis/utils/image_utils.html b/docs/_build/html/_modules/IQM_Vis/utils/image_utils.html
index 8edd9ab..372d355 100644
--- a/docs/_build/html/_modules/IQM_Vis/utils/image_utils.html
+++ b/docs/_build/html/_modules/IQM_Vis/utils/image_utils.html
@@ -88,6 +88,8 @@ 
Source code for IQM_Vis.utils.image_utils
 image helper functions
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 import os
 import PIL
 import cv2
diff --git a/docs/_build/html/_modules/IQM_Vis/utils/plot_utils.html b/docs/_build/html/_modules/IQM_Vis/utils/plot_utils.html
index a7bb159..3e8c991 100644
--- a/docs/_build/html/_modules/IQM_Vis/utils/plot_utils.html
+++ b/docs/_build/html/_modules/IQM_Vis/utils/plot_utils.html
@@ -89,6 +89,8 @@ 
Source code for IQM_Vis.utils.plot_utils
 TODO: write docs how to use these (currently just have to look at the UI code)
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 from functools import partial
 import math
 
diff --git a/docs/_build/html/_modules/IQM_Vis/utils/save_utils.html b/docs/_build/html/_modules/IQM_Vis/utils/save_utils.html
index 08b68d5..892c8ae 100644
--- a/docs/_build/html/_modules/IQM_Vis/utils/save_utils.html
+++ b/docs/_build/html/_modules/IQM_Vis/utils/save_utils.html
@@ -88,6 +88,8 @@ 
Source code for IQM_Vis.utils.save_utils
 utils for saving experiments, images and figures
 '''
 # Author: Matt Clifford <matt.clifford@bristol.ac.uk>
+# License: BSD 3-Clause License
+
 import os
 import json
 import pickle
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
index 7576d6f..491a5dc 100644
--- a/docs/_build/html/_sources/index.rst.txt
+++ b/docs/_build/html/_sources/index.rst.txt
@@ -9,7 +9,7 @@ IQM-Vis is an image quality metric visualisation toolbox to facilitate visualisi
 View our demonstration `video `_ which illustrates the features and how to use IQM-Vis.
 
 
-Read our `PAPER `_ for in depth details of the software.
+Read our `PAPER `_ for in depth details of the software.
 
 Quantitive Analysis
 ===================
diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
index fda2414..e561eb3 100644
--- a/docs/_build/html/index.html
+++ b/docs/_build/html/index.html
@@ -89,7 +89,7 @@
 
IQM-Vis documentation

 
IQM-Vis is an image quality metric visualisation toolbox to facilitate visualising and evaluating image quality metrics (IQMs).
 View our demonstration video which illustrates the features and how to use IQM-Vis.

-
Read our PAPER for in depth details of the software.

+
Read our PAPER for in depth details of the software.

 

 
Quantitive Analysis

 
IQM-Vis is able to provide a comprehensive analysis of IQMs through various quantitative graphs. These graphs offer practitioners a well-rounded understanding of how different IQMs perform under different scenarios without having to write any code to set up the testing procedure.

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
index 8c99c09..82c1663 100644
--- a/docs/_build/html/searchindex.js
+++ b/docs/_build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["IQM_Vis","IQM_Vis.UI","IQM_Vis.data_handlers","IQM_Vis.examples","IQM_Vis.examples.images","IQM_Vis.metrics","IQM_Vis.metrics.SSIM","IQM_Vis.transformations","IQM_Vis.utils","Tutorials","about","getting_started","index","modules","notebooks/Tutorial_1-making_the_UI","notebooks/Tutorial_2-Customisation","notebooks/Tutorial_3-Advanced-Customisations","notebooks/Tutorial_4-running_an_experiment","what-are-IQMs"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.viewcode":1,nbsphinx:4,sphinx:56},filenames:["IQM_Vis.rst","IQM_Vis.UI.rst","IQM_Vis.data_handlers.rst","IQM_Vis.examples.rst","IQM_Vis.examples.images.rst","IQM_Vis.metrics.rst","IQM_Vis.metrics.SSIM.rst","IQM_Vis.transformations.rst","IQM_Vis.utils.rst","Tutorials.rst","about.rst","getting_started.rst","index.rst","modules.rst","notebooks/Tutorial_1-making_the_UI.ipynb","notebooks/Tutorial_2-Customisation.ipynb","notebooks/Tutorial_3-Advanced-Customisations.ipynb","notebooks/Tutorial_4-running_an_experiment.ipynb","what-are-IQMs.rst"],objects:{"":[[0,0,0,"-","IQM_Vis"]],"IQM_Vis.UI":[[1,0,0,"-","custom_widgets"],[1,0,0,"-","experiment_mode"],[1,0,0,"-","images"],[1,0,0,"-","layout"],[1,0,0,"-","main"],[1,0,0,"-","threads"],[1,0,0,"-","utils"],[1,0,0,"-","widgets"]],"IQM_Vis.UI.custom_widgets":[[1,1,1,"","ClickLabel"],[1,1,1,"","ProgressBar"]],"IQM_Vis.UI.custom_widgets.ClickLabel":[[1,2,1,"","clicked"],[1,3,1,"","mousePressEvent"]],"IQM_Vis.UI.experiment_mode":[[1,1,1,"","make_experiment"],[1,4,1,"","make_name_for_trans"],[1,1,1,"","reset_image_widget_to_black"],[1,4,1,"","sort_list"]],"IQM_Vis.UI.experiment_mode.make_experiment":[[1,3,1,"","calc_max_comparisons"],[1,3,1,"","change_experiment_images"],[1,3,1,"","click_completed"],[1,3,1,"","clicked_image"],[1,3,1,"","closeEvent"],[1,3,1,"","experiment_layout"],[1,3,1,"","finish_experiment"],[1,3,1,"","get_all_images"],[1,3,1,"","get_metric_scores"],[1,3,1,"","get_single_transform_im"],[1,3,1,"","init_style"],[1,3,1,"","partition"],[1,3,1,"","quick_sort"],[1,3,1,"","quit"],[1,2,1,"","reset_clicked_image"],[1,3,1,"","reset_experiment"],[1,3,1,"","save_experiment"],[1,2,1,"","saved_experiment"],[1,3,1,"","setup_experiment"],[1,3,1,"","show_all_images"],[1,3,1,"","start_experiment"],[1,3,1,"","swap_inds"],[1,3,1,"","toggle_experiment"]],"IQM_Vis.UI.experiment_mode.reset_image_widget_to_black":[[1,3,1,"","change_to_solid"],[1,2,1,"","completed"],[1,3,1,"","stop"]],"IQM_Vis.UI.images":[[1,1,1,"","images"],[1,4,1,"","message_on_plot"]],"IQM_Vis.UI.images.images":[[1,3,1,"","change_data"],[1,3,1,"","change_metric_correlations_graph"],[1,3,1,"","change_metric_range_graph"],[1,3,1,"","change_to_data_num"],[1,3,1,"","change_to_specific_trans"],[1,3,1,"","completed_range_results"],[1,3,1,"","display_images"],[1,3,1,"","display_metric_correlation_plot"],[1,3,1,"","display_metric_images"],[1,3,1,"","display_metric_range_plot"],[1,3,1,"","display_metrics"],[1,3,1,"","display_metrics_graph"],[1,3,1,"","display_metrics_text"],[1,3,1,"","display_radar_plots"],[1,3,1,"","get_metrics_over_all_trans_with_init_values"],[1,3,1,"","init_worker_thread"],[1,3,1,"","load_experiment_from_dir"],[1,3,1,"","load_human_experiment"],[1,3,1,"","load_new_images_folder"],[1,3,1,"","load_new_single_image"],[1,3,1,"","plot_radar_graph"],[1,3,1,"","redo_plots"],[1,2,1,"","request_range_work"],[1,3,1,"","stopped_range_worker"],[1,3,1,"","update_datastore_image_list"],[1,2,1,"","view_correlation_instance"]],"IQM_Vis.UI.layout":[[1,1,1,"","layout"]],"IQM_Vis.UI.layout.layout":[[1,3,1,"","init_layout"],[1,3,1,"","init_style"]],"IQM_Vis.UI.main":[[1,1,1,"","make_app"],[1,4,1,"","set_checked_menu_from_iterable"]],"IQM_Vis.UI.main.make_app":[[1,3,1,"","change_save_folder"],[1,3,1,"","closeEvent"],[1,3,1,"","construct_UI"],[1,3,1,"","get_menu_checkboxes"],[1,3,1,"","load_all_metric_images"],[1,3,1,"","load_all_metrics"],[1,3,1,"","load_all_transforms"],[1,3,1,"","make_menu"],[1,3,1,"","make_status_bar"],[1,3,1,"","quit"],[1,3,1,"","reset_correlation_data"]],"IQM_Vis.UI.threads":[[1,1,1,"","get_range_results_worker"]],"IQM_Vis.UI.threads.get_range_results_worker":[[1,2,1,"","completed"],[1,2,1,"","current_image"],[1,3,1,"","do_work"],[1,2,1,"","progress"],[1,3,1,"","stop"],[1,2,1,"","stopped"]],"IQM_Vis.UI.utils":[[1,4,1,"","add_layout_to_tab"]],"IQM_Vis.UI.widgets":[[1,1,1,"","custom_float_validator"],[1,4,1,"","get_float_validator"],[1,4,1,"","is_almost_float"],[1,4,1,"","is_float"],[1,4,1,"","make_float_from_text"],[1,1,1,"","widgets"]],"IQM_Vis.UI.widgets.custom_float_validator":[[1,3,1,"","validate"]],"IQM_Vis.UI.widgets.widgets":[[1,3,1,"","change_display_im_display_brightness"],[1,3,1,"","change_display_im_rgb_brightness"],[1,3,1,"","change_display_im_size"],[1,3,1,"","change_graph_size"],[1,3,1,"","change_human_scores_after_exp"],[1,3,1,"","change_num_steps"],[1,3,1,"","change_plot_lims"],[1,3,1,"","change_post_processing"],[1,3,1,"","change_pre_processing"],[1,3,1,"","change_text_exp_trans"],[1,3,1,"","colour_lineedit"],[1,3,1,"","disable_settings_button"],[1,3,1,"","display_slider_num"],[1,3,1,"","edit_slider_vals"],[1,3,1,"","enable_settings_button"],[1,3,1,"","generic_value_change"],[1,3,1,"","init_widgets"],[1,3,1,"","launch_experiment"],[1,3,1,"","make_slider_range"],[1,3,1,"","reset_slider_group"],[1,3,1,"","reset_sliders"],[1,3,1,"","set_image_name_text"],[1,3,1,"","update_image_settings"],[1,3,1,"","update_progress"],[1,3,1,"","update_status_bar"]],"IQM_Vis.data_handlers":[[2,0,0,"-","data_api"],[2,0,0,"-","data_api_abstract"]],"IQM_Vis.data_handlers.data_api":[[2,1,1,"","cache_metric_call"],[2,1,1,"","dataset_holder"],[2,4,1,"","get_image_name"]],"IQM_Vis.data_handlers.data_api.cache_metric_call":[[2,3,1,"","__call__"]],"IQM_Vis.data_handlers.data_api.dataset_holder":[[2,3,1,"","add_metric"],[2,3,1,"","add_metric_image"],[2,3,1,"","get_image_dataset_list"],[2,3,1,"","get_image_to_transform"],[2,3,1,"","get_image_to_transform_name"],[2,3,1,"","get_metric_images"],[2,3,1,"","get_metrics"],[2,3,1,"","get_reference_image"],[2,3,1,"","get_reference_image_name"],[2,3,1,"","get_reference_unprocessed"],[2,3,1,"","load_image_list"]],"IQM_Vis.data_handlers.data_api_abstract":[[2,1,1,"","base_dataloader"],[2,1,1,"","base_dataset_loader"]],"IQM_Vis.data_handlers.data_api_abstract.base_dataloader":[[2,3,1,"","get_image_to_transform"],[2,3,1,"","get_image_to_transform_name"],[2,3,1,"","get_metric_images"],[2,3,1,"","get_metrics"],[2,3,1,"","get_reference_image"],[2,3,1,"","get_reference_image_name"],[2,5,1,"","metric_images"],[2,5,1,"","metrics"]],"IQM_Vis.examples":[[3,0,0,"-","all"],[3,0,0,"-","dataset"],[3,0,0,"-","dists"],[3,0,0,"-","experiment"],[4,0,0,"-","images"],[3,0,0,"-","kodak"],[3,0,0,"-","multiple"],[3,0,0,"-","new_api"],[3,0,0,"-","simple"]],"IQM_Vis.examples.all":[[3,4,1,"","run"]],"IQM_Vis.examples.dataset":[[3,4,1,"","run"]],"IQM_Vis.examples.dists":[[3,4,1,"","correct"],[3,4,1,"","load_and_calibrate_image"],[3,4,1,"","run"]],"IQM_Vis.examples.experiment":[[3,4,1,"","run"]],"IQM_Vis.examples.kodak":[[3,4,1,"","run"]],"IQM_Vis.examples.multiple":[[3,4,1,"","run"]],"IQM_Vis.examples.new_api":[[3,4,1,"","run"]],"IQM_Vis.examples.simple":[[3,4,1,"","run"]],"IQM_Vis.metrics":[[5,0,0,"-","IQMs"],[6,0,0,"-","SSIM"],[5,4,1,"","get_all_IQM_params"],[5,4,1,"","get_all_metric_images"],[5,4,1,"","get_all_metrics"]],"IQM_Vis.metrics.IQMs":[[5,1,1,"","DISTS"],[5,1,1,"","LPIPS"],[5,1,1,"","MAE"],[5,1,1,"","MSE"],[5,1,1,"","MS_SSIM"],[5,1,1,"","NLPD"],[5,1,1,"","SSIM"],[5,4,1,"","make_kernel_odd"],[5,1,1,"","one_over_PSNR"]],"IQM_Vis.metrics.IQMs.DISTS":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.LPIPS":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.MAE":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.MSE":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.MS_SSIM":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.NLPD":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.SSIM":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.one_over_PSNR":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.SSIM":[[6,0,0,"-","ssim"]],"IQM_Vis.metrics.SSIM.ssim":[[6,1,1,"","MS_SSIM"],[6,1,1,"","SSIM"],[6,4,1,"","gaussian_filter"],[6,4,1,"","ms_ssim"],[6,4,1,"","ssim"]],"IQM_Vis.metrics.SSIM.ssim.MS_SSIM":[[6,3,1,"","forward"],[6,2,1,"","training"]],"IQM_Vis.metrics.SSIM.ssim.SSIM":[[6,3,1,"","forward"],[6,2,1,"","training"]],"IQM_Vis.transformations":[[7,4,1,"","get_all_transforms"],[7,0,0,"-","transforms"]],"IQM_Vis.transformations.transforms":[[7,4,1,"","Gaussian_noise"],[7,4,1,"","binary_threshold"],[7,4,1,"","blur"],[7,4,1,"","brightness"],[7,4,1,"","brightness_hsv"],[7,4,1,"","contrast"],[7,4,1,"","hue"],[7,4,1,"","jpeg_compression"],[7,4,1,"","rotation"],[7,4,1,"","salt_and_pepper_noise"],[7,4,1,"","saturation"],[7,4,1,"","x_shift"],[7,4,1,"","y_shift"],[7,4,1,"","zoom_image"]],"IQM_Vis.ui_wrapper":[[0,4,1,"","check_pyqt_install_deps"],[0,1,1,"","make_UI"],[0,4,1,"","test_datastore_attributes"],[0,1,1,"","transform_wrapper"]],"IQM_Vis.ui_wrapper.make_UI":[[0,3,1,"","show"]],"IQM_Vis.ui_wrapper.transform_wrapper":[[0,3,1,"","__call__"]],"IQM_Vis.utils":[[8,0,0,"-","gui_utils"],[8,0,0,"-","image_utils"],[8,0,0,"-","plot_utils"],[8,0,0,"-","save_utils"]],"IQM_Vis.utils.gui_utils":[[8,1,1,"","MplCanvas"],[8,4,1,"","change_im"],[8,4,1,"","get_image_pair_name"],[8,4,1,"","get_metric_image_name"],[8,4,1,"","get_resolutions"],[8,4,1,"","get_trans_dict_from_str"],[8,4,1,"","get_transformed_image_name"],[8,4,1,"","str_to_len"]],"IQM_Vis.utils.image_utils":[[8,4,1,"","calibrate_brightness"],[8,4,1,"","crop_centre"],[8,4,1,"","get_transform_image"],[8,4,1,"","load_image"],[8,4,1,"","resize_image"],[8,4,1,"","resize_to_longest_side"],[8,4,1,"","save_image"]],"IQM_Vis.utils.plot_utils":[[8,1,1,"","bar_plotter"],[8,4,1,"","click_scatter"],[8,4,1,"","compute_metric_for_human_correlation"],[8,4,1,"","compute_metrics_over_range"],[8,4,1,"","compute_metrics_over_range_single_trans"],[8,4,1,"","get_all_single_transform_params"],[8,4,1,"","get_all_slider_values"],[8,4,1,"","get_correlation_plot"],[8,4,1,"","get_radar_plots_avg_plots"],[8,4,1,"","get_transform_range_plots"],[8,4,1,"","hover_scatter"],[8,1,1,"","line_plotter"],[8,1,1,"","radar_plotter"],[8,1,1,"","scatter_plotter"],[8,4,1,"","update_annot"]],"IQM_Vis.utils.plot_utils.bar_plotter":[[8,3,1,"","plot"],[8,3,1,"","set_plot_lims"],[8,3,1,"","set_style"],[8,3,1,"","show"]],"IQM_Vis.utils.plot_utils.line_plotter":[[8,3,1,"","plot"],[8,3,1,"","set_plot_lims"],[8,3,1,"","set_style"],[8,3,1,"","show"]],"IQM_Vis.utils.plot_utils.radar_plotter":[[8,3,1,"","plot"],[8,3,1,"","set_plot_lims"],[8,3,1,"","set_style"],[8,3,1,"","show"]],"IQM_Vis.utils.plot_utils.scatter_plotter":[[8,3,1,"","plot"],[8,3,1,"","set_plot_lims"],[8,3,1,"","set_style"],[8,3,1,"","show"]],"IQM_Vis.utils.save_utils":[[8,6,1,"","DEFAULT_SAVE_DIR"],[8,4,1,"","get_IQM_file"],[8,4,1,"","get_human_scores_file"],[8,4,1,"","get_human_times_file"],[8,4,1,"","get_image_name_from_human_scores"],[8,4,1,"","get_image_processing_file"],[8,4,1,"","get_original_image_file"],[8,4,1,"","get_original_unprocessed_image_file"],[8,4,1,"","get_transform_functions_file"],[8,4,1,"","get_transform_params_file"],[8,4,1,"","load_json_dict"],[8,4,1,"","load_obj"],[8,4,1,"","save_and_merge_df_as_csv"],[8,4,1,"","save_df_as_csv"],[8,4,1,"","save_experiment_results"],[8,4,1,"","save_json_dict"],[8,4,1,"","save_obj"]],IQM_Vis:[[1,0,0,"-","UI"],[2,0,0,"-","data_handlers"],[3,0,0,"-","examples"],[5,0,0,"-","metrics"],[7,0,0,"-","transformations"],[0,0,0,"-","ui_wrapper"],[8,0,0,"-","utils"],[0,0,0,"-","version"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","function","Python function"],"5":["py","property","Python property"],"6":["py","data","Python data"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:function","5":"py:property","6":"py:data"},terms:{"0":[0,1,5,6,7,8,11,14,15,16],"01":[5,6],"03":[5,6],"1":[0,1,5,6,7,8,11,12,15,16],"10":11,"100":[7,8,15],"101":7,"11":[0,1,5,6,8,11],"128":8,"13":11,"14":11,"180":[5,15],"2":[6,7,8,12,16],"200":3,"2016_hvei":5,"250":8,"255":[6,7],"256":3,"2x":[7,8],"3":[6,8,11,12,15],"300":1,"39":15,"4":[5,6,12,15,16],"41":15,"5":[1,5,6,7,8,14,15,16],"6":[1,16],"7":[7,11,16],"8":16,"9":11,"90":7,"abstract":2,"byte":2,"class":[0,1,2,5,6,8,16],"default":[2,5,7,8,14,16],"do":[2,8,10,12,14],"float":[6,7,8,15,16],"function":[0,1,2,6,7,8,14,15,16,18],"import":[11,14,15,16,18],"int":[1,6,7,15],"new":[1,6,11,14],"return":[0,5,6,7,8,15,16,17],"true":[0,1,3,5,6,8,15],"try":6,"while":6,A:16,For:[2,15,16],If:[2,11,17],In:[14,15,16,17,18],It:[5,10,11,18],On:17,The:[5,10,14,17,18],Then:[11,16],There:[11,18],These:[12,15,18],To:[14,15,17],__call__:[0,2,5,16],__init__:16,_max:1,_min:1,_plot:8,_redo_plot:1,a0:1,a1:1,a_tran:1,ab:16,abc:2,abl:12,about:[1,16],abov:16,absolut:5,acceler:10,access:[0,10],accord:[6,18],achiev:[2,10],across:8,action_stor:1,activ:11,ad:[7,10,15],add:[1,7,14,16],add_layout_to_tab:1,add_metr:2,add_metric_imag:2,adher:18,adjust:[7,14,16],advanc:16,advantag:10,after:[2,8,14],afterward:6,against:[10,17],aim:18,al:5,alex:5,algorithm:[10,17,18],align:5,all:[0,1,2,5,6,7,8,13,14,17],all_metr:5,all_param:5,alongsid:[1,7],alreadi:2,also:[10,15,16,18],although:6,alwai:0,amount:7,an:[0,1,2,5,7,10,14,15],anaconda:11,analys:[10,12],analysi:[1,10,15],angl:7,ani:[10,12,14,16],annot:8,anyth:16,api:[0,2],app:1,append_char:8,append_dataset:1,appli:[1,2,14,18],apt:11,ar:[0,1,2,5,7,10,11,12,16,17,18],arbitrari:5,area:7,arg:[0,1,16],argument:[5,16],around:[7,11],arr:2,arrai:[1,2,5,7,8,16],aspect:15,associ:5,att:16,attempt:18,attribut:[0,16],automat:10,avaiabl:3,avail:[5,7],averag:6,avoid:0,ax:8,b:[7,14,17],b_tran:1,backend:[5,8,10],backend_qtagg:8,bar:14,bar_nam:8,bar_plott:8,base:[0,1,2,5,6,8],base_dataload:2,base_dataset_load:2,basic:15,batch:[5,6],been:2,befor:[14,15],behav:12,behaviour:18,being:[8,18],below:5,benchmark:18,best:[8,11,18],better:7,between:[0,1,5,18],beyond:7,binari:7,binary_threshold:7,black:[1,7,14],blank:14,blueprint:2,blur:[6,7,15],boarder:14,bool:[0,5,6,8],both:[2,18],bound:16,box:10,bright:[7,15,16],brightness_hsv:7,buffer:2,button:[1,17],c:[6,11],cach:2,cache_metric_cal:2,calc_max_comparison:1,calc_rang:1,calcul:[1,2,10,14],calibr:[10,17],calibrate_bright:8,call:[0,2,5,6,14,16],callabl:[2,16],can:[1,10,11,12,14,15,16,17,18],candela:14,capabilit:10,captur:18,care:6,categoris:18,centr:[7,8],chang:[1,8,14,15],change_data:1,change_display_im_display_bright:1,change_display_im_rgb_bright:1,change_display_im_s:1,change_experiment_imag:1,change_graph_s:1,change_human_scores_after_exp:1,change_im:8,change_metric_correlations_graph:1,change_metric_range_graph:1,change_num_step:1,change_plot_lim:1,change_post_process:1,change_pre_process:1,change_save_fold:1,change_text_exp_tran:1,change_to_data_num:1,change_to_solid:1,change_to_specific_tran:1,change_trans_value_sign:8,channel:6,check_pyqt_install_dep:0,checkbox:1,checked_metr:1,checked_transformation_param:1,choos:5,clash:11,click:[1,8,14,17],click_complet:1,click_scatt:8,clickabl:1,clicked_imag:1,clicklabel:1,clip:[7,16],closeev:1,code:[5,8,11],collect:10,colour:1,colour_lineedit:1,com:[5,14,15,16,17],commun:2,comp:15,compar:[10,15,17,18],comparison:[5,10,16],compat:5,complet:1,completed_range_result:1,comprehens:12,compress:7,comput:[6,8,14],compute_metric_for_human_correl:8,compute_metrics_over_rang:8,compute_metrics_over_range_single_tran:8,conda:11,conduct:[10,12],conflict:11,conform:[10,12],connect_func:1,consist:18,constant:6,construct_ui:1,constructor:2,contain:[8,14,17],content:13,context:18,contrast:7,control:5,conveni:10,conver:7,convert:[2,7],convolut:7,copi:14,correct:[0,3,10,17],correl:[8,10,17,18],correspond:[8,14,17],could:11,cover:10,crash:0,creat:[1,6,11,18],crop:[2,8,10,14],crop_centr:8,crope:8,crucial:10,css_file:1,csv:[8,17],cuda:11,current:8,current_imag:1,cursor0:11,custom:[1,10,15,16],custom_bright:16,custom_float_valid:1,custom_mae_class:16,custom_mae_funct:16,custom_widget:[0,13],customis:[12,17],d:6,data:[0,1,2,8,10,12,18],data_api:[0,8,13],data_api_abstract:[0,13],data_handl:[0,13],data_rang:6,data_stor:[0,1,8],dataset:[0,1,8,10,13,16],dataset_hold:2,debug:0,decod:7,decreas:7,deep:[5,18],def:16,default_save_dir:[0,1,8],defin:[6,15,16],degre:7,demonstr:[11,12],depend:11,depth:12,design:10,desir:[10,15],despit:18,detail:[10,12],develop:10,deviat:7,df:8,dict:[0,1,2,5,7,8],dict_:8,dictionari:[2,15,16],differ:[2,6,12],digit:7,dimens:5,dingkeyan93:5,dir:8,directori:14,disable_settings_button:1,disagre:17,disp_len:1,displai:[10,17],display_bright:[1,8],display_imag:1,display_metr:1,display_metric_correlation_plot:1,display_metric_imag:1,display_metric_range_plot:1,display_metrics_graph:1,display_metrics_text:1,display_radar_plot:1,display_slider_num:1,dissimilar:5,dist:[0,5,13],distanc:18,distor:12,distort:[7,10,12,15,16,18],distribut:6,do_work:1,doc:[0,8,14,15,16,17],document:[10,15],doe:11,doesn:0,don:11,down:1,download:11,downsiz:5,dpi:8,drop:1,dummi:16,dummy_arg:16,e:[5,6,11,12,14,16,18],each:[7,8],earli:5,edit_slider_v:1,effect:12,element:1,empir:18,en:5,enabl:10,enable_settings_button:1,encod:7,entri:1,environ:11,error:[5,8,11,16,18],es:5,et:5,etc:[0,17],euclidean:18,ev:1,evalu:[5,10,12,18],event:[1,8],everi:6,everyth:[15,17],exactli:16,exampl:[0,2,5,11,13,15,16,18],expand:16,expect:12,expens:18,experi:[0,1,8,12,13,18],experiment:18,experiment_layout:1,experiment_mod:[0,13],expos:10,extent:1,extra:16,extrem:18,f:15,facilit:[10,12],fail:10,fals:[0,1,5,6,8],featur:[10,12],feel:15,figur:8,figurecanvasqtagg:8,file:[2,3,8,14,15,17],file_path:2,filepath:15,fill:7,finish_experi:1,first:[11,17,18],firstli:12,fix:8,float32:7,folder:[1,14,17],follow:16,forc:6,form:[10,16],former:6,forward:6,frame:8,framework:10,free:15,fresh:11,from:[1,2,5,8,10,11,14,17,18],fucntion:2,further:[10,12],g:[5,6,11,12,14,16],gain:5,gan:5,gather:18,gauss:6,gaussian:7,gaussian_filt:6,gaussian_nois:7,gener:[2,5,10,17],generic_value_chang:1,geometr:5,get:[0,1,5,6,7,8,15],get_all_imag:1,get_all_iqm_param:5,get_all_metr:5,get_all_metric_imag:5,get_all_single_transform_param:8,get_all_slider_valu:8,get_all_transform:7,get_correlation_plot:8,get_float_valid:1,get_human_scores_fil:8,get_human_times_fil:8,get_image_dataset_list:2,get_image_nam:2,get_image_name_from_human_scor:8,get_image_pair_nam:8,get_image_processing_fil:8,get_image_to_transform:2,get_image_to_transform_nam:2,get_iqm_fil:8,get_menu_checkbox:1,get_metr:2,get_metric_imag:2,get_metric_image_nam:8,get_metric_scor:1,get_metrics_over_all_trans_with_init_valu:1,get_original_image_fil:8,get_original_unprocessed_image_fil:8,get_radar_plots_avg_plot:8,get_range_results_work:1,get_reference_imag:2,get_reference_image_nam:2,get_reference_unprocess:2,get_resolut:8,get_single_transform_im:1,get_trans_dict_from_str:8,get_transform_functions_fil:8,get_transform_imag:8,get_transform_params_fil:8,get_transform_range_plot:8,get_transformed_image_nam:8,getter:8,github:[5,12,14,15,16,17],give:[5,17,18],given:[1,5,7,8,18],go:[14,15,17],goal:18,gpu:[10,11],graph:[0,1,8,10,12],graphic:[10,18],greycal:3,grip:15,group:18,gui:10,gui_util:[0,13],h:[6,7],ha:[10,17],half:8,handl:10,handler:0,hardwar:10,hashabl:2,have:[2,5,7,8,11,12,14,16,18],head:11,helper:8,here:[0,16,17],high:1,higher:[1,7],highest:10,hold:8,home:[0,1,8,15,16],hook:6,horizont:7,hover_scatt:8,how:[5,8,12,14,15,17],html:15,http:[1,5,14,15,16,17],hue:7,human:[17,18],human_exp_csv:2,human_scor:8,i:[1,18],ident:7,ignor:6,illustr:12,im:8,im_comp:[5,16],im_ref:[5,16],imag:[0,2,3,5,6,7,8,10,12,13,16,17,18],image1:15,image2:15,image_display_s:1,image_list:[0,1,2,15,16],image_list_to_transform:2,image_load:2,image_nam:1,image_path:8,image_post_process:2,image_postprocess:1,image_pre_process:2,image_preprocess:1,image_util:[0,13],img:[3,8],implement:10,improv:10,includ:[10,14,15,16],increas:7,ind:[1,8],index:[5,8,11,12,18],individu:8,info:1,info_item:1,inform:[15,17],init:[1,15],init_layout:1,init_styl:1,init_valu:[7,15,16],init_widget:1,init_worker_thread:1,initi:8,initialis:[1,16],input:[0,2,6,15,16],input_str:1,inspect:12,instal:0,instanc:[5,6],instead:[6,8,15],interact:18,interfac:[6,10],invari:18,investig:12,io:15,ipynb:[14,15,16,17],iqm:[0,1,2,8,11,13,14,15,16,17],iqm_scores_df:8,iqm_vi:[11,12,14,15,16],is_almost_float:1,is_float:1,item:[8,14],iter:1,its:[0,7,8],itself:18,ival:1,j:1,jpeg:[0,7,15],jpeg_compress:[7,15],jpg:15,just:[8,18],k1:[5,6],k2:[5,6],k:6,keep_siz:8,kei:[1,2,8,16],kernel:[5,6,7,15],kernel_s:7,keyword:5,know:11,kodak:[0,13,16],kodim01:16,kodim02:16,kwarg:[0,1,2,5,16],l1:16,label:[1,8],laparra:5,lapeva:5,laplacian:5,larger:6,later:[15,16],latest:11,latter:6,launch:[14,17],launch_experi:1,layout:[0,13],learn:[5,18],left:1,lend:18,length:8,less:7,let:[15,16],level:6,librari:[0,11],libxcb:11,light:1,like:[11,16,18],lim:8,line_plott:8,linux:0,list1:1,list2:1,list:[0,1,2,6,8,15],literatur:18,littl:15,load:[2,8,11,17],load_all_metr:1,load_all_metric_imag:1,load_all_transform:1,load_and_calibrate_imag:3,load_experiment_from_dir:1,load_human_experi:1,load_imag:[2,8],load_image_list:2,load_json_dict:8,load_new_images_fold:1,load_new_single_imag:1,load_obj:8,loader:2,local:[5,15],longest:8,look:8,loss:[5,18],low:1,lower:1,lpip:5,lumin:[5,10,14,17],mae:[5,15,16],mai:18,main:[0,13,14,15,16,17],main_menu:1,make:[0,8,11,12,17],make_app:1,make_experi:1,make_float_from_text:1,make_kernel_odd:5,make_menu:1,make_name_for_tran:1,make_slider_rang:1,make_status_bar:1,make_ui:[0,11,14,15,16],maker:15,maketh:1,making_the_ui:14,manag:[10,12],mani:10,matplotlib:8,matt:[0,1,8,15,16],mattclifford1:[14,15,16,17],max:[7,8,15,16],max_lumin:3,maximum:14,mean:[5,16,18],measur:[5,14,18],menu:[1,14,17],messag:1,message_on_plot:1,meta_dict:3,meter:14,method:8,metric:[0,1,2,3,8,10,12,13,17,18],metric_imag:[0,1,2,15],metric_param:[0,1,8,16],metric_range_graph:1,metric_scor:8,metrics_avg_graph:[0,1],metrics_info_format:[0,1],metrics_nam:8,metrics_to_us:[2,8],might:[16,17],mild:5,mimic:18,min:[7,8,15,16],miss:11,model:18,modul:[12,13],more:[10,15],most:17,mousepressev:1,mplcanva:8,ms:6,ms_ssim:[5,6],mse:[5,15],mse_imag:15,mssim_kernel_s:5,much:18,multi:5,multipl:[0,13],must:5,mutabl:2,n:[6,11,14,17],name:[1,2,7,8],nan:6,navig:14,necessari:18,need:[0,1,2,6,8,14,15,16,17],neg:6,net:1,network:5,new_api:[0,13],newer:11,nlpd:5,nlpd_k:5,nn:6,nois:[5,7],noise_ratio:5,non:[8,15],none:[0,1,2,6,8],nonneg:6,nonnegative_ssim:6,normal:[6,7,8,15],normalis:[5,15],note:[5,8,16],notebook:[14,15,16,17],now:[11,15,16],np:[5,7,8,16],num_imag:1,num_step:[1,8],num_step_experi:1,num_steps_rang:[0,1],number:[7,14],numpi:[2,8,10,16],nvidia:11,object:[0,1,2,5,8,16,18],observ:18,obtain:18,odd:[7,15],off:16,offer:12,often:18,onc:17,one:6,one_over_psnr:5,onli:[7,8,14,15,17],opencv:10,oper:[5,15,18],option:[1,2,6,10,15,17],order:[1,10,17],ordin:10,org:5,origin:8,other:[8,10],our:[12,16],out:[7,8,10],over:[5,8,11,14,15],overridden:6,overse:18,own:[15,16,17],packag:[11,12,13,15,16],packg:14,pair:[5,10],pairwis:17,paper:[5,12],param1:16,param:[1,6,16],param_group:1,paramet:[2,5,7,8,12,14,16,18],paramt:[8,14],parent:1,particip:[10,17],particular:10,partit:1,pass:[6,15,16],past:14,patch:5,path:[1,2,8,15],paus:1,pbar_sign:8,pdf:5,peak:5,peak_sign:5,peel:16,peic:15,pepper:7,per:14,perceiv:[10,18],percentag:[7,8],percept:18,perceptu:[5,18],perform:[6,12,18],pick:10,pickl:8,pickle_path:8,pip:11,pivot:1,pixel:[5,7],pkl:8,place:14,platform:11,plethora:18,plot:[1,8,10,17],plot_radar_graph:1,plot_util:[0,13],plu:8,plugin:11,png:16,point:[1,5,8,11,17],polar:8,post:8,practition:[10,12,18],pre:10,premis:18,presenc:18,press:[1,17],pretrain:5,previou:17,principl:18,print:15,prob:7,probabl:7,problem:11,procedur:12,process:[8,10,15,18],produc:[14,18],profil:18,progress:1,progressbar:1,project:[0,14,15],properti:[0,2,10,12],proport:7,propos:5,provid:[5,10,12,14,15],psnr:5,psychophys:18,purpos:1,put:16,pypi:11,pyqt6:[0,1,8,10],pyqt:1,pyramid:5,python:[10,11,14],pythontutori:1,pytorch:[5,10,11],qcloseev:1,qlabel:1,qmainwindow:1,qmouseev:1,qobject:1,qprogressbar:1,qt:11,qtcore:1,qtgui:1,qthread:1,qtwidget:1,qualit:[15,18],qualiti:[5,7,10,12,15,18],quantit:18,quick:[10,17],quick_sort:1,quit:1,qvalid:1,radar:8,radar_nam:8,radar_plott:8,ranc:8,rang:[1,6,7,8,14,15,16,18],rate:18,ratio:5,read:[12,17],readi:17,real:10,recent:18,recip:6,recommend:[7,11,14],recreat:18,recurs:10,redo_plot:1,reduc:5,reduct:5,ref:2,refer:[2,5,8,10,16,18],regist:6,reinstal:11,relev:11,relu:6,remain:18,repons:12,request_range_work:1,requir:[0,1,11,14,15,17,18],reset_clicked_imag:1,reset_correlation_data:1,reset_experi:1,reset_image_widget_to_black:1,reset_slid:1,reset_slider_group:1,resiz:[8,10],resize_imag:8,resize_to_longest_sid:8,respect:[10,18],respons:[6,18],restrict_opt:[0,1],result:[1,6,8,10,12],results_ord:8,return_dict:8,return_imag:[5,15],reult:8,rgb:8,rgb_bright:[1,8],right:1,robust:5,rotat:[2,7,10,14,15],round:12,run:[3,6,10,11,12,14],running_an_experi:17,s:[15,16,18],salt:7,salt_and_pepper_nois:7,same:[2,5,16,18],sampl:[5,7],sat:7,satur:7,save:[1,8,14,17],save_and_merge_df_as_csv:8,save_df_as_csv:8,save_dir:8,save_experi:1,save_experiment_result:8,save_imag:8,save_json_dict:8,save_obj:8,save_util:[0,13],saved_experi:1,scalar:[5,6,15],scale:5,scale_factor:[7,8],scatter:8,scatter_plott:8,scenario:[12,18],score:[1,5,10,16,17],scratch:11,screen:[10,14],script:14,second:18,secondli:12,see:[10,12,15,17],select:[10,12,14,17],self:[0,1,2,16],send:8,sent:1,serv:18,set:[1,12,17],set_checked_menu_from_iter:1,set_image_name_text:1,set_plot_lim:8,set_styl:8,setup:[1,17],setup_experi:1,shape:16,shift:7,ship:0,should:[6,11],show:[0,8,10,16,17],show_all_imag:1,shown:[16,17],side:8,sigma:[5,6],signal:[1,5,8],silent:6,similar:[5,15,17,18],simpl:[0,10,12,13],simpler:8,simplest:18,sinc:[2,6,15],singl:[8,16],single_trans_dict:1,size:[3,5,6,7,8,10,17],size_averag:6,skimag:7,skip:11,sliders_dict:1,small:[5,8],smaller:14,smoother:1,so:[0,1,8,10,11],softwar:[12,18],solv:11,some:[11,14,15],sort:[10,17],sort_list:1,sourc:[0,1,2,3,5,6,7,8],space:18,spacial:[12,15],spatial_dim:6,specif:[10,18],specifi:[8,15],spider:8,squar:[5,7,8,14,16,18],squeez:5,ssim:[0,5,12,15,18],ssim_imag:15,ssim_kernel_s:5,stanard:10,standard:[7,10],start:[7,15,16,17],start_experi:1,state:1,std:7,step:11,still:16,stop:1,stop_flag:8,stopped_range_work:1,storag:10,store:[2,15,16],str:[0,1,5],str_to_len:8,straightforward:10,strictli:5,string:8,structur:[5,18],style:1,subclass:[1,6],submodul:13,subpackag:13,subtract:5,sudo:11,sum:5,sure:[0,11,12,16,17],swap_ind:1,system:5,t:[0,6,11],tab:[1,14],take:[5,6,10,14,16,17],task:10,tell:16,tensor:6,test:12,test_datastore_attribut:0,text:[1,8],textur:5,than:[1,7],theh:14,thei:[0,2,16,17,18],them:[0,6,15,16],thi:[2,6,8,10,11,14,15,16,17,18],thing:17,thread:[0,13],threshold:7,through:[10,12,14,15,17],time:1,times_taken:8,timescal:10,todo:[0,8],toggle_experi:1,too:18,toolbox:12,torch:6,torchaudio:11,torchvis:11,tradit:18,train:6,tran:[1,2,8],trans_nam:8,trans_str:[1,8],trans_str_valu:8,transform:[0,1,2,3,5,8,10,12,13,17],transform_funct:8,transform_param:8,transform_valu:8,transform_wrapp:0,transformation_nam:8,transformed_imag:2,translat:[7,10],tree:[14,15,16,17],truthfulli:10,tupl:6,tutori:10,tutorial_1:14,tutorial_2:15,tutorial_3:16,tutorial_4:17,two:[5,12,15,18],txt:1,type:[5,6,7,8],ubuntu:11,ubyt:8,ui:[0,2,5,8,12,13,15,17],ui_wrapp:13,unchang:18,under:12,underli:10,understand:[10,12],undistort:10,union:6,unsort:1,until:17,up:[1,12],update_annot:8,update_datastore_image_list:1,update_image_set:1,update_progress:1,update_status_bar:1,us:[1,2,5,7,8,10,11,12,14,15,16,17],usag:0,user:[0,7,10,12,17],usual:6,util:[0,2,13],utilis:18,uv:5,v:1,valero:5,valid:1,valu:[2,5,6,7,8,14,15,16],var_nam:8,var_valu:8,varianc:5,variou:12,version:[11,13],vertic:7,vgg:5,vi:[0,1,2,8,11,14,15,16,17,18],via:2,video:12,view:[10,12,14,15,16,17],view_correlation_inst:1,virtual:11,visibl:18,visit:12,visual:[5,12],visualis:[10,12],w:6,wa:8,wai:12,want:[15,17],warn:0,waves1:[0,15],waves2:[0,15],waves3:0,we:[0,1,2,11,14,15,16,17,18],websit:11,weight:6,well:[10,11,12],what:[0,16],when:[1,5,8,14,15,17],where:18,whether:5,which:[2,5,8,10,11,12,18],whole:[8,14,15,16,17],why:18,widget:[0,8,13],widget_ax:1,widget_nam:1,wiki:5,wikipedia:5,win:6,win_sigma:6,win_siz:6,window:[1,6],within:[6,14,16],without:12,word:16,work:11,worker:1,world:10,would:[11,14],wrap:0,write:[0,8,12],www:[1,5],x:[6,8],x_label:8,x_shift:7,y:[6,8,11],y_label:8,y_shift:7,you:[6,11,12,14,15,16,17],your:[15,17],zero:15,zoom:[7,8],zoom_imag:7},titles:["IQM_Vis package","IQM_Vis.UI package","IQM_Vis.data_handlers package","IQM_Vis.examples package","IQM_Vis.examples.images package","IQM_Vis.metrics package","IQM_Vis.metrics.SSIM package","IQM_Vis.transformations package","IQM_Vis.utils package","Tutorials","About IQM-Vis","Getting Started","IQM-Vis documentation","IQM_Vis","Tutorial 1: Making the UI","Tutorial 2: Simple Customisation","Tutorial 3: Customisation Details","Tutorial 4: Running an Experiment","IQMs"],titleterms:{"1":14,"2":15,"3":16,"4":17,"function":10,For:18,about:[10,12],ad:14,all:[3,15],an:[12,17,18],analysi:12,bright:14,built:10,choos:18,code:12,common:11,content:[0,1,2,3,4,5,6,7,8],correl:12,custom_widget:1,customis:[15,16],data_api:2,data_api_abstract:2,data_handl:2,dataset:3,detail:16,differ:18,dispali:14,displai:14,dist:3,document:12,exampl:[3,4],experi:[3,10,14,17],experiment_mod:1,finsih:17,get:[11,12],graph:14,gui_util:8,how:18,human:[10,12],imag:[1,4,14,15],image_util:8,indic:12,info:17,instal:11,iqm:[5,10,12,18],iqm_vi:[0,1,2,3,4,5,6,7,8,13],issu:11,kodak:3,layout:1,load:14,main:1,make:[14,16],max:14,metric:[5,6,14,15,16],modul:[0,1,2,3,4,5,6,7,8],multipl:3,new_api:3,offer:10,other:14,own:14,packag:[0,1,2,3,4,5,6,7,8],percept:[10,12],plot_util:8,post:14,pre:14,process:14,put:15,qualit:12,quantit:12,result:17,rgb:14,run:17,save_util:8,screen:17,set:14,simpl:[3,15],size:14,softwar:10,sourc:12,ssim:6,start:[11,12],step:14,submodul:[0,1,2,3,5,6,7,8],subpackag:[0,3,5],tabl:12,task:18,test:11,thread:1,togeth:15,transform:[7,14,15,16],tutori:[9,12,14,15,16,17],type:18,ui:[1,14,16],ui_wrapp:0,util:[1,8],version:0,vi:[10,12],visualis:17,what:[10,12,18],widget:1,your:[14,18]}})
\ No newline at end of file
+Search.setIndex({docnames:["IQM_Vis","IQM_Vis.UI","IQM_Vis.data_handlers","IQM_Vis.examples","IQM_Vis.examples.images","IQM_Vis.metrics","IQM_Vis.metrics.SSIM","IQM_Vis.transformations","IQM_Vis.utils","Tutorials","about","getting_started","index","modules","notebooks/Tutorial_1-making_the_UI","notebooks/Tutorial_2-Customisation","notebooks/Tutorial_3-Advanced-Customisations","notebooks/Tutorial_4-running_an_experiment","what-are-IQMs"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.viewcode":1,nbsphinx:4,sphinx:56},filenames:["IQM_Vis.rst","IQM_Vis.UI.rst","IQM_Vis.data_handlers.rst","IQM_Vis.examples.rst","IQM_Vis.examples.images.rst","IQM_Vis.metrics.rst","IQM_Vis.metrics.SSIM.rst","IQM_Vis.transformations.rst","IQM_Vis.utils.rst","Tutorials.rst","about.rst","getting_started.rst","index.rst","modules.rst","notebooks/Tutorial_1-making_the_UI.ipynb","notebooks/Tutorial_2-Customisation.ipynb","notebooks/Tutorial_3-Advanced-Customisations.ipynb","notebooks/Tutorial_4-running_an_experiment.ipynb","what-are-IQMs.rst"],objects:{"":[[0,0,0,"-","IQM_Vis"]],"IQM_Vis.UI":[[1,0,0,"-","custom_widgets"],[1,0,0,"-","experiment_mode"],[1,0,0,"-","images"],[1,0,0,"-","layout"],[1,0,0,"-","main"],[1,0,0,"-","threads"],[1,0,0,"-","utils"],[1,0,0,"-","widgets"]],"IQM_Vis.UI.custom_widgets":[[1,1,1,"","ClickLabel"],[1,1,1,"","ProgressBar"]],"IQM_Vis.UI.custom_widgets.ClickLabel":[[1,2,1,"","clicked"],[1,3,1,"","mousePressEvent"]],"IQM_Vis.UI.experiment_mode":[[1,1,1,"","make_experiment"],[1,4,1,"","make_name_for_trans"],[1,1,1,"","reset_image_widget_to_black"],[1,4,1,"","sort_list"]],"IQM_Vis.UI.experiment_mode.make_experiment":[[1,3,1,"","calc_max_comparisons"],[1,3,1,"","change_experiment_images"],[1,3,1,"","click_completed"],[1,3,1,"","clicked_image"],[1,3,1,"","closeEvent"],[1,3,1,"","experiment_layout"],[1,3,1,"","finish_experiment"],[1,3,1,"","get_all_images"],[1,3,1,"","get_metric_scores"],[1,3,1,"","get_single_transform_im"],[1,3,1,"","init_style"],[1,3,1,"","partition"],[1,3,1,"","quick_sort"],[1,3,1,"","quit"],[1,2,1,"","reset_clicked_image"],[1,3,1,"","reset_experiment"],[1,3,1,"","save_experiment"],[1,2,1,"","saved_experiment"],[1,3,1,"","setup_experiment"],[1,3,1,"","show_all_images"],[1,3,1,"","start_experiment"],[1,3,1,"","swap_inds"],[1,3,1,"","toggle_experiment"]],"IQM_Vis.UI.experiment_mode.reset_image_widget_to_black":[[1,3,1,"","change_to_solid"],[1,2,1,"","completed"],[1,3,1,"","stop"]],"IQM_Vis.UI.images":[[1,1,1,"","images"],[1,4,1,"","message_on_plot"]],"IQM_Vis.UI.images.images":[[1,3,1,"","change_data"],[1,3,1,"","change_metric_correlations_graph"],[1,3,1,"","change_metric_range_graph"],[1,3,1,"","change_to_data_num"],[1,3,1,"","change_to_specific_trans"],[1,3,1,"","completed_range_results"],[1,3,1,"","display_images"],[1,3,1,"","display_metric_correlation_plot"],[1,3,1,"","display_metric_images"],[1,3,1,"","display_metric_range_plot"],[1,3,1,"","display_metrics"],[1,3,1,"","display_metrics_graph"],[1,3,1,"","display_metrics_text"],[1,3,1,"","display_radar_plots"],[1,3,1,"","get_metrics_over_all_trans_with_init_values"],[1,3,1,"","init_worker_thread"],[1,3,1,"","load_experiment_from_dir"],[1,3,1,"","load_human_experiment"],[1,3,1,"","load_new_images_folder"],[1,3,1,"","load_new_single_image"],[1,3,1,"","plot_radar_graph"],[1,3,1,"","redo_plots"],[1,2,1,"","request_range_work"],[1,3,1,"","stopped_range_worker"],[1,3,1,"","update_datastore_image_list"],[1,2,1,"","view_correlation_instance"]],"IQM_Vis.UI.layout":[[1,1,1,"","layout"]],"IQM_Vis.UI.layout.layout":[[1,3,1,"","init_layout"],[1,3,1,"","init_style"]],"IQM_Vis.UI.main":[[1,1,1,"","make_app"],[1,4,1,"","set_checked_menu_from_iterable"]],"IQM_Vis.UI.main.make_app":[[1,3,1,"","change_save_folder"],[1,3,1,"","closeEvent"],[1,3,1,"","construct_UI"],[1,3,1,"","get_menu_checkboxes"],[1,3,1,"","load_all_metric_images"],[1,3,1,"","load_all_metrics"],[1,3,1,"","load_all_transforms"],[1,3,1,"","make_menu"],[1,3,1,"","make_status_bar"],[1,3,1,"","quit"],[1,3,1,"","reset_correlation_data"]],"IQM_Vis.UI.threads":[[1,1,1,"","get_range_results_worker"]],"IQM_Vis.UI.threads.get_range_results_worker":[[1,2,1,"","completed"],[1,2,1,"","current_image"],[1,3,1,"","do_work"],[1,2,1,"","progress"],[1,3,1,"","stop"],[1,2,1,"","stopped"]],"IQM_Vis.UI.utils":[[1,4,1,"","add_layout_to_tab"]],"IQM_Vis.UI.widgets":[[1,1,1,"","custom_float_validator"],[1,4,1,"","get_float_validator"],[1,4,1,"","is_almost_float"],[1,4,1,"","is_float"],[1,4,1,"","make_float_from_text"],[1,1,1,"","widgets"]],"IQM_Vis.UI.widgets.custom_float_validator":[[1,3,1,"","validate"]],"IQM_Vis.UI.widgets.widgets":[[1,3,1,"","change_display_im_display_brightness"],[1,3,1,"","change_display_im_rgb_brightness"],[1,3,1,"","change_display_im_size"],[1,3,1,"","change_graph_size"],[1,3,1,"","change_human_scores_after_exp"],[1,3,1,"","change_num_steps"],[1,3,1,"","change_plot_lims"],[1,3,1,"","change_post_processing"],[1,3,1,"","change_pre_processing"],[1,3,1,"","change_text_exp_trans"],[1,3,1,"","colour_lineedit"],[1,3,1,"","disable_settings_button"],[1,3,1,"","display_slider_num"],[1,3,1,"","edit_slider_vals"],[1,3,1,"","enable_settings_button"],[1,3,1,"","generic_value_change"],[1,3,1,"","init_widgets"],[1,3,1,"","launch_experiment"],[1,3,1,"","make_slider_range"],[1,3,1,"","reset_slider_group"],[1,3,1,"","reset_sliders"],[1,3,1,"","set_image_name_text"],[1,3,1,"","update_image_settings"],[1,3,1,"","update_progress"],[1,3,1,"","update_status_bar"]],"IQM_Vis.data_handlers":[[2,0,0,"-","data_api"],[2,0,0,"-","data_api_abstract"]],"IQM_Vis.data_handlers.data_api":[[2,1,1,"","cache_metric_call"],[2,1,1,"","dataset_holder"],[2,4,1,"","get_image_name"]],"IQM_Vis.data_handlers.data_api.cache_metric_call":[[2,3,1,"","__call__"]],"IQM_Vis.data_handlers.data_api.dataset_holder":[[2,3,1,"","add_metric"],[2,3,1,"","add_metric_image"],[2,3,1,"","get_image_dataset_list"],[2,3,1,"","get_image_to_transform"],[2,3,1,"","get_image_to_transform_name"],[2,3,1,"","get_metric_images"],[2,3,1,"","get_metrics"],[2,3,1,"","get_reference_image"],[2,3,1,"","get_reference_image_name"],[2,3,1,"","get_reference_unprocessed"],[2,3,1,"","load_image_list"]],"IQM_Vis.data_handlers.data_api_abstract":[[2,1,1,"","base_dataloader"],[2,1,1,"","base_dataset_loader"]],"IQM_Vis.data_handlers.data_api_abstract.base_dataloader":[[2,3,1,"","get_image_to_transform"],[2,3,1,"","get_image_to_transform_name"],[2,3,1,"","get_metric_images"],[2,3,1,"","get_metrics"],[2,3,1,"","get_reference_image"],[2,3,1,"","get_reference_image_name"],[2,5,1,"","metric_images"],[2,5,1,"","metrics"]],"IQM_Vis.examples":[[3,0,0,"-","all"],[3,0,0,"-","dataset"],[3,0,0,"-","dists"],[3,0,0,"-","experiment"],[4,0,0,"-","images"],[3,0,0,"-","kodak"],[3,0,0,"-","multiple"],[3,0,0,"-","new_api"],[3,0,0,"-","simple"]],"IQM_Vis.examples.all":[[3,4,1,"","run"]],"IQM_Vis.examples.dataset":[[3,4,1,"","run"]],"IQM_Vis.examples.dists":[[3,4,1,"","correct"],[3,4,1,"","load_and_calibrate_image"],[3,4,1,"","run"]],"IQM_Vis.examples.experiment":[[3,4,1,"","run"]],"IQM_Vis.examples.kodak":[[3,4,1,"","run"]],"IQM_Vis.examples.multiple":[[3,4,1,"","run"]],"IQM_Vis.examples.new_api":[[3,4,1,"","run"]],"IQM_Vis.examples.simple":[[3,4,1,"","run"]],"IQM_Vis.metrics":[[5,0,0,"-","IQMs"],[6,0,0,"-","SSIM"],[5,4,1,"","get_all_IQM_params"],[5,4,1,"","get_all_metric_images"],[5,4,1,"","get_all_metrics"]],"IQM_Vis.metrics.IQMs":[[5,1,1,"","DISTS"],[5,1,1,"","LPIPS"],[5,1,1,"","MAE"],[5,1,1,"","MSE"],[5,1,1,"","MS_SSIM"],[5,1,1,"","NLPD"],[5,1,1,"","SSIM"],[5,4,1,"","make_kernel_odd"],[5,1,1,"","one_over_PSNR"]],"IQM_Vis.metrics.IQMs.DISTS":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.LPIPS":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.MAE":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.MSE":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.MS_SSIM":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.NLPD":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.SSIM":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.IQMs.one_over_PSNR":[[5,3,1,"","__call__"]],"IQM_Vis.metrics.SSIM":[[6,0,0,"-","ssim"]],"IQM_Vis.metrics.SSIM.ssim":[[6,1,1,"","MS_SSIM"],[6,1,1,"","SSIM"],[6,4,1,"","gaussian_filter"],[6,4,1,"","ms_ssim"],[6,4,1,"","ssim"]],"IQM_Vis.metrics.SSIM.ssim.MS_SSIM":[[6,3,1,"","forward"],[6,2,1,"","training"]],"IQM_Vis.metrics.SSIM.ssim.SSIM":[[6,3,1,"","forward"],[6,2,1,"","training"]],"IQM_Vis.transformations":[[7,4,1,"","get_all_transforms"],[7,0,0,"-","transforms"]],"IQM_Vis.transformations.transforms":[[7,4,1,"","Gaussian_noise"],[7,4,1,"","binary_threshold"],[7,4,1,"","blur"],[7,4,1,"","brightness"],[7,4,1,"","brightness_hsv"],[7,4,1,"","contrast"],[7,4,1,"","hue"],[7,4,1,"","jpeg_compression"],[7,4,1,"","rotation"],[7,4,1,"","salt_and_pepper_noise"],[7,4,1,"","saturation"],[7,4,1,"","x_shift"],[7,4,1,"","y_shift"],[7,4,1,"","zoom_image"]],"IQM_Vis.ui_wrapper":[[0,4,1,"","check_pyqt_install_deps"],[0,1,1,"","make_UI"],[0,4,1,"","test_datastore_attributes"],[0,1,1,"","transform_wrapper"]],"IQM_Vis.ui_wrapper.make_UI":[[0,3,1,"","show"]],"IQM_Vis.ui_wrapper.transform_wrapper":[[0,3,1,"","__call__"]],"IQM_Vis.utils":[[8,0,0,"-","gui_utils"],[8,0,0,"-","image_utils"],[8,0,0,"-","plot_utils"],[8,0,0,"-","save_utils"]],"IQM_Vis.utils.gui_utils":[[8,1,1,"","MplCanvas"],[8,4,1,"","change_im"],[8,4,1,"","get_image_pair_name"],[8,4,1,"","get_metric_image_name"],[8,4,1,"","get_resolutions"],[8,4,1,"","get_trans_dict_from_str"],[8,4,1,"","get_transformed_image_name"],[8,4,1,"","str_to_len"]],"IQM_Vis.utils.image_utils":[[8,4,1,"","calibrate_brightness"],[8,4,1,"","crop_centre"],[8,4,1,"","get_transform_image"],[8,4,1,"","load_image"],[8,4,1,"","resize_image"],[8,4,1,"","resize_to_longest_side"],[8,4,1,"","save_image"]],"IQM_Vis.utils.plot_utils":[[8,1,1,"","bar_plotter"],[8,4,1,"","click_scatter"],[8,4,1,"","compute_metric_for_human_correlation"],[8,4,1,"","compute_metrics_over_range"],[8,4,1,"","compute_metrics_over_range_single_trans"],[8,4,1,"","get_all_single_transform_params"],[8,4,1,"","get_all_slider_values"],[8,4,1,"","get_correlation_plot"],[8,4,1,"","get_radar_plots_avg_plots"],[8,4,1,"","get_transform_range_plots"],[8,4,1,"","hover_scatter"],[8,1,1,"","line_plotter"],[8,1,1,"","radar_plotter"],[8,1,1,"","scatter_plotter"],[8,4,1,"","update_annot"]],"IQM_Vis.utils.plot_utils.bar_plotter":[[8,3,1,"","plot"],[8,3,1,"","set_plot_lims"],[8,3,1,"","set_style"],[8,3,1,"","show"]],"IQM_Vis.utils.plot_utils.line_plotter":[[8,3,1,"","plot"],[8,3,1,"","set_plot_lims"],[8,3,1,"","set_style"],[8,3,1,"","show"]],"IQM_Vis.utils.plot_utils.radar_plotter":[[8,3,1,"","plot"],[8,3,1,"","set_plot_lims"],[8,3,1,"","set_style"],[8,3,1,"","show"]],"IQM_Vis.utils.plot_utils.scatter_plotter":[[8,3,1,"","plot"],[8,3,1,"","set_plot_lims"],[8,3,1,"","set_style"],[8,3,1,"","show"]],"IQM_Vis.utils.save_utils":[[8,6,1,"","DEFAULT_SAVE_DIR"],[8,4,1,"","get_IQM_file"],[8,4,1,"","get_human_scores_file"],[8,4,1,"","get_human_times_file"],[8,4,1,"","get_image_name_from_human_scores"],[8,4,1,"","get_image_processing_file"],[8,4,1,"","get_original_image_file"],[8,4,1,"","get_original_unprocessed_image_file"],[8,4,1,"","get_transform_functions_file"],[8,4,1,"","get_transform_params_file"],[8,4,1,"","load_json_dict"],[8,4,1,"","load_obj"],[8,4,1,"","save_and_merge_df_as_csv"],[8,4,1,"","save_df_as_csv"],[8,4,1,"","save_experiment_results"],[8,4,1,"","save_json_dict"],[8,4,1,"","save_obj"]],IQM_Vis:[[1,0,0,"-","UI"],[2,0,0,"-","data_handlers"],[3,0,0,"-","examples"],[5,0,0,"-","metrics"],[7,0,0,"-","transformations"],[0,0,0,"-","ui_wrapper"],[8,0,0,"-","utils"],[0,0,0,"-","version"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","function","Python function"],"5":["py","property","Python property"],"6":["py","data","Python data"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:function","5":"py:property","6":"py:data"},terms:{"0":[0,1,5,6,7,8,11,14,15,16],"01":[5,6],"03":[5,6],"1":[0,1,5,6,7,8,11,12,15,16],"10":11,"100":[7,8,15],"101":7,"11":[0,1,5,6,8,11],"128":8,"13":11,"14":11,"180":[5,15],"2":[6,7,8,12,16],"200":3,"2016_hvei":5,"250":8,"255":[6,7],"256":3,"2x":[7,8],"3":[6,8,11,12,15],"300":1,"39":15,"4":[5,6,12,15,16],"41":15,"5":[1,5,6,7,8,14,15,16],"6":[1,16],"7":[7,11,16],"8":16,"9":11,"90":7,"abstract":2,"byte":2,"class":[0,1,2,5,6,8,16],"default":[2,5,7,8,14,16],"do":[2,8,10,12,14],"float":[6,7,8,15,16],"function":[0,1,2,6,7,8,14,15,16,18],"import":[11,14,15,16,18],"int":[1,6,7,15],"new":[1,6,11,14],"return":[0,5,6,7,8,15,16,17],"true":[0,1,3,5,6,8,15],"try":6,"while":6,A:16,For:[2,15,16],If:[2,11,17],In:[14,15,16,17,18],It:[5,10,11,18],On:17,The:[5,10,14,17,18],Then:[11,16],There:[11,18],These:[12,15,18],To:[14,15,17],__call__:[0,2,5,16],__init__:16,_max:1,_min:1,_plot:8,_redo_plot:1,a0:1,a1:1,a_tran:1,ab:16,abc:2,abl:12,about:[1,16],abov:16,absolut:5,acceler:10,access:[0,10],accord:[6,18],achiev:[2,10],across:8,action_stor:1,activ:11,ad:[7,10,15],add:[1,7,14,16],add_layout_to_tab:1,add_metr:2,add_metric_imag:2,adher:18,adjust:[7,14,16],advanc:16,advantag:10,after:[2,8,14],afterward:6,against:[10,17],aim:18,al:5,alex:5,algorithm:[10,17,18],align:5,all:[0,1,2,5,6,7,8,13,14,17],all_metr:5,all_param:5,alongsid:[1,7],alreadi:2,also:[10,15,16,18],although:6,alwai:0,amount:7,an:[0,1,2,5,7,10,14,15],anaconda:11,analys:[10,12],analysi:[1,10,15],angl:7,ani:[10,12,14,16],annot:8,anyth:16,api:[0,2],app:1,append_char:8,append_dataset:1,appli:[1,2,14,18],apt:11,ar:[0,1,2,5,7,10,11,12,16,17,18],arbitrari:5,area:7,arg:[0,1,16],argument:[5,16],around:[7,11],arr:2,arrai:[1,2,5,7,8,16],aspect:15,associ:5,att:16,attempt:18,attribut:[0,16],automat:10,avaiabl:3,avail:[5,7],averag:6,avoid:0,ax:8,b:[7,14,17],b_tran:1,backend:[5,8,10],backend_qtagg:8,bar:14,bar_nam:8,bar_plott:8,base:[0,1,2,5,6,8],base_dataload:2,base_dataset_load:2,basic:15,batch:[5,6],been:2,befor:[14,15],behav:12,behaviour:18,being:[8,18],below:5,benchmark:18,best:[8,11,18],better:7,between:[0,1,5,18],beyond:7,binari:7,binary_threshold:7,black:[1,7,14],blank:14,blueprint:2,blur:[6,7,15],boarder:14,bool:[0,5,6,8],both:[2,18],bound:16,box:10,bright:[7,15,16],brightness_hsv:7,buffer:2,button:[1,17],c:[6,11],cach:2,cache_metric_cal:2,calc_max_comparison:1,calc_rang:1,calcul:[1,2,10,14],calibr:[10,17],calibrate_bright:8,call:[0,2,5,6,14,16],callabl:[2,16],can:[1,10,11,12,14,15,16,17,18],candela:14,capabilit:10,captur:18,care:6,categoris:18,centr:[7,8],chang:[1,8,14,15],change_data:1,change_display_im_display_bright:1,change_display_im_rgb_bright:1,change_display_im_s:1,change_experiment_imag:1,change_graph_s:1,change_human_scores_after_exp:1,change_im:8,change_metric_correlations_graph:1,change_metric_range_graph:1,change_num_step:1,change_plot_lim:1,change_post_process:1,change_pre_process:1,change_save_fold:1,change_text_exp_tran:1,change_to_data_num:1,change_to_solid:1,change_to_specific_tran:1,change_trans_value_sign:8,channel:6,check_pyqt_install_dep:0,checkbox:1,checked_metr:1,checked_transformation_param:1,choos:5,clash:11,click:[1,8,14,17],click_complet:1,click_scatt:8,clickabl:1,clicked_imag:1,clicklabel:1,clip:[7,16],closeev:1,code:[5,8,11],collect:10,colour:1,colour_lineedit:1,com:[5,14,15,16,17],commun:2,comp:15,compar:[10,15,17,18],comparison:[5,10,16],compat:5,complet:1,completed_range_result:1,comprehens:12,compress:7,comput:[6,8,14],compute_metric_for_human_correl:8,compute_metrics_over_rang:8,compute_metrics_over_range_single_tran:8,conda:11,conduct:[10,12],conflict:11,conform:[10,12],connect_func:1,consist:18,constant:6,construct_ui:1,constructor:2,contain:[8,14,17],content:13,context:18,contrast:7,control:5,conveni:10,conver:7,convert:[2,7],convolut:7,copi:14,correct:[0,3,10,17],correl:[8,10,17,18],correspond:[8,14,17],could:11,cover:10,crash:0,creat:[1,6,11,18],crop:[2,8,10,14],crop_centr:8,crope:8,crucial:10,css_file:1,csv:[8,17],cuda:11,current:8,current_imag:1,cursor0:11,custom:[1,10,15,16],custom_bright:16,custom_float_valid:1,custom_mae_class:16,custom_mae_funct:16,custom_widget:[0,13],customis:[12,17],d:6,data:[0,1,2,8,10,12,18],data_api:[0,8,13],data_api_abstract:[0,13],data_handl:[0,13],data_rang:6,data_stor:[0,1,8],dataset:[0,1,8,10,13,16],dataset_hold:2,debug:0,decod:7,decreas:7,deep:[5,18],def:16,default_save_dir:[0,1,8],defin:[6,15,16],degre:7,demonstr:[11,12],depend:11,depth:12,design:10,desir:[10,15],despit:18,detail:[10,12],develop:10,deviat:7,df:8,dict:[0,1,2,5,7,8],dict_:8,dictionari:[2,15,16],differ:[2,6,12],digit:7,dimens:5,dingkeyan93:5,dir:8,directori:14,disable_settings_button:1,disagre:17,disp_len:1,displai:[10,17],display_bright:[1,8],display_imag:1,display_metr:1,display_metric_correlation_plot:1,display_metric_imag:1,display_metric_range_plot:1,display_metrics_graph:1,display_metrics_text:1,display_radar_plot:1,display_slider_num:1,dissimilar:5,dist:[0,5,13],distanc:18,distor:12,distort:[7,10,12,15,16,18],distribut:6,do_work:1,doc:[0,8,14,15,16,17],document:[10,15],doe:11,doesn:0,don:11,down:1,download:11,downsiz:5,dpi:8,drop:1,dummi:16,dummy_arg:16,e:[5,6,11,12,14,16,18],each:[7,8],earli:5,edit_slider_v:1,effect:12,element:1,empir:18,en:5,enabl:10,enable_settings_button:1,encod:7,entri:1,environ:11,error:[5,8,11,16,18],es:5,et:5,etc:[0,17],euclidean:18,ev:1,evalu:[5,10,12,18],event:[1,8],everi:6,everyth:[15,17],exactli:16,exampl:[0,2,5,11,13,15,16,18],expand:16,expect:12,expens:18,experi:[0,1,8,12,13,18],experiment:18,experiment_layout:1,experiment_mod:[0,13],expos:10,extent:1,extra:16,extrem:18,f:15,facilit:[10,12],fail:10,fals:[0,1,5,6,8],featur:[10,12],feel:15,figur:8,figurecanvasqtagg:8,file:[2,3,8,14,15,17],file_path:2,filepath:15,fill:7,finish_experi:1,first:[11,17,18],firstli:12,fix:8,float32:7,folder:[1,14,17],follow:16,forc:6,form:[10,16],former:6,forward:6,frame:8,framework:10,free:15,fresh:11,from:[1,2,5,8,10,11,14,17,18],fucntion:2,further:[10,12],g:[5,6,11,12,14,16],gain:5,gan:5,gather:18,gauss:6,gaussian:7,gaussian_filt:6,gaussian_nois:7,gener:[2,5,10,17],generic_value_chang:1,geometr:5,get:[0,1,5,6,7,8,15],get_all_imag:1,get_all_iqm_param:5,get_all_metr:5,get_all_metric_imag:5,get_all_single_transform_param:8,get_all_slider_valu:8,get_all_transform:7,get_correlation_plot:8,get_float_valid:1,get_human_scores_fil:8,get_human_times_fil:8,get_image_dataset_list:2,get_image_nam:2,get_image_name_from_human_scor:8,get_image_pair_nam:8,get_image_processing_fil:8,get_image_to_transform:2,get_image_to_transform_nam:2,get_iqm_fil:8,get_menu_checkbox:1,get_metr:2,get_metric_imag:2,get_metric_image_nam:8,get_metric_scor:1,get_metrics_over_all_trans_with_init_valu:1,get_original_image_fil:8,get_original_unprocessed_image_fil:8,get_radar_plots_avg_plot:8,get_range_results_work:1,get_reference_imag:2,get_reference_image_nam:2,get_reference_unprocess:2,get_resolut:8,get_single_transform_im:1,get_trans_dict_from_str:8,get_transform_functions_fil:8,get_transform_imag:8,get_transform_params_fil:8,get_transform_range_plot:8,get_transformed_image_nam:8,getter:8,github:[5,12,14,15,16,17],give:[5,17,18],given:[1,5,7,8,18],go:[14,15,17],goal:18,gpu:[10,11],graph:[0,1,8,10,12],graphic:[10,18],greycal:3,grip:15,group:18,gui:10,gui_util:[0,13],h:[6,7],ha:[10,17],half:8,handl:10,handler:0,hardwar:10,hashabl:2,have:[2,5,7,8,11,12,14,16,18],head:11,helper:8,here:[0,16,17],high:1,higher:[1,7],highest:10,hold:8,home:[0,1,8,15,16],hook:6,horizont:7,hover_scatt:8,how:[5,8,12,14,15,17],html:15,http:[1,5,14,15,16,17],hue:7,human:[17,18],human_exp_csv:2,human_scor:8,i:[1,18],ident:7,ignor:6,illustr:12,im:8,im_comp:[5,16],im_ref:[5,16],imag:[0,2,3,5,6,7,8,10,12,13,16,17,18],image1:15,image2:15,image_display_s:1,image_list:[0,1,2,15,16],image_list_to_transform:2,image_load:2,image_nam:1,image_path:8,image_post_process:2,image_postprocess:1,image_pre_process:2,image_preprocess:1,image_util:[0,13],img:[3,8],implement:10,improv:10,includ:[10,14,15,16],increas:7,ind:[1,8],index:[5,8,11,12,18],individu:8,info:1,info_item:1,inform:[15,17],init:[1,15],init_layout:1,init_styl:1,init_valu:[7,15,16],init_widget:1,init_worker_thread:1,initi:8,initialis:[1,16],input:[0,2,6,15,16],input_str:1,inspect:12,instal:0,instanc:[5,6],instead:[6,8,15],interact:18,interfac:[6,10],invari:18,investig:12,io:15,ipynb:[14,15,16,17],iqm:[0,1,2,8,11,13,14,15,16,17],iqm_scores_df:8,iqm_vi:[11,12,14,15,16],is_almost_float:1,is_float:1,item:[8,14],iter:1,its:[0,7,8],itself:18,ival:1,j:1,jpeg:[0,7,15],jpeg_compress:[7,15],jpg:15,just:[8,18],k1:[5,6],k2:[5,6],k:6,keep_siz:8,kei:[1,2,8,16],kernel:[5,6,7,15],kernel_s:7,keyword:5,know:11,kodak:[0,13,16],kodim01:16,kodim02:16,kwarg:[0,1,2,5,16],l1:16,label:[1,8],laparra:5,lapeva:5,laplacian:5,larger:6,later:[15,16],latest:11,latter:6,launch:[14,17],launch_experi:1,layout:[0,13],learn:[5,18],left:1,lend:18,length:8,less:7,let:[15,16],level:6,librari:[0,11],libxcb:11,light:1,like:[11,16,18],lim:8,line_plott:8,linux:0,list1:1,list2:1,list:[0,1,2,6,8,15],literatur:18,littl:15,load:[2,8,11,17],load_all_metr:1,load_all_metric_imag:1,load_all_transform:1,load_and_calibrate_imag:3,load_experiment_from_dir:1,load_human_experi:1,load_imag:[2,8],load_image_list:2,load_json_dict:8,load_new_images_fold:1,load_new_single_imag:1,load_obj:8,loader:2,local:[5,15],longest:8,look:8,loss:[5,18],low:1,lower:1,lpip:5,lumin:[5,10,14,17],mae:[5,15,16],mai:18,main:[0,13,14,15,16,17],main_menu:1,make:[0,8,11,12,17],make_app:1,make_experi:1,make_float_from_text:1,make_kernel_odd:5,make_menu:1,make_name_for_tran:1,make_slider_rang:1,make_status_bar:1,make_ui:[0,11,14,15,16],maker:15,maketh:1,making_the_ui:14,manag:[10,12],mani:10,matplotlib:8,matt:[0,1,8,15,16],mattclifford1:[14,15,16,17],max:[7,8,15,16],max_lumin:3,maximum:14,mean:[5,16,18],measur:[5,14,18],menu:[1,14,17],messag:1,message_on_plot:1,meta_dict:3,meter:14,method:8,metric:[0,1,2,3,8,10,12,13,17,18],metric_imag:[0,1,2,15],metric_param:[0,1,8,16],metric_range_graph:1,metric_scor:8,metrics_avg_graph:[0,1],metrics_info_format:[0,1],metrics_nam:8,metrics_to_us:[2,8],might:[16,17],mild:5,mimic:18,min:[7,8,15,16],miss:11,model:18,modul:[12,13],more:[10,15],most:17,mousepressev:1,mplcanva:8,ms:6,ms_ssim:[5,6],mse:[5,15],mse_imag:15,mssim_kernel_s:5,much:18,multi:5,multipl:[0,13],must:5,mutabl:2,n:[6,11,14,17],name:[1,2,7,8],nan:6,navig:14,necessari:18,need:[0,1,2,6,8,14,15,16,17],neg:6,net:1,network:5,new_api:[0,13],newer:11,nlpd:5,nlpd_k:5,nn:6,nois:[5,7],noise_ratio:5,non:[8,15],none:[0,1,2,6,8],nonneg:6,nonnegative_ssim:6,normal:[6,7,8,15],normalis:[5,15],note:[5,8,16],notebook:[14,15,16,17],now:[11,15,16],np:[5,7,8,16],num_imag:1,num_step:[1,8],num_step_experi:1,num_steps_rang:[0,1],number:[7,14],numpi:[2,8,10,16],nvidia:11,object:[0,1,2,5,8,16,18],observ:18,obtain:18,odd:[7,15],off:16,offer:12,often:18,onc:17,one:6,one_over_psnr:5,onli:[7,8,14,15,17],opencv:10,oper:[5,15,18],option:[1,2,6,10,15,17],order:[1,10,17],ordin:10,org:5,origin:8,other:[8,10],our:[12,16],out:[7,8,10],over:[5,8,11,14,15],overridden:6,overse:18,own:[15,16,17],packag:[11,12,13,15,16],packg:14,pair:[5,10],pairwis:17,paper:[5,12],param1:16,param:[1,6,16],param_group:1,paramet:[2,5,7,8,12,14,16,18],paramt:[8,14],parent:1,particip:[10,17],particular:10,partit:1,pass:[6,15,16],past:14,patch:5,path:[1,2,8,15],paus:1,pbar_sign:8,pdf:5,peak:5,peak_sign:5,peel:16,peic:15,pepper:7,per:14,perceiv:[10,18],percentag:[7,8],percept:18,perceptu:[5,18],perform:[6,12,18],pick:10,pickl:8,pickle_path:8,pip:11,pivot:1,pixel:[5,7],pkl:8,place:14,platform:11,plethora:18,plot:[1,8,10,17],plot_radar_graph:1,plot_util:[0,13],plu:8,plugin:11,png:16,point:[1,5,8,11,17],polar:8,post:8,practition:[10,12,18],pre:10,premis:18,presenc:18,press:[1,17],pretrain:5,previou:17,principl:18,print:15,prob:7,probabl:7,problem:11,procedur:12,process:[8,10,15,18],produc:[14,18],profil:18,progress:1,progressbar:1,project:[0,14,15],properti:[0,2,10,12],proport:7,propos:5,provid:[5,10,12,14,15],psnr:5,psychophys:18,purpos:1,put:16,pypi:11,pyqt6:[0,1,8,10],pyqt:1,pyramid:5,python:[10,11,14],pythontutori:1,pytorch:[5,10,11],qcloseev:1,qlabel:1,qmainwindow:1,qmouseev:1,qobject:1,qprogressbar:1,qt:11,qtcore:1,qtgui:1,qthread:1,qtwidget:1,qualit:[15,18],qualiti:[5,7,10,12,15,18],quantit:18,quick:[10,17],quick_sort:1,quit:1,qvalid:1,radar:8,radar_nam:8,radar_plott:8,ranc:8,rang:[1,6,7,8,14,15,16,18],rate:18,ratio:5,read:[12,17],readi:17,real:10,recent:18,recip:6,recommend:[7,11,14],recreat:18,recurs:10,redo_plot:1,reduc:5,reduct:5,ref:2,refer:[2,5,8,10,16,18],regist:6,reinstal:11,relev:11,relu:6,remain:18,repons:12,request_range_work:1,requir:[0,1,11,14,15,17,18],reset_clicked_imag:1,reset_correlation_data:1,reset_experi:1,reset_image_widget_to_black:1,reset_slid:1,reset_slider_group:1,resiz:[8,10],resize_imag:8,resize_to_longest_sid:8,respect:[10,18],respons:[6,18],restrict_opt:[0,1],result:[1,6,8,10,12],results_ord:8,return_dict:8,return_imag:[5,15],reult:8,rgb:8,rgb_bright:[1,8],right:1,robust:5,rotat:[2,7,10,14,15],round:12,run:[3,6,10,11,12,14],running_an_experi:17,s:[15,16,18],salt:7,salt_and_pepper_nois:7,same:[2,5,16,18],sampl:[5,7],sat:7,satur:7,save:[1,8,14,17],save_and_merge_df_as_csv:8,save_df_as_csv:8,save_dir:8,save_experi:1,save_experiment_result:8,save_imag:8,save_json_dict:8,save_obj:8,save_util:[0,13],saved_experi:1,scalar:[5,6,15],scale:5,scale_factor:[7,8],scatter:8,scatter_plott:8,scenario:[12,18],score:[1,5,10,16,17],scratch:11,screen:[10,14],script:14,second:18,secondli:12,see:[10,12,15,17],select:[10,12,14,17],self:[0,1,2,16],send:8,sent:1,serv:18,set:[1,12,17],set_checked_menu_from_iter:1,set_image_name_text:1,set_plot_lim:8,set_styl:8,setup:[1,17],setup_experi:1,shape:16,shift:7,ship:0,should:[6,11],show:[0,8,10,16,17],show_all_imag:1,shown:[16,17],side:8,sigma:[5,6],signal:[1,5,8],silent:6,similar:[5,15,17,18],simpl:[0,10,12,13],simpler:8,simplest:18,sinc:[2,6,15],singl:[8,16],single_trans_dict:1,size:[3,5,6,7,8,10,17],size_averag:6,skimag:7,skip:11,sliders_dict:1,small:[5,8],smaller:14,smoother:1,so:[0,1,8,10,11],softwar:[12,18],solv:11,some:[11,14,15],sort:[10,17],sort_list:1,sourc:[0,1,2,3,5,6,7,8],space:18,spacial:[12,15],spatial_dim:6,specif:[10,18],specifi:[8,15],spider:8,squar:[5,7,8,14,16,18],squeez:5,ssim:[0,5,12,15,18],ssim_imag:15,ssim_kernel_s:5,stanard:10,standard:[7,10],start:[7,15,16,17],start_experi:1,state:1,std:7,step:11,still:16,stop:1,stop_flag:8,stopped_range_work:1,storag:10,store:[2,15,16],str:[0,1,5],str_to_len:8,straightforward:10,strictli:5,string:8,structur:[5,18],style:1,subclass:[1,6],submodul:13,subpackag:13,subtract:5,sudo:11,sum:5,sure:[0,11,12,16,17],swap_ind:1,system:5,t:[0,6,11],tab:[1,14],take:[5,6,10,14,16,17],task:10,tell:16,tensor:6,test:[0,1,12],test_datastore_attribut:0,text:[1,8],textur:5,than:[1,7],theh:14,thei:[0,2,16,17,18],them:[0,6,15,16],thi:[2,6,8,10,11,14,15,16,17,18],thing:17,thread:[0,13],threshold:7,through:[10,12,14,15,17],time:1,times_taken:8,timescal:10,todo:[0,8],toggle_experi:1,too:18,toolbox:12,torch:6,torchaudio:11,torchvis:11,tradit:18,train:6,tran:[1,2,8],trans_nam:8,trans_str:[1,8],trans_str_valu:8,transform:[0,1,2,3,5,8,10,12,13,17],transform_funct:8,transform_param:8,transform_valu:8,transform_wrapp:0,transformation_nam:8,transformed_imag:2,translat:[7,10],tree:[14,15,16,17],truthfulli:10,tupl:6,tutori:10,tutorial_1:14,tutorial_2:15,tutorial_3:16,tutorial_4:17,two:[5,12,15,18],txt:1,type:[5,6,7,8],ubuntu:11,ubyt:8,ui:[0,2,5,8,12,13,15,17],ui_wrapp:13,unchang:18,under:12,underli:10,understand:[10,12],undistort:10,union:6,unsort:1,until:17,up:[1,12],update_annot:8,update_datastore_image_list:1,update_image_set:1,update_progress:1,update_status_bar:1,us:[1,2,5,7,8,10,11,12,14,15,16,17],usag:0,user:[0,7,10,12,17],usual:6,util:[0,2,13],utilis:18,uv:5,v:1,valero:5,valid:1,valu:[2,5,6,7,8,14,15,16],var_nam:8,var_valu:8,varianc:5,variou:12,version:[11,13],vertic:7,vgg:5,vi:[0,1,2,8,11,14,15,16,17,18],via:2,video:12,view:[10,12,14,15,16,17],view_correlation_inst:1,virtual:11,visibl:18,visit:12,visual:[5,12],visualis:[10,12],w:6,wa:8,wai:12,want:[15,17],warn:0,waves1:[0,15],waves2:[0,15],waves3:0,we:[0,1,2,11,14,15,16,17,18],websit:11,weight:6,well:[10,11,12],what:[0,16],when:[1,5,8,14,15,17],where:18,whether:5,which:[2,5,8,10,11,12,18],whole:[8,14,15,16,17],why:18,widget:[0,8,13],widget_ax:1,widget_nam:1,wiki:5,wikipedia:5,win:6,win_sigma:6,win_siz:6,window:[1,6],within:[6,14,16],without:12,word:16,work:11,worker:1,world:10,would:[11,14],wrap:0,write:[0,8,12],www:[1,5],x:[6,8],x_label:8,x_shift:7,y:[6,8,11],y_label:8,y_shift:7,you:[6,11,12,14,15,16,17],your:[15,17],zero:15,zoom:[7,8],zoom_imag:7},titles:["IQM_Vis package","IQM_Vis.UI package","IQM_Vis.data_handlers package","IQM_Vis.examples package","IQM_Vis.examples.images package","IQM_Vis.metrics package","IQM_Vis.metrics.SSIM package","IQM_Vis.transformations package","IQM_Vis.utils package","Tutorials","About IQM-Vis","Getting Started","IQM-Vis documentation","IQM_Vis","Tutorial 1: Making the UI","Tutorial 2: Simple Customisation","Tutorial 3: Customisation Details","Tutorial 4: Running an Experiment","IQMs"],titleterms:{"1":14,"2":15,"3":16,"4":17,"function":10,For:18,about:[10,12],ad:14,all:[3,15],an:[12,17,18],analysi:12,bright:14,built:10,choos:18,code:12,common:11,content:[0,1,2,3,4,5,6,7,8],correl:12,custom_widget:1,customis:[15,16],data_api:2,data_api_abstract:2,data_handl:2,dataset:3,detail:16,differ:18,dispali:14,displai:14,dist:3,document:12,exampl:[3,4],experi:[3,10,14,17],experiment_mod:1,finsih:17,get:[11,12],graph:14,gui_util:8,how:18,human:[10,12],imag:[1,4,14,15],image_util:8,indic:12,info:17,instal:11,iqm:[5,10,12,18],iqm_vi:[0,1,2,3,4,5,6,7,8,13],issu:11,kodak:3,layout:1,load:14,main:1,make:[14,16],max:14,metric:[5,6,14,15,16],modul:[0,1,2,3,4,5,6,7,8],multipl:3,new_api:3,offer:10,other:14,own:14,packag:[0,1,2,3,4,5,6,7,8],percept:[10,12],plot_util:8,post:14,pre:14,process:14,put:15,qualit:12,quantit:12,result:17,rgb:14,run:17,save_util:8,screen:17,set:14,simpl:[3,15],size:14,softwar:10,sourc:12,ssim:6,start:[11,12],step:14,submodul:[0,1,2,3,5,6,7,8],subpackag:[0,3,5],tabl:12,task:18,test:11,thread:1,togeth:15,transform:[7,14,15,16],tutori:[9,12,14,15,16,17],type:18,ui:[1,14,16],ui_wrapp:0,util:[1,8],version:0,vi:[10,12],visualis:17,what:[10,12,18],widget:1,your:[14,18]}})
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index 7576d6f..491a5dc 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,7 +9,7 @@ IQM-Vis is an image quality metric visualisation toolbox to facilitate visualisi
 View our demonstration `video `_ which illustrates the features and how to use IQM-Vis.
 
 
-Read our `PAPER `_ for in depth details of the software.
+Read our `PAPER `_ for in depth details of the software.
 
 Quantitive Analysis
 ===================
diff --git a/Software_paper.pdf b/docs/resources/Software_paper.pdf
similarity index 100%
rename from Software_paper.pdf
rename to docs/resources/Software_paper.pdf