Added documentation.

oncoray · Oct 27, 2023 · 70e1706 · 70e1706
1 parent 429c337
commit 70e1706
Show file tree

Hide file tree

Showing 70 changed files with 14,702 additions and 0 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 9c9bf8ce1e6064b92ac7bf61594b8542
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -0,0 +1,119 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; mirp 2.0.0 documentation</title>
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../_static/documentation_options.js?v=51b770b3"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            mirp
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../mirp.importData.html">Configure image and mask import</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../mirp.settings.html">Configure the image processing and feature extraction workflow</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../mirp.extractImageParameters.html">Extract image metadata</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../mirp.extractMaskLabels.html">Extract mask labels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../mirp.deepLearningPreprocessing.html">Preprocess images for deep learning</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../mirp.extractFeaturesAndImages.html">Process image and compute quantitative image features</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">mirp</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="mirp/deepLearningPreprocessing.html">mirp.deepLearningPreprocessing</a></li>
+<li><a href="mirp/extractFeaturesAndImages.html">mirp.extractFeaturesAndImages</a></li>
+<li><a href="mirp/extractImageParameters.html">mirp.extractImageParameters</a></li>
+<li><a href="mirp/extractMaskLabels.html">mirp.extractMaskLabels</a></li>
+<li><a href="mirp/importData/importImageAndMask.html">mirp.importData.importImageAndMask</a></li>
+<li><a href="mirp/settings/settingsFeatureExtraction.html">mirp.settings.settingsFeatureExtraction</a></li>
+<li><a href="mirp/settings/settingsGeneral.html">mirp.settings.settingsGeneral</a></li>
+<li><a href="mirp/settings/settingsGeneric.html">mirp.settings.settingsGeneric</a></li>
+<li><a href="mirp/settings/settingsImageProcessing.html">mirp.settings.settingsImageProcessing</a></li>
+<li><a href="mirp/settings/settingsImageTransformation.html">mirp.settings.settingsImageTransformation</a></li>
+<li><a href="mirp/settings/settingsInterpolation.html">mirp.settings.settingsInterpolation</a></li>
+<li><a href="mirp/settings/settingsMaskResegmentation.html">mirp.settings.settingsMaskResegmentation</a></li>
+<li><a href="mirp/settings/settingsPerturbation.html">mirp.settings.settingsPerturbation</a></li>
+<li><a href="mirp/utilities/config_utilities.html">mirp.utilities.config_utilities</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2023, Alex Zwanenburg.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>