a b/docs/_build/html/index.html
1
2
<!DOCTYPE html>
3
4
<html xmlns="http://www.w3.org/1999/xhtml">
5
  <head>
6
    <meta charset="utf-8" />
7
    <title>WSITools documentation! &#8212; WSITools 0.1 documentation</title>
8
    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
9
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
10
    
11
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
12
    <script type="text/javascript" src="_static/jquery.js"></script>
13
    <script type="text/javascript" src="_static/underscore.js"></script>
14
    <script type="text/javascript" src="_static/doctools.js"></script>
15
    <script type="text/javascript" src="_static/language_data.js"></script>
16
    
17
    <link rel="index" title="Index" href="genindex.html" />
18
    <link rel="search" title="Search" href="search.html" />
19
    <link rel="next" title="Getting started" href="getting-started.html" /> 
20
  </head><body>
21
    <div class="related" role="navigation" aria-label="related navigation">
22
      <h3>Navigation</h3>
23
      <ul>
24
        <li class="right" style="margin-right: 10px">
25
          <a href="genindex.html" title="General Index"
26
             accesskey="I">index</a></li>
27
        <li class="right" >
28
          <a href="getting-started.html" title="Getting started"
29
             accesskey="N">next</a> |</li>
30
        <li class="nav-item nav-item-0"><a href="#">WSITools 0.1 documentation</a> &#187;</li> 
31
      </ul>
32
    </div>  
33
34
    <div class="document">
35
      <div class="documentwrapper">
36
        <div class="bodywrapper">
37
          <div class="body" role="main">
38
            
39
  <div class="section" id="wsitools-documentation">
40
<h1>WSITools documentation!<a class="headerlink" href="#wsitools-documentation" title="Permalink to this headline">¶</a></h1>
41
<p>Tools to aid Digital pathology deep learning projects</p>
42
<ul class="simple">
43
<li><p>Free software: MIT license</p></li>
44
<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>
45
</ul>
46
<div class="section" id="features">
47
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
48
<p>WSITools is a whole slide image processing toolkit. It provides efficient ways to extract patches from whole slide
49
images, and some other useful features for pathological image processing.
50
Currently, it supports four patch extraction scenarios:
51
..  1. Extract patches from WSIs
52
..  2. Extract patches from WSIs and their label (i.e. their directory name)
53
..   1. TODO: Incomplete
54
..  3. Extract patches from a fixed and a float WSI
55
..  4. Extract patches from a fixed and a float WSI in places that intersect annotation objects
56
..   1. TODO: Incomplete</p>
57
</div>
58
<div class="section" id="additional-features">
59
<h2>Additional Features<a class="headerlink" href="#additional-features" title="Permalink to this headline">¶</a></h2>
60
<p>Contents:</p>
61
<div class="toctree-wrapper compound">
62
<ul>
63
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a><ul>
64
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#quick-start">Quick Start</a></li>
65
</ul>
66
</li>
67
<li class="toctree-l1"><a class="reference internal" href="example-commands.html">Example Commands</a></li>
68
<li class="toctree-l1"><a class="reference internal" href="Tissue-Detection.html">Tissue Detection</a></li>
69
<li class="toctree-l1"><a class="reference internal" href="Patch-Extraction.html">Patch Extraction</a></li>
70
<li class="toctree-l1"><a class="reference internal" href="Patch-Extraction-with-Registration.html">Patch Extraction with Image Registration</a></li>
71
<li class="toctree-l1"><a class="reference internal" href="Patch-Extraction-with-Annotation.html">Patch extraction with Annotations</a></li>
72
<li class="toctree-l1"><a class="reference internal" href="Patch-Extraction-with-Registration-and-Annotation.html">Patch Extraction with Registration &amp; Annotations</a></li>
73
</ul>
74
</div>
75
</div>
76
</div>
77
<div class="section" id="indices-and-tables">
78
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
79
<ul class="simple">
80
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
81
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
82
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
83
</ul>
84
</div>
85
86
87
          </div>
88
        </div>
89
      </div>
90
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
91
        <div class="sphinxsidebarwrapper">
92
  <h3><a href="#">Table of Contents</a></h3>
93
  <ul>
94
<li><a class="reference internal" href="#">WSITools documentation!</a><ul>
95
<li><a class="reference internal" href="#features">Features</a></li>
96
<li><a class="reference internal" href="#additional-features">Additional Features</a></li>
97
</ul>
98
</li>
99
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
100
</ul>
101
102
  <h4>Next topic</h4>
103
  <p class="topless"><a href="getting-started.html"
104
                        title="next chapter">Getting started</a></p>
105
  <div role="note" aria-label="source link">
106
    <h3>This Page</h3>
107
    <ul class="this-page-menu">
108
      <li><a href="_sources/index.rst.txt"
109
            rel="nofollow">Show Source</a></li>
110
    </ul>
111
   </div>
112
<div id="searchbox" style="display: none" role="search">
113
  <h3 id="searchlabel">Quick search</h3>
114
    <div class="searchformwrapper">
115
    <form class="search" action="search.html" method="get">
116
      <input type="text" name="q" aria-labelledby="searchlabel" />
117
      <input type="submit" value="Go" />
118
    </form>
119
    </div>
120
</div>
121
<script type="text/javascript">$('#searchbox').show(0);</script>
122
        </div>
123
      </div>
124
      <div class="clearer"></div>
125
    </div>
126
    <div class="related" role="navigation" aria-label="related navigation">
127
      <h3>Navigation</h3>
128
      <ul>
129
        <li class="right" style="margin-right: 10px">
130
          <a href="genindex.html" title="General Index"
131
             >index</a></li>
132
        <li class="right" >
133
          <a href="getting-started.html" title="Getting started"
134
             >next</a> |</li>
135
        <li class="nav-item nav-item-0"><a href="#">WSITools 0.1 documentation</a> &#187;</li> 
136
      </ul>
137
    </div>
138
    <div class="footer" role="contentinfo">
139
        &#169; Copyright .
140
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.
141
    </div>
142
  </body>
143
</html>