--- a +++ b/docs/_build/html/index.html @@ -0,0 +1,143 @@ + +<!DOCTYPE html> + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta charset="utf-8" /> + <title>WSITools documentation! — WSITools 0.1 documentation</title> + <link rel="stylesheet" href="_static/classic.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + + <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <script type="text/javascript" src="_static/language_data.js"></script> + + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="Getting started" href="getting-started.html" /> + </head><body> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="getting-started.html" title="Getting started" + accesskey="N">next</a> |</li> + <li class="nav-item nav-item-0"><a href="#">WSITools 0.1 documentation</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <div class="section" id="wsitools-documentation"> +<h1>WSITools documentation!<a class="headerlink" href="#wsitools-documentation" title="Permalink to this headline">¶</a></h1> +<p>Tools to aid Digital pathology deep learning projects</p> +<ul class="simple"> +<li><p>Free software: MIT license</p></li> +<li><p>Documentation: <a class="reference external" href="https://wsitools.readthedocs.io/en/latest/index.html">https://wsitools.readthedocs.io/en/latest/index.html</a></p></li> +</ul> +<div class="section" id="features"> +<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2> +<p>WSITools is a whole slide image processing toolkit. It provides efficient ways to extract patches from whole slide +images, and some other useful features for pathological image processing. +Currently, it supports four patch extraction scenarios: +.. 1. Extract patches from WSIs +.. 2. Extract patches from WSIs and their label (i.e. their directory name) +.. 1. TODO: Incomplete +.. 3. Extract patches from a fixed and a float WSI +.. 4. Extract patches from a fixed and a float WSI in places that intersect annotation objects +.. 1. TODO: Incomplete</p> +</div> +<div class="section" id="additional-features"> +<h2>Additional Features<a class="headerlink" href="#additional-features" title="Permalink to this headline">¶</a></h2> +<p>Contents:</p> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a><ul> +<li class="toctree-l2"><a class="reference internal" href="getting-started.html#quick-start">Quick Start</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="example-commands.html">Example Commands</a></li> +<li class="toctree-l1"><a class="reference internal" href="Tissue-Detection.html">Tissue Detection</a></li> +<li class="toctree-l1"><a class="reference internal" href="Patch-Extraction.html">Patch Extraction</a></li> +<li class="toctree-l1"><a class="reference internal" href="Patch-Extraction-with-Registration.html">Patch Extraction with Image Registration</a></li> +<li class="toctree-l1"><a class="reference internal" href="Patch-Extraction-with-Annotation.html">Patch extraction with Annotations</a></li> +<li class="toctree-l1"><a class="reference internal" href="Patch-Extraction-with-Registration-and-Annotation.html">Patch Extraction with Registration & Annotations</a></li> +</ul> +</div> +</div> +</div> +<div class="section" id="indices-and-tables"> +<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1> +<ul class="simple"> +<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> +<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li> +<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> +</ul> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> + <h3><a href="#">Table of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">WSITools documentation!</a><ul> +<li><a class="reference internal" href="#features">Features</a></li> +<li><a class="reference internal" href="#additional-features">Additional Features</a></li> +</ul> +</li> +<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li> +</ul> + + <h4>Next topic</h4> + <p class="topless"><a href="getting-started.html" + title="next chapter">Getting started</a></p> + <div role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="_sources/index.rst.txt" + rel="nofollow">Show Source</a></li> + </ul> + </div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + >index</a></li> + <li class="right" > + <a href="getting-started.html" title="Getting started" + >next</a> |</li> + <li class="nav-item nav-item-0"><a href="#">WSITools 0.1 documentation</a> »</li> + </ul> + </div> + <div class="footer" role="contentinfo"> + © Copyright . + Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1. + </div> + </body> +</html> \ No newline at end of file