forked from python-microscopy/python-microscopy
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathVisGUI.html
More file actions
416 lines (303 loc) · 28.1 KB
/
Copy pathVisGUI.html
File metadata and controls
416 lines (303 loc) · 28.1 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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
<!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>VisGUI - Visualising Localization Data Sets — 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="Common Tasks" href="component_programs.html" />
<link rel="prev" title="dh5view - Image Data Analysis and Viewing" href="Analysis.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"> 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 class="current">
<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 current"><a class="current reference internal" href="#"><strong>VisGUI</strong> - Visualising Localization Data Sets</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#installing-the-standalone-viewer">Installing the standalone viewer</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#system-requirements">System Requirements</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#importing-data">Importing Data</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#h5r-format">.h5r format</a></li>
<li class="toctree-l3"><a class="reference internal" href="#tab-formatted-text">Tab formatted text</a></li>
<li class="toctree-l3"><a class="reference internal" href="#matlab-mat-files">Matlab .mat files</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#exploring-the-data">Exploring the data</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#the-filter">The Filter</a></li>
<li class="toctree-l3"><a class="reference internal" href="#mapping-colour">Mapping & Colour</a></li>
<li class="toctree-l3"><a class="reference internal" href="#interactive-display">Interactive Display</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#image-generation">Image Generation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#image-generation-methods">Image Generation Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="#generated-images">Generated Images</a></li>
<li class="toctree-l3"><a class="reference internal" href="#saving-images">Saving images</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#extras">Extras</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#console">Console</a></li>
<li class="toctree-l3"><a class="reference internal" href="#metadata-events">Metadata, Events</a></li>
</ul>
</li>
</ul>
</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="index.html">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="index.html">Docs</a> »</li>
<li><strong>VisGUI</strong> - Visualising Localization Data Sets</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="visgui-visualising-localization-data-sets">
<span id="visgui"></span><h1><strong>VisGUI</strong> - Visualising Localization Data Sets<a class="headerlink" href="#visgui-visualising-localization-data-sets" title="Permalink to this headline">¶</a></h1>
<div class="section" id="installing-the-standalone-viewer">
<h2>Installing the standalone viewer<a class="headerlink" href="#installing-the-standalone-viewer" title="Permalink to this headline">¶</a></h2>
<p>If you’re using the standalone py2exed version, no installation is necessary - simply unzip and run VisGUI.exe. You should get an image like that shown below.</p>
<img alt="_images/VisGUI_NoData.png" src="_images/VisGUI_NoData.png" />
<p>Otherwise follow the PYME <a class="reference internal" href="Installation/Installation.html#installation"><span class="std std-ref">Installation</span></a> instructions</p>
<div class="section" id="system-requirements">
<h3>System Requirements<a class="headerlink" href="#system-requirements" title="Permalink to this headline">¶</a></h3>
<p>VisGUI will run on relatively low spec machines (I’ve had it running on an old single core 1.6GHz laptop with 1GB of RAM), but for an enjoyable user experience I’d recommend at least the following:</p>
<blockquote>
<div><ul class="simple">
<li>~2GHz Core 2 Duo</li>
<li>2 GB Ram</li>
<li>Hardware OpenGL support</li>
<li>WinXP - I’m pretty sure it’d run on 2K fine, not so sure about Vista or Win7</li>
<li>Wheel mouse - a wheel mouse is required for zooming in the interactive display</li>
</ul>
</div></blockquote>
<p>If you’re wanting to get peak performance out of it, the factors limiting performance are likely to be memory bandwidth, graphics card performance, and the CPU, in that order.</p>
</div>
</div>
<div class="section" id="importing-data">
<h2>Importing Data<a class="headerlink" href="#importing-data" title="Permalink to this headline">¶</a></h2>
<p>To import data, simply use the <code class="docutils literal notranslate"><span class="pre">File->Open</span></code> menu command, launch VisGUI from the command line with the filename as an argument, or right click on a data file in windows explorer and select <strong>Open With</strong> <a class="footnote-reference" href="#id2" id="id1">[1]</a></p>
<table class="docutils footnote" frame="void" id="id2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>you’ll need to tell windows where to find VisGUI the first time you do this.</td></tr>
</tbody>
</table>
<p>Three data formats are currently supported - our custom <code class="docutils literal notranslate"><span class="pre">.h5r</span></code> format, tab delimited text, and matlab <code class="docutils literal notranslate"><span class="pre">.mat</span></code> files. In each case, the data should take the form of a table of values where each row corresponds to a detected single molecule event, and each column corresponds to one of the fitted parameters such as, for example, x position, y position, or amplitude. All position values are assumed to be in nm. The table must contain the <em>x</em> and <em>y</em> positions of the localised single molecule events, and may contain any other pertinant parameters. It is suggested that at least folowing parameters should also be included: the time/frame number at which the event was detected, the event amplitude, event width, and the estimated localisation error.</p>
<p>Once loaded the columns are accessed by semi-descriptive names, with the names <strong>x, y, t, A, sig, error_x</strong> being recognised by the program as the previously introduced parameters.
:note: the program will not work if either <em>x</em> or <em>y</em> is undefined</p>
<div class="section" id="h5r-format">
<h3>.h5r format<a class="headerlink" href="#h5r-format" title="Permalink to this headline">¶</a></h3>
<p>Loading .h5r formatted files is pretty much a no-brainer. All parameters such as column names are read out of the file for you, as well as acquisition meta-data.</p>
</div>
<div class="section" id="tab-formatted-text">
<h3>Tab formatted text<a class="headerlink" href="#tab-formatted-text" title="Permalink to this headline">¶</a></h3>
<p>When importing tab formatted text files, you have to define the column names yourself, using the import dialog. You can also specify the column names within the text file to speed up this process by adding a python style comment (signified by a leading #) to the first line of the file containing a list of tab seperated column names. The dialog will still be shown for confirmation, but the correct column names should already be entered.</p>
<img alt="_images/Import_text_dialog.png" src="_images/Import_text_dialog.png" />
</div>
<div class="section" id="matlab-mat-files">
<h3>Matlab .mat files<a class="headerlink" href="#matlab-mat-files" title="Permalink to this headline">¶</a></h3>
<p>If reading .mat files, VisGUI expects the data to be in a single array. The import dialog is a little more primitive in this case, but the same principle applies - each column needs to be given a name, and the names <em>x</em> and <em>y</em> must be defined. The names are specified by typing a comma separated list of names into the supplied box. Each of the names must be enclosed in double quotes, and there must be exactly the same number of names as there are columns.</p>
<img alt="_images/import_mat.png" src="_images/import_mat.png" />
</div>
</div>
<div class="section" id="exploring-the-data">
<h2>Exploring the data<a class="headerlink" href="#exploring-the-data" title="Permalink to this headline">¶</a></h2>
<p>Having sucessfully loaded a dataset, you should see something resembling the image shown below. If you don’t see anything, don’t panic, the most common reason is that the filter is throwing all your data points away - see <span class="xref std std-ref">The Filter</span>.</p>
<img alt="_images/vis_gui_data_loaded.png" src="_images/vis_gui_data_loaded.png" />
<p>Within the viewer, the data follows a pipeline as illustrated below. The important components are described in detail in the following sections.</p>
<img alt="_images/vis_pipeline.svg" src="_images/vis_pipeline.svg" /><div class="section" id="the-filter">
<h3>The Filter<a class="headerlink" href="#the-filter" title="Permalink to this headline">¶</a></h3>
<p>The filter allows a valid range for each parameter to be specified, thus restricting the analysis to a subset of the point values. This enables eroneous events where, for example, the fit did not converge or the fit picked up a noise spike rather than a true fluorophore to be discarded.</p>
<img alt="_images/filter_panel.png" src="_images/filter_panel.png" />
<p>The filter is controlled using the the filter pane of the sidebar(which can be expanded by clicking the icon in the right corner). Right clicking on the list gives you the option to add, and if a parameter is currently selected, edit or delete a parameter in the filterfootnote{on windows, you sometimes need to click the right mouse button 2-3 times before the menu pops up.}. Double clicking on a filter also allows the filter to be edited. Editing filters brings up a dialog as shown below. A histogram of the selected variable is displayed and the current bounds indicated by red vertical lines. These lines can be dragged with the mouse to change the filter. The filter editor (and all other histogram editors) also understand the following keys if they have focus:</p>
<img alt="_images/filter_edit.png" src="_images/filter_edit.png" />
<table border="1" class="docutils">
<colgroup>
<col width="4%" />
<col width="96%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><em>m</em></td>
<td>sets the bounds to the minumum and maximum values of the variable</td>
</tr>
<tr class="row-even"><td><em>p</em></td>
<td>sets the bounds to the 1st and 99th percentiles</td>
</tr>
<tr class="row-odd"><td><em>l</em></td>
<td>toggles log scaling on y-axis</td>
</tr>
</tbody>
</table>
<p>The filter will typically come with default bounds for <em>A</em> (the point amplitude), <em>sig</em> (the std deviation of the fitted Gaussian), and <em>error_x</em> (the estimated error in the x position). The default values are for our setup and imaging at ~ 488 nm excitation, and are quite likely to need changing. Notably <em>A</em> will need changing if you’re intensity is calibrated differently, and <em>sig</em> will need changing when working at different wavelengths.</p>
<p>The filter is also used to restrict the data to a smaller spatial ROI, by adding filters on the <em>x</em> and <em>y</em> variables. Rather than manually creating and setting these filters, a selection can be made by clicking and dragging with the left mouse button in the view tab (a yellow selection rectangle should be shown), and then clicking on <strong>Clip to Selection</strong> in the filter pane. The ROI can then be cleared by clicking the same button.</p>
</div>
<div class="section" id="mapping-colour">
<h3>Mapping & Colour<a class="headerlink" href="#mapping-colour" title="Permalink to this headline">¶</a></h3>
<p>By default the mapping component of the pipeline simply passes the variables from the filte without change. One can however add mappings which can either define new variables or redefine existing variables. In principle arbitrary transformations, for instance rotation, are possible. There is no direct GUI control over the mapping component.</p>
<p>Following the mapping component there is a colour selection component. This is only important when processing ratiometric multi-colour images (see Multi-Colour), and is effectively transparent at all other times.</p>
</div>
<div class="section" id="interactive-display">
<h3>Interactive Display<a class="headerlink" href="#interactive-display" title="Permalink to this headline">¶</a></h3>
<p>The interactive display is designed to provide a quick and easy method of looking the data. There are 6 different display modes, which can be selected from the <strong>View</strong> menu. The basic operation of display window is common to all: The display can be zoomed in and out using the mouse wheel, and panning is accomplished by sooming out, and back in in a different place. Choosing the <strong>Fit</strong> item from the <strong>View</strong> menu will reset the display such that the whole image fits within the display window. A scale bar and colour look up table are displayed at the right of the image. The <strong>Display</strong> panel in the left sidebar allows the colormap and scaling to be changed (note that the histogram display works the same as those in the filter).</p>
<img alt="_images/disp_panel.png" src="_images/disp_panel.png" />
<p>In addition to the <strong>Display</strong> panel, each mode may display a panel with mode-specific settings such as the <strong>Points</strong> panel. A more detailed description of the various modes is given in the following sections:</p>
<dl class="docutils">
<dt><strong>Points Mode</strong></dt>
<dd>The default visualisation mode is the points mode, in which each localisation event is displayed as a point. The colour of each point can be set to any of the event variables.</dd>
<dt><strong>Triangles Mode</strong></dt>
<dd>In this mode the point positions are triangulated and the triangles displayed with an intensity inversely proportional to their area. See also Image Generation.</dd>
<dt><strong>Quad-Tree</strong></dt>
<dd>A quad tree is generated from the event data and each leaf is coloured with an intensity which is proportional to the number of points it contains, and inversely proportional to it’s size. The leaf capacity (ie the size at which a leaf will be subdivided) can be adjusted. For more info see paper.</dd>
<dt><strong>Voronoi Diagram</strong></dt>
<dd>Similar to triangulation but using the voronoi diagram of the points rather than the triangularisation. Much slower - would suggest only applying to a subset of the image data.</dd>
<dt><strong>Interpolated Triangles</strong></dt>
<dd>As for the triangle mode, the points are triangulated. The colour, however, is derived by interpolating vertex colours derived from one of the variables. Is most suited to visualising parameters which are likely to be correlated for neighbouring events, such as chromatic shift measurements.</dd>
<dt><strong>Blobs</strong></dt>
<dd>This mode attempts to segment the image into connected areas based on neighbour distances, and allows various measurements to be performed on these segmented objects. Might not work under windows.</dd>
</dl>
</div>
</div>
<div class="section" id="image-generation">
<h2>Image Generation<a class="headerlink" href="#image-generation" title="Permalink to this headline">¶</a></h2>
<p>After optimising the filter, corrected drift, and doing other sanity checks on the data, one typically wishes to generate an image. This is accomplished by choosing one of the options from the <strong>Generate Image</strong> menu. All image generation methods generate an image which matches the region currently displayed in the interactive display (View) tab. Remember that the display can be zoomed to the whole image using the <code class="docutils literal notranslate"><span class="pre">View->Fit</span></code> menu item.</p>
<img alt="_images/generate_triangulation_dialog.png" src="_images/generate_triangulation_dialog.png" />
<p>Each method will also display a simlar dialog (but potentially with a slightly different set of options) prompting for the pixel size and any other parameters. The individual methods are described in the following:</p>
<div class="section" id="image-generation-methods">
<h3>Image Generation Methods<a class="headerlink" href="#image-generation-methods" title="Permalink to this headline">¶</a></h3>
<dl class="docutils">
<dt><strong>Current</strong></dt>
<dd>The <em>Current</em> method reproduces what is currently displayed in the interactive display, at a specified pixel size. Note that only the intensity is captured and not the colour information. Whilst this is what you want in some situations, it is not universally so and a colour capture is on the TODO list.</dd>
<dt><strong>Gaussian</strong></dt>
<dd>The <em>Gaussian</em> method performs standard Gaussian visualisation. It defaults to using the estimated position error as the standard deviation of the rendered Gaussian, but any of the parameters can be used. Using the fitted standard deviation, <em>sig</em>, for example allows the easy generation of pseudo-diffraction limited images.</dd>
<dt><strong>Histogram</strong></dt>
<dd>The <em>histogram</em> method simply produces a 2D histogram of the point position data with the specified bin size.</dd>
<dt><strong>Triangularisation</strong></dt>
<dd><p class="first">This performs a Delaunay triangularisation based rendering, with the option of averaging several triangulations based on slightly jittered point positions (see <em>Visualisation of Localisation Microscopy Data, Microscopy & Microanalysis</em>). The variable which dictates the jitter magnitude can be selected and defaults to a measure of the distance between a point and it’s neighbours. The number of samples to average defaults to 10.</p>
<p class="last">In addition to jittering, it is also possible to smooth the triangularisation by averaging several triangularisations performed on Monte-Carlo subsets of the point positions. If you want to try this out, set the multiplier for the jitter to 0 and set the MC subsampling probability to less than 1 (~ 0.2 is probably a good start).</p>
</dd>
<dt><strong>Quad-Tree</strong></dt>
<dd>The <strong>Quad-Tree</strong> method allows a quad tree (see <span class="xref std std-ref">sec:intQT</span>,*Visualisation of Localisation Microscopy Data …*) to be rendered at a given pixel size. The bin depth setting from the Quad tree in the interactive display is used.</dd>
<dt><strong>3D Histogram & 3D Gaussian</strong></dt>
<dd>These methods are 3D versions of the histogram and Gaussian methods for data with <em>z</em> information. 3D versions of the triangularisation and Quad-Tree algorithms are in progress.</dd>
</dl>
</div>
<div class="section" id="generated-images">
<h3>Generated Images<a class="headerlink" href="#generated-images" title="Permalink to this headline">¶</a></h3>
<p>After an image has been generated, it should pop up in a new window. All image windows are locked to the main view window in both position and zoom. Scrolling on any image window will thus result in a global zoom over all image windows. The colour scaling in the generated images can be adjusted selecting the <code class="docutils literal notranslate"><span class="pre">View->Colour</span> <span class="pre">scaling</span></code> menu item, which displays a small pop-up window with a histogram view.</p>
<img alt="_images/generated_image.png" src="_images/generated_image.png" />
<p>The image viewer is designed to view multi-colour images, in which case the individual channels will appear as separate tabs, in addition to a composite tab in which the channels are overlaid. When dealing with single channel data, only one tab is displayed.</p>
</div>
<div class="section" id="saving-images">
<h3>Saving images<a class="headerlink" href="#saving-images" title="Permalink to this headline">¶</a></h3>
<p>The generated images have three save options, all of which can be accessed from the <strong>File</strong> menu. The one you will generally want is <strong>Save Channel</strong> which saves the entire current channel/image as a single, floating point, TIFF without any colormap or scaling applied. The other two options allow a multi-channel image to be saved as a TIFF stack <a class="footnote-reference" href="#id4" id="id3">[2]</a> (<strong>Save Multi-channel</strong>), and allows for exporting exactly what is currently shown in the window (complete with colour maps, scaling, and zoom) as a variety of formats (<strong>Export Current View</strong>).</p>
<table class="docutils footnote" frame="void" id="id4" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id3">[2]</a></td><td>Although this currently relies on an external program, <code class="docutils literal notranslate"><span class="pre">tiffcp</span></code>, and is untested on windows.}</td></tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="extras">
<h2>Extras<a class="headerlink" href="#extras" title="Permalink to this headline">¶</a></h2>
<div class="section" id="console">
<h3>Console<a class="headerlink" href="#console" title="Permalink to this headline">¶</a></h3>
<p>The console tab is a functional python console embedded within the program. The pipeline can be accessed directly, and behaves like a dictionary which understands the variable names as keys <a class="footnote-reference" href="#id6" id="id5">[3]</a> . A number of Matlab style plotting and basic numeric commands are accessible by executing <code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">pylab</span> <span class="pre">import</span> <span class="pre">*</span></code> (see the <a class="reference external" href="http://matplotlib.sourceforge.net">matplotlib</a> webpage for more docs). After importing pylab, one can, for example, plot a histogram of point amplitudes by executing <code class="docutils literal notranslate"><span class="pre">hist(pipeline['A'])</span></code>.</p>
<table class="docutils footnote" frame="void" id="id6" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id5">[3]</a></td><td>a lot of other aspects of the program are callable/accesible from the console window, but are beyond the scope of this quick introduction</td></tr>
</tbody>
</table>
</div>
<div class="section" id="metadata-events">
<h3>Metadata, Events<a class="headerlink" href="#metadata-events" title="Permalink to this headline">¶</a></h3>
<p>The Metadata and Events tabs show metadata and event data relating to the acquisition. This is only realy useful for files saved in .h5r format as default (and probably erroneous) values are used when loading from .txt or .mat.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="component_programs.html" class="btn btn-neutral float-right" title="Common Tasks" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Analysis.html" class="btn btn-neutral float-left" title="dh5view - Image Data Analysis and Viewing" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</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>