-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhotkey_index.html
579 lines (434 loc) · 17.3 KB
/
hotkey_index.html
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
<!DOCTYPE html>
<html lang="en" data-content_root="" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<title>Hotkey Index — Bdetectlab v1.1 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" href="_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=5b4479735964841361fd" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
<script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'hotkey_index';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Packages and Modules Used" href="key_resources.html" />
<link rel="prev" title="Tutorial" href="tutorial.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<a class="skip-link" href="#main-content">Skip to main content</a>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>
Back to top
</button>
<input type="checkbox"
class="sidebar-toggle"
name="__primary"
id="__primary"/>
<label class="overlay overlay-primary" for="__primary"></label>
<input type="checkbox"
class="sidebar-toggle"
name="__secondary"
id="__secondary"/>
<label class="overlay overlay-secondary" for="__secondary"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<nav class="bd-header navbar navbar-expand-lg bd-navbar">
</nav>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/bneuron_web.ico" class="logo__image only-light" alt="Bdetectlab v1.1 documentation - Home"/>
<script>document.write(`<img src="_static/bneuron_web.ico" class="logo__image only-dark" alt="Bdetectlab v1.1 documentation - Home"/>`);</script>
</a></div>
<div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Overview:</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Hotkey Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="key_resources.html">Packages and Modules Used</a></li>
<li class="toctree-l1"><a class="reference internal" href="search.html">Search Page</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main">
<div class="sbt-scroll-pixel-helper"></div>
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item"><label class="sidebar-toggle primary-toggle btn btn-sm" for="__primary" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</label></div>
</div>
<div class="header-article-items__end">
<div class="header-article-item">
<div class="article-header-buttons">
<div class="dropdown dropdown-download-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
<i class="fas fa-download"></i>
</button>
<ul class="dropdown-menu">
<li><a href="_sources/hotkey_index.rst" target="_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file"></i>
</span>
<span class="btn__text-container">.rst</span>
</a>
</li>
<li>
<button onclick="window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file-pdf"></i>
</span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
</ul>
</div>
<button onclick="toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-expand"></i>
</span>
</button>
<script>
document.write(`
<button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
<span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
<span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
</button>
`);
</script>
<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
`);
</script>
</div></div>
</div>
</div>
</div>
<div id="jb-print-docs-body" class="onlyprint">
<h1>Hotkey Index</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article" role="main">
<section id="hotkey-index">
<span id="id1"></span><h1>Hotkey Index<a class="headerlink" href="#hotkey-index" title="Permalink to this heading">#</a></h1>
<blockquote>
<div><p>Besides using the mouse to interact with options such as menu bar, tool bar, and widgets (Burst ID slider bar, Peak ID spin box), the curation GUI also provides with hotkeys for faster curation. The following is a list of hotkeys that can be used in the curation GUI.</p>
</div></blockquote>
<ul>
<li><p>Hotkeys for main window widgets</p>
<blockquote>
<div><ul class="simple">
<li><dl class="simple">
<dt>Q: Move to previous spike peak/decrease Peak ID.</dt><dd><ul>
<li><p>Same as clicking the down arrow button on the Peak ID spin box.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>W: Move to next spike peak/increase Peak ID.</dt><dd><ul>
<li><p>Same as clicking the up arrow button on the Peak ID spin box.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>G: Go to previous burst event/decrease Burst ID.</dt><dd><ul>
<li><p>Same as slide the Burst Slider towards left.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>H: Go to next burst event/increase Burst ID.</dt><dd><ul>
<li><p>Same as move the Burst Slider towards right.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>J: For <em>Show Help</em> checkbox in the bottom left corner of the main window.</dt><dd><ul>
<li><p>Same as <em>Show Curation Assistant</em></p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>K: For <em>Show Burst</em> checkbox in the bottom right corner of the main window.</dt><dd><ul>
<li><p>Same as <em>Display/Hide figure of current marked burst</em></p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
</li>
<li><p>Hotkeys for menu bar</p>
<blockquote>
<div><ul class="simple">
<li><p>1: Load <cite>unsorted Data</cite></p></li>
<li><p>2: Load <cite>Sorted Data</cite></p></li>
<li><p>3: <cite>Load Sample</cite></p></li>
<li><p>T: Get a list of bursts candidates.</p></li>
<li><p>L: Check bursts to see whether there are duplicate indexes.</p></li>
<li><p>P: Delete the duplicate burst events.</p></li>
<li><dl class="simple">
<dt>O: Reassign spike cluster ID</dt><dd><ul>
<li><p>This is a critical step before saving results.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>V: Save curated bursts</dt><dd><ul>
<li><p>Curation results will be saved in the user defined directory or current working directory if the pre-defined directory can not be found.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>U: Load next unsorted data</dt><dd><ul>
<li><p>Same as open <cite>unsorted data</cite>.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>I and J: Show Curation Assistant</dt><dd><ul>
<li><p>A clock dockwidget will show up. This widget can be closed or hide, and revoke either using ‘I’ or ‘Show Curation Asistant’ option.</p></li>
<li><p>When this widget is visible, key ‘J’ can be used to show/hide a new window that contains ‘Curation History’ and ‘Duplicate Index’ panels.</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
</li>
<li><p>Hotkeys for toolbar options</p>
<blockquote>
<div><ul class="simple">
<li><dl class="simple">
<dt>A: Add spikes with square labels.</dt><dd><ul>
<li><p>A standard curation process is to first add spikes with square labels, then move to selected peaks to add the rest labelled spikes.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>S: Add spike with star label.</dt><dd><ul>
<li><p>These are the spike peaks that are not in the burst candidate list but are still likely to be bursting spikes. These spikes will be added to the burst when the burst is marked.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>D: Delete the selected spike peak.</dt><dd><ul>
<li><p>This will delete any selected spike peak.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>M: Mark the current burst</dt><dd><ul>
<li><p>User can mark the burst mutiple time despite warning sound.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>K: Display/Hide figure of current marked burst</dt><dd><ul>
<li><p>Only added spikes will be color coded in the figure.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>C: Save figure of marked burst</dt><dd><ul>
<li><p>The figure will be saved in the user defined directory or current working directory if the pre-defined directory can not be found.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>B: Add the current burst</dt><dd><ul>
<li><p>User can invoke ‘Show Curation Asistant’ window, find ‘Curation History’ panel to see the current burst candidate list.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>R: Cancel the current burst</dt><dd><ul>
<li><p>All the curation results of the current burst including keybaord/mouse inputs by program will be cleared.</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
</li>
</ul>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>A warning sound will be played if any of these hotkey is clicked more than once for a same burst candidate.</p>
</div>
<ul>
<li><p>Other keybaord shortcuts</p>
<blockquote>
<div><ul class="simple">
<li><dl class="simple">
<dt>Y: Mute/Unmute curation GUI sound</dt><dd><ul>
<li><p>User can mute/unmute the curation GUI sound without affecting the system sound setting.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Z: Take screenshots of curation GUI</dt><dd><ul>
<li><p>Screenshots will be saved in the user defined directory or current working directory if the pre-defined directory can not be found.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Esc: Exit curation GUI</dt><dd><ul>
<li><p>A confirmation dialog will pop up to ask user whether to exit the curation GUI.</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
</li>
</ul>
</section>
</article>
<footer class="prev-next-footer">
<div class="prev-next-area">
<a class="left-prev"
href="tutorial.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Tutorial</p>
</div>
</a>
<a class="right-next"
href="key_resources.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Packages and Modules Used</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner container">
<div class="footer-item">
<p class="component-author">
By Effy Y.Z.
</p>
</div>
<div class="footer-item">
<p class="copyright">
© Copyright 2023, Effy Y.Z..
<br/>
</p>
</div>
<div class="footer-item">
</div>
<div class="footer-item">
</div>
</div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="_static/scripts/bootstrap.js?digest=5b4479735964841361fd"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd"></script>
<footer class="bd-footer">
</footer>
</body>
</html>