-
Notifications
You must be signed in to change notification settings - Fork 26
Expand file tree
/
Copy pathindex.html
More file actions
301 lines (189 loc) · 12.4 KB
/
Copy pathindex.html
File metadata and controls
301 lines (189 loc) · 12.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>PYME’s Documentation — PYME 20.02.12 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<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>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation of PYME on 64 bit Windows, OSX, or Linux" href="Installation/InstallationWithAnaconda.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="#" class="icon icon-home"> PYME
<img src="_static/pymeLogo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
20.02.12
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="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="main navigation">
<p class="caption"><span class="caption-text">Installation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Installation/InstallationWithAnaconda.html">Installation of PYME on 64 bit Windows, OSX, or Linux</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation/InstallationFromSource.html">Installation for development or instrument control</a></li>
</ul>
<p class="caption"><span class="caption-text">User Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="PYMEAcquire.html"><strong>PYMEAcquire</strong> - Instrument control and simulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="Analysis.html"><strong>dh5view</strong> - Image Data Analysis and Viewing</a></li>
<li class="toctree-l1"><a class="reference internal" href="VisGUI.html"><strong>VisGUI</strong> - Visualising Localization Data Sets</a></li>
<li class="toctree-l1"><a class="reference internal" href="component_programs.html">Common Tasks</a></li>
<li class="toctree-l1"><a class="reference internal" href="LocalisationAnalysis.html">Analysing Localisation Microscopy data</a></li>
</ul>
<p class="caption"><span class="caption-text">Development / Hacking</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="hacking.html">Extending PYME and writing plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="hacking.html#technical-details">Technical Details</a></li>
<li class="toctree-l1"><a class="reference internal" href="hacking.html#api-documentation">API Documentation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">PYME</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>PYME’s Documentation</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">
<div class="section" id="pyme-s-documentation">
<span id="pymemaindocs"></span><h1>PYME’s Documentation<a class="headerlink" href="#pyme-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>Welcome to the documentation for the python-microscopy environment, set of tools for optical microscopy, and in particular
localization - based super-resolution microscopy.</p>
<p>This documentation is currently very much a work in progress and is far from being complete. The API documentation, in
particular could use a lot of work. Hopefully it’s enough to get you started, however.</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Installation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Installation/InstallationWithAnaconda.html">Installation of PYME on 64 bit Windows, OSX, or Linux</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation/InstallationFromSource.html">Installation for development or instrument control</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">User Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="PYMEAcquire.html"><strong>PYMEAcquire</strong> - Instrument control and simulation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ConfiguringPYMEAcquire.html">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="AcquireBasicUsage.html">Basic Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="BasicAcquisition.html">Simple dSTORM/RPM walkthrough</a></li>
<li class="toctree-l2"><a class="reference internal" href="Simulator.html">Simulator</a></li>
<li class="toctree-l2"><a class="reference internal" href="Protocols.html">Acquisition Protocols</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Analysis.html"><strong>dh5view</strong> - Image Data Analysis and Viewing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Analysis.html#modules">Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="Analysis.html#modes">Modes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="VisGUI.html"><strong>VisGUI</strong> - Visualising Localization Data Sets</a><ul>
<li class="toctree-l2"><a class="reference internal" href="VisGUI.html#installing-the-standalone-viewer">Installing the standalone viewer</a></li>
<li class="toctree-l2"><a class="reference internal" href="VisGUI.html#importing-data">Importing Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="VisGUI.html#exploring-the-data">Exploring the data</a></li>
<li class="toctree-l2"><a class="reference internal" href="VisGUI.html#image-generation">Image Generation</a></li>
<li class="toctree-l2"><a class="reference internal" href="VisGUI.html#extras">Extras</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="component_programs.html">Common Tasks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="LocalisationAnalysis.html">Analysing Localisation Microscopy data</a></li>
<li class="toctree-l2"><a class="reference internal" href="PSFExtraction.html">PSF Extraction</a></li>
<li class="toctree-l2"><a class="reference internal" href="Recipes.html">Using recipes for data processing and quantification</a></li>
<li class="toctree-l2"><a class="reference internal" href="howtos/distancecolocalization.html">Distance transform colocalization HOWTO</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="LocalisationAnalysis.html">Analysing Localisation Microscopy data</a><ul>
<li class="toctree-l2"><a class="reference internal" href="AnalysingForeignData.html">Analysing data not generated by PYMEAcquire</a></li>
<li class="toctree-l2"><a class="reference internal" href="SplitterMulticolour.html">Using an image splitting device for multi-colour ratiometric imaging</a></li>
<li class="toctree-l2"><a class="reference internal" href="LocalisationAnalysis.html#starting-distributed-analysis-infrastructure">Starting distributed analysis infrastructure</a></li>
<li class="toctree-l2"><a class="reference internal" href="LocalisationAnalysis.html#loading-data">Loading data</a></li>
<li class="toctree-l2"><a class="reference internal" href="LocalisationAnalysis.html#analysis-settings">Analysis settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="LocalisationAnalysis.html#starting-the-fitting">Starting the fitting</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Development / Hacking</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="hacking.html">Extending PYME and writing plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Contributing.html">Contributing changes back to PYME</a></li>
<li class="toctree-l2"><a class="reference internal" href="DataModel.html">PYME Data Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="WritingRecipeModules.html">Writing a Recipe Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ExtendingDsviewer.html">Extending the image data viewer (dh5view/View3D)</a></li>
<li class="toctree-l2"><a class="reference internal" href="ExtendingVisGUI.html">Extending VisGUI</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/PYME.config.html">PYME.config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ModifyingPYMEAcquire.html">Modifying PYMEAcquire and writing hardware drivers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="hacking.html#technical-details">Technical Details</a><ul>
<li class="toctree-l2"><a class="reference internal" href="DataFormats.html">PYME Data Formats</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html">PYME Metadata</a></li>
<li class="toctree-l2"><a class="reference internal" href="tiff_handling.html">TIFF support in PYME</a></li>
<li class="toctree-l2"><a class="reference internal" href="SampleDB.html">The Sample Database</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="hacking.html#api-documentation">API Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/PYME.html">PYME package</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Installation/InstallationWithAnaconda.html" class="btn btn-neutral float-right" title="Installation of PYME on 64 bit Windows, OSX, or Linux" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2016, David Baddeley
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>