paper update

mattclifford1 · Apr 15, 2024 · ca8ba4a · ca8ba4a
1 parent 5b46965
commit ca8ba4a
Show file tree

Hide file tree

Showing 17 changed files with 45 additions and 10 deletions.
diff --git a/Software_Impacts_IQM_Vis.pdf b/Software_Impacts_IQM_Vis.pdf
diff --git a/Software_paper.pdf b/Software_paper.pdf
diff --git a/docs/IQM_Vis.rst b/docs/IQM_Vis.rst
@@ -25,6 +25,14 @@ IQM\_Vis.ui\_wrapper module
    :undoc-members:
    :show-inheritance:
 
+IQM\_Vis.version module
+-----------------------
+
+.. automodule:: IQM_Vis.version
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

diff --git a/docs/_build/doctrees/IQM_Vis.doctree b/docs/_build/doctrees/IQM_Vis.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/IQM_Vis.html b/docs/_build/html/IQM_Vis.html
@@ -207,6 +207,9 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 </dd></dl>
 
+</section>
+<section id="module-IQM_Vis.version">
+<span id="iqm-vis-version-module"></span><h2>IQM_Vis.version module<a class="headerlink" href="#module-IQM_Vis.version" title="Permalink to this headline"></a></h2>
 </section>
 <section id="module-IQM_Vis">
 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-IQM_Vis" title="Permalink to this headline"></a></h2>

diff --git a/docs/_build/html/_modules/IQM_Vis/UI/main.html b/docs/_build/html/_modules/IQM_Vis/UI/main.html
@@ -178,16 +178,17 @@ <h1>Source code for IQM_Vis.UI.main</h1><div class="highlight"><pre>
         <span class="n">quit_action</span><span class="o">.</span><span class="n">setStatusTip</span><span class="p">(</span><span class="s1">&#39;Exit application&#39;</span><span class="p">)</span>
         <span class="n">quit_action</span><span class="o">.</span><span class="n">triggered</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">quit</span><span class="p">)</span>
 
-        <span class="bp">self</span><span class="o">.</span><span class="n">edit_menu</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">menu_bar</span><span class="o">.</span><span class="n">addMenu</span><span class="p">(</span><span class="s1">&#39;Edit&#39;</span><span class="p">)</span>
-        <span class="n">load_transforms</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">edit_menu</span><span class="o">.</span><span class="n">addAction</span><span class="p">(</span><span class="s1">&#39;Load All Transforms&#39;</span><span class="p">)</span>
-        <span class="n">load_metrics</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">edit_menu</span><span class="o">.</span><span class="n">addAction</span><span class="p">(</span><span class="s1">&#39;Load All Metrics&#39;</span><span class="p">)</span>
-        <span class="n">load_metric_images</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">edit_menu</span><span class="o">.</span><span class="n">addAction</span><span class="p">(</span><span class="s1">&#39;Load All Metric Images&#39;</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">get_menu_checkboxes</span><span class="p">()</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">edit_menu</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">menu_bar</span><span class="o">.</span><span class="n">addMenu</span><span class="p">(</span><span class="s1">&#39;Load&#39;</span><span class="p">)</span>
+        <span class="n">load_transforms</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">edit_menu</span><span class="o">.</span><span class="n">addAction</span><span class="p">(</span><span class="s1">&#39;All Transforms&#39;</span><span class="p">)</span>
+        <span class="n">load_metrics</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">edit_menu</span><span class="o">.</span><span class="n">addAction</span><span class="p">(</span><span class="s1">&#39;All Metrics&#39;</span><span class="p">)</span>
+        <span class="n">load_metric_images</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">edit_menu</span><span class="o">.</span><span class="n">addAction</span><span class="p">(</span><span class="s1">&#39;All Metric Images&#39;</span><span class="p">)</span>
 
         <span class="n">load_transforms</span><span class="o">.</span><span class="n">triggered</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">load_all_transforms</span><span class="p">)</span>
         <span class="n">load_metrics</span><span class="o">.</span><span class="n">triggered</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">load_all_metrics</span><span class="p">)</span>
-        <span class="n">load_metric_images</span><span class="o">.</span><span class="n">triggered</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">load_all_metric_images</span><span class="p">)</span>
+        <span class="n">load_metric_images</span><span class="o">.</span><span class="n">triggered</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">load_all_metric_images</span><span class="p">)</span></div>
 
-        <span class="bp">self</span><span class="o">.</span><span class="n">get_menu_checkboxes</span><span class="p">()</span></div>
 
 <div class="viewcode-block" id="make_app.load_all_transforms"><a class="viewcode-back" href="../../../IQM_Vis.UI.html#IQM_Vis.UI.main.make_app.load_all_transforms">[docs]</a>    <span class="k">def</span> <span class="nf">load_all_transforms</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="n">all_trans_iqm_vis</span> <span class="o">=</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">transformations</span><span class="o">.</span><span class="n">get_all_transforms</span><span class="p">()</span>

diff --git a/docs/_build/html/_sources/IQM_Vis.rst.txt b/docs/_build/html/_sources/IQM_Vis.rst.txt
@@ -25,6 +25,14 @@ IQM\_Vis.ui\_wrapper module
    :undoc-members:
    :show-inheritance:
 
+IQM\_Vis.version module
+-----------------------
+
+.. automodule:: IQM_Vis.version
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

diff --git 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 <https://youtu.be/C6x_E0JvKqI>`_ which illustrates the features and how to use IQM-Vis.
 
 
-Read our `PAPER <https://github.com/mattclifford1/IQM-Vis/blob/main/Software_Impacts_IQM_Vis.pdf>`_ for in depth details of the software.
+Read our `PAPER <https://github.com/mattclifford1/IQM-Vis/blob/main/Software_paper.pdf>`_ for in depth details of the software.
 
 Quantitive Analysis
 ===================

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -734,6 +734,13 @@ <h2 id="I">I</h2>
 
       <ul>
         <li><a href="IQM_Vis.utils.html#module-IQM_Vis.utils.save_utils">module</a>
+</li>
+      </ul></li>
+      <li>
+    IQM_Vis.version
+
+      <ul>
+        <li><a href="IQM_Vis.html#module-IQM_Vis.version">module</a>
 </li>
       </ul></li>
       <li><a href="IQM_Vis.UI.html#IQM_Vis.UI.widgets.is_almost_float">is_almost_float() (in module IQM_Vis.UI.widgets)</a>
@@ -893,6 +900,8 @@ <h2 id="M">M</h2>
         <li><a href="IQM_Vis.utils.html#module-IQM_Vis.utils.plot_utils">IQM_Vis.utils.plot_utils</a>
 </li>
         <li><a href="IQM_Vis.utils.html#module-IQM_Vis.utils.save_utils">IQM_Vis.utils.save_utils</a>
+</li>
+        <li><a href="IQM_Vis.html#module-IQM_Vis.version">IQM_Vis.version</a>
 </li>
       </ul></li>
   </ul></td>

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -89,7 +89,7 @@
 <h1>IQM-Vis documentation<a class="headerlink" href="#iqm-vis-documentation" title="Permalink to this headline"></a></h1>
 <p>IQM-Vis is an image quality metric visualisation toolbox to facilitate visualising and evaluating image quality metrics (IQMs).
 View our demonstration <a class="reference external" href="https://youtu.be/C6x_E0JvKqI">video</a> which illustrates the features and how to use IQM-Vis.</p>
-<p>Read our <a class="reference external" href="https://github.com/mattclifford1/IQM-Vis/blob/main/Software_Impacts_IQM_Vis.pdf">PAPER</a> for in depth details of the software.</p>
+<p>Read our <a class="reference external" href="https://github.com/mattclifford1/IQM-Vis/blob/main/Software_paper.pdf">PAPER</a> for in depth details of the software.</p>
 <section id="quantitive-analysis">
 <h2>Quantitive Analysis<a class="headerlink" href="#quantitive-analysis" title="Permalink to this headline"></a></h2>
 <p>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.</p>

diff --git a/docs/_build/html/modules.html b/docs/_build/html/modules.html
@@ -150,6 +150,7 @@ <h1>IQM_Vis<a class="headerlink" href="#iqm-vis" title="Permalink to this headli
 </li>
 <li class="toctree-l2"><a class="reference internal" href="IQM_Vis.html#submodules">Submodules</a></li>
 <li class="toctree-l2"><a class="reference internal" href="IQM_Vis.html#module-IQM_Vis.ui_wrapper">IQM_Vis.ui_wrapper module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.html#module-IQM_Vis.version">IQM_Vis.version module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="IQM_Vis.html#module-IQM_Vis">Module contents</a></li>
 </ul>
 </li>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html
@@ -272,6 +272,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="IQM_Vis.utils.html#module-IQM_Vis.utils.save_utils"><code class="xref">IQM_Vis.utils.save_utils</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="IQM_Vis.html#module-IQM_Vis.version"><code class="xref">IQM_Vis.version</code></a></td><td>
+       <em></em></td></tr>
    </table>
 
 

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git 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 <https://youtu.be/C6x_E0JvKqI>`_ which illustrates the features and how to use IQM-Vis.
 
 
-Read our `PAPER <https://github.com/mattclifford1/IQM-Vis/blob/main/Software_Impacts_IQM_Vis.pdf>`_ for in depth details of the software.
+Read our `PAPER <https://github.com/mattclifford1/IQM-Vis/blob/main/Software_paper.pdf>`_ for in depth details of the software.
 
 Quantitive Analysis
 ===================