deploy: a9c7500

NPACore · Nov 24, 2024 · 46a06d3 · 46a06d3
commit 46a06d3
Show file tree

Hide file tree

Showing 45 changed files with 5,692 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: a0fcf460302088f3b558fee9146ad410
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/_autosummary/acq2sqlite.doctree b/.doctrees/_autosummary/acq2sqlite.doctree
diff --git a/.doctrees/_autosummary/change_header.doctree b/.doctrees/_autosummary/change_header.doctree
diff --git a/.doctrees/_autosummary/compliance_check_html.doctree b/.doctrees/_autosummary/compliance_check_html.doctree
diff --git a/.doctrees/_autosummary/dcmmeta2tsv.doctree b/.doctrees/_autosummary/dcmmeta2tsv.doctree
diff --git a/.doctrees/_autosummary/mrqart.doctree b/.doctrees/_autosummary/mrqart.doctree
diff --git a/.doctrees/_autosummary/template_checker.doctree b/.doctrees/_autosummary/template_checker.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_autosummary/acq2sqlite.html b/_autosummary/acq2sqlite.html
diff --git a/_autosummary/change_header.html b/_autosummary/change_header.html
diff --git a/_autosummary/compliance_check_html.html b/_autosummary/compliance_check_html.html
@@ -0,0 +1,162 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>compliance_check_html &#8212; mrrc-hdr-qa  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="prev" title="template_checker" href="template_checker.html" />
+
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <section id="module-compliance_check_html">
+<span id="compliance-check-html"></span><h1>compliance_check_html<a class="headerlink" href="#module-compliance_check_html" title="Link to this heading">¶</a></h1>
+<p class="rubric">Functions</p>
+<table class="autosummary longtable docutils align-default">
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="#compliance_check_html.generate_html_report" title="compliance_check_html.generate_html_report"><code class="xref py py-obj docutils literal notranslate"><span class="pre">generate_html_report</span></code></a>(check_result, template_path)</p></td>
+<td><p>Generate an HTML report of DICOM header comparison, highlighting mismatches.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="#compliance_check_html.load_template" title="compliance_check_html.load_template"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_template</span></code></a>(template_path)</p></td>
+<td><p>Load an HTML template from the template.html file</p></td>
+</tr>
+</tbody>
+</table>
+<dl class="py function">
+<dt class="sig sig-object py" id="compliance_check_html.generate_html_report">
+<span class="sig-prename descclassname"><span class="pre">compliance_check_html.</span></span><span class="sig-name descname"><span class="pre">generate_html_report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">check_result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template_path</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NPACore/mrrc-hdr-qa/blob/main/compliance_check_html.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#compliance_check_html.generate_html_report" title="Link to this definition">¶</a></dt>
+<dd><p>Generate an HTML report of DICOM header comparison, highlighting mismatches.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>check_result</strong> (<a class="reference internal" href="template_checker.html#template_checker.CheckResult" title="template_checker.CheckResult"><em>CheckResult</em></a>) – Output from the check_header function, containing the comparison results.</p></li>
+<li><p><strong>template_path</strong> (<em>str</em>)</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>HTML string with results formatted using a Jinja2 template.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="compliance_check_html.load_template">
+<span class="sig-prename descclassname"><span class="pre">compliance_check_html.</span></span><span class="sig-name descname"><span class="pre">load_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_path</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NPACore/mrrc-hdr-qa/blob/main/compliance_check_html.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#compliance_check_html.load_template" title="Link to this definition">¶</a></dt>
+<dd><p>Load an HTML template from the template.html file</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>template_path</strong> (<em>str</em>) – Path to the HTML template file.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A Jinja2 Template object.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><em>Template</em></p>
+</dd>
+</dl>
+</dd></dl>
+
+</section>
+
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">mrrc-hdr-qa</a></h1>
+
+
+
+
+
+
+
+
+
+<search id="searchbox" style="display: none" role="search">
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="mrqart.html">mrqart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="dcmmeta2tsv.html">dcmmeta2tsv</a></li>
+<li class="toctree-l1"><a class="reference internal" href="acq2sqlite.html">acq2sqlite</a></li>
+<li class="toctree-l1"><a class="reference internal" href="change_header.html">change_header</a></li>
+<li class="toctree-l1"><a class="reference internal" href="template_checker.html">template_checker</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">compliance_check_html</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#compliance_check_html.generate_html_report"><code class="docutils literal notranslate"><span class="pre">generate_html_report()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#compliance_check_html.load_template"><code class="docutils literal notranslate"><span class="pre">load_template()</span></code></a></li>
+</ul>
+</li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+      <li>Previous: <a href="template_checker.html" title="previous chapter">template_checker</a></li>
+  </ul></li>
+</ul>
+</div>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2024, EH, WF.
+
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
+
+      |
+      <a href="../_sources/_autosummary/compliance_check_html.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+
+
+
+  </body>
+</html>