keyboard_shortcuts.rst 16.3 KB
Newer Older
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
.. |command_key| unicode:: U+2318
.. |shift_key|   unicode:: U+21E7
.. |control_key| unicode:: U+2303
.. |alt_key|     unicode:: U+2325
.. |up_key|      unicode:: U+2191
.. |down_key|    unicode:: U+2193
.. |left_key|    unicode:: U+2190
.. |right_key|   unicode:: U+2192





.. _keyboard_shortcuts:

Keyboard and mouse shortcuts
============================


.. contents::
   :local:
   :depth: 1


FSLeyes has a number of keyboard and mouse shortcuts and modifiers which can
make performing various tasks more convenient. This page contains a list of
all keyboard and mouse shortcuts available for use within FSLeyes.


Modifier keys
-------------


The following symbols and terms are used to represent various keyboard keys:

Paul McCarthy's avatar
Paul McCarthy committed
36
37
38
39
 - |shift_key|: Shift key
 - |control_key|: Control key
 - |command_key|: Command key (on macOS; Control key on other platforms)
 - |alt_key|: Option key (on macOS; Alt on other platforms)
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
 - |up_key|: Up arrow key
 - |down_key|: Down arrow key
 - |left_key|: Left arrow key
 - |right_key|: Right arrow key
 - **Left mouse**: Left mouse button, typically a one-finger tap on a touchpad
 - **Right mouse**: Right mouse button, typically a two-finger tap on a
   touchpad
 - **Middle mouse**: Left mouse button, typically a three-finger tap on a
   touchpad
 - **Mouse wheel**: Mouse-wheel scrolling, typically a two-finger drag on a
   touchpad


General
-------


The following shortcuts are available throughout FSLeyes.


.. rst-class:: linewrap-table

=================================== =====================================
Shortcut                            Action
=================================== =====================================
|command_key| + ``q``               Exit FSLeyes
|command_key| + |shift_key| + ``/`` Open FSLeyes user documentation
|command_key| + |shift_key| + ``d`` Change to default view/control panel
                                    layout
|command_key| + ``1``               Open ortho view
|command_key| + ``2``               Open lightbox view
|command_key| + ``3``               Open time series view
|command_key| + ``4``               Open histogram view
|command_key| + ``5``               Open power spectrum view
|command_key| + ``6``               Open 3D view
|command_key| + ``7``               Open Python shell
|command_key| + ``w``               Close focused view
|command_key| + |alt_key| + ``x``   Remove all controls from focused view
|command_key| + ``o``               Load new overlay
|command_key| + ``d``               Load new overlay from directory
|command_key| + ``s``               Load new overlay from
                                    ``$FSLDIR/data/standard/``
|command_key| + |up_key|            Select next overlay in list (within
                                    the focused view)
|command_key| + |down_key|          Select previous overlay in list
                                    (within the focused view)
|command_key| + ``f``               Show/hide selected overlay (within
                                    the focused view)
|command_key| + |shift_key| + ``n`` Create new image
|command_key| + |shift_key| + ``c`` Copy selected image
|command_key| + |shift_key| + ``s`` Save selected image
|command_key| + |shift_key| + ``r`` Re-load selected overlay
|command_key| + |shift_key| + ``w`` Remove selected overlay
=================================== =====================================


Ortho, ligthbox, and 3D views
-----------------------------


The following shortcuts are available within ortho, lightbox, and 3D views.


.. rst-class:: linewrap-table

================================= =====================================
Shortcut                          Action
================================= =====================================
|command_key| + |alt_key| + ``1`` Open/close overlay list
|command_key| + |alt_key| + ``2`` Open/close location panel
|command_key| + |alt_key| + ``3`` Open/close overlay information
|command_key| + |alt_key| + ``4`` Open/close overlay display settings
|command_key| + |alt_key| + ``5`` Open/close view settings
|command_key| + |alt_key| + ``6`` Open/close FSL atlas panel
|command_key| + |alt_key| + ``7`` Open/close overlay display toolbar
|command_key| + |alt_key| + ``8`` Open/close ortho/lightbox/3D toolbar
|command_key| + |alt_key| + ``9`` Open/close file tree panel
|alt_key| + ``m``                 Start/stop movie mode
================================= =====================================


Some additional shortcuts are available within ortho views.


.. rst-class:: linewrap-table

================================= =====================================
Shortcut                          Action
================================= =====================================
Paul McCarthy's avatar
Paul McCarthy committed
129
|command_key| + |alt_key| + ``a`` Open/close annotations panel
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
|alt_key| + ``e``                 Toggle edit mode
|alt_key| + ``r``                 Reset zoom/pan
|alt_key| + ``c``                 Reset location to centre
|alt_key| + ``o``                 Reset location to world origin
|alt_key| + ``l``                 Show/hide orientation labels
|alt_key| + ``c``                 Show/hide location cursor
|alt_key| + ``x``                 Show/hide X (sagittal) canvas
|alt_key| + ``y``                 Show/hide Y (coronal) canvas
|alt_key| + ``z``                 Show/hide Z (axial) canvas
|alt_key| + ``i``                 Seed correlation on 4D image
|up_key|                          Move location up in focused canvas
|down_key|                        Move location down in focused canvas
|left_key|                        Move location left in focused canvas
|right_key|                       Move location right in focused canvas
``-`` / ``_``                     Previous slice in focused canvas
``+`` / ``=``                     Next slice in focused canvas
================================= =====================================


Plotting views
--------------


The following shortcuts and actions are available within time series,
histogram, and power spectrum views.


.. rst-class:: linewrap-table

======================================== =====================================
Shortcut                                 Action
======================================== =====================================
|command_key| + |alt_key| + ``1``        Open/close overlay list
|command_key| + |alt_key| + ``2``        Open/close plot list
|command_key| + |alt_key| + ``3``        Open/close time series/histogram/
                                         power spectrum toolbar
|command_key| + |alt_key| + ``4``        Open/close time series/histogram/
                                         power spectrum control panel
|command_key| + ``i``                    Import data from file
|command_key| + ``e``                    Save data to file
Left mouse click/drag                    Pan
Right mouse click/drag                   Zoom
|command_key| + left mouse click/drag    Adjust overlay range, when a :ref:`3D
                                         histogram overlay
                                         <plot_views_histogram_control>` is
                                         shown (histogram view only)
|command_key| + left mouse click/drag    Change volume (time series view only)
======================================== =====================================



Ortho, lightbox, and 3D view interaction
----------------------------------------


The following actions are available in the ortho view.


.. rst-class:: linewrap-table

Paul McCarthy's avatar
Paul McCarthy committed
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
+-----------------------------------+-----------------------------------------+
| Shortcut                          | Action                                  |
+-----------------------------------+-----------------------------------------+
| Left mouse click/drag             | Change location                         |
+-----------------------------------+-----------------------------------------+
| Right mouse drag                  | Zoom to rectangle                       |
+-----------------------------------+-----------------------------------------+
| Middle mouse drag                 | Pan                                     |
+-----------------------------------+-----------------------------------------+
| |command_key| + mouse wheel/      | Zoom                                    |
| scroll                            |                                         |
+-----------------------------------+-----------------------------------------+
| |alt_key| + mouse drag            | Pan                                     |
+-----------------------------------+-----------------------------------------+
| |shift_key| + mouse wheel/scroll  | Change slice                            |
+-----------------------------------+-----------------------------------------+
| |shift_key| + mouse click+drag    | Select nearest vertex (when a           |
|                                   | :ref:`mesh overlay <overlays_mesh>`     |
|                                   | is selected)                            |
+-----------------------------------+-----------------------------------------+
| |command_key| + |shift_key| +     | Adjust brightness/contrast with the     |
| mouse click+drag                  | mouse                                   |
+-----------------------------------+-----------------------------------------+
| |command_key| + |shift_key| +     | Adjust brightness/contrast by           |
| right mouse click+drag            | selecting a region (when a              |
|                                   | :ref:`volume overlay <overlays_volume>` |
|                                   | is selected)                            |
+-----------------------------------+-----------------------------------------+
218
219
220
221
222
223
224
225
226
227


The following actions are available in the lightbox view.


.. rst-class:: linewrap-table

======================================== =====================================
Shortcut                                 Action
======================================== =====================================
Paul McCarthy's avatar
Paul McCarthy committed
228
Left mouse click+drag                    Change location
229
230
231
232
233
234
235
236
237
|command_key| + mouse wheel/scroll       Zoom
======================================== =====================================


The following actions are available in the 3D view.


.. rst-class:: linewrap-table

Paul McCarthy's avatar
Paul McCarthy committed
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
+---------------------------------------+---------------------------------+
| Shortcut                              | Action                          |
+---------------------------------------+---------------------------------+
| Left mouse click+drag                 | Rotate scene                    |
+---------------------------------------+---------------------------------+
| Middle mouse click+drag               | Pan                             |
+---------------------------------------+---------------------------------+
| |command_key| + mouse wheel/scroll    | Zoom                            |
+---------------------------------------+---------------------------------+
| |alt_key| + mouse click+drag          | Pan                             |
+---------------------------------------+---------------------------------+
| |shift_key| + mouse click+drag        | Select nearest vertex (for mesh |
|                                       | overlays) or voxel (for volume  |
|                                       | overlays)                       |
+---------------------------------------+---------------------------------+
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


Ortho edit mode
---------------


The following shortcuts and actions are available in ortho edit mode.

.. rst-class:: linewrap-table

======================================== =====================================
Shortcut                                 Action
======================================== =====================================
|command_key| + ``z``                    Undo last change
|command_key| + ``y``                    Redo last undone change
|command_key| + ``n``                    Create new mask
|command_key| + |shift_key| + ``a``      Clear selection (select mode only)
|command_key| + ``b``                    Fill selected voxels (select mode
                                         only)
|command_key| + ``e``                    Erase selected voxels (select mode
                                         only)
|command_key| + ``i``                    Invert selection (select mode only)
|command_key| + ``c``                    Copy/paste data across images (select
                                         mode only)
|command_key| + ``p``                    Copy/paste selection across  slices
                                         (select mode only)
======================================== =====================================


The following actions are available when using the pencil, eraser, bucket, or
select-by-intensity tools:


+-------------------------------------+---------------------------------------+
| Shortcut                            | Action                                |
+-------------------------------------+---------------------------------------+
| *All tools*                                                                 |
+-------------------------------------+---------------------------------------+
Paul McCarthy's avatar
Paul McCarthy committed
291
| |shift_key| + left mouse click+drag | Change location                       |
292
293
294
+-------------------------------------+---------------------------------------+
| |shift_key| + mouse wheel/scroll    | Change slice                          |
+-------------------------------------+---------------------------------------+
Paul McCarthy's avatar
Paul McCarthy committed
295
| |alt_key| + left mouse click+drag   | Pan                                   |
296
297
298
+-------------------------------------+---------------------------------------+
| |command_key| + mouse wheel/scroll  | Zoom                                  |
+-------------------------------------+---------------------------------------+
Paul McCarthy's avatar
Paul McCarthy committed
299
| Middle mouse click+drag             | Pan                                   |
300
301
302
+-------------------------------------+---------------------------------------+
| *Pencil tool*                                                               |
+-------------------------------------+---------------------------------------+
Paul McCarthy's avatar
Paul McCarthy committed
303
| Left mouse click+drag               | Draw/select voxels                    |
304
+-------------------------------------+---------------------------------------+
Paul McCarthy's avatar
Paul McCarthy committed
305
| Right mouse click+drag              | Erase/de-select voxels                |
306
307
308
+-------------------------------------+---------------------------------------+
| *Eraser tool*                                                               |
+-------------------------------------+---------------------------------------+
Paul McCarthy's avatar
Paul McCarthy committed
309
| Left mouse click+drag               | Erase/de-select voxels                |
310
+-------------------------------------+---------------------------------------+
Paul McCarthy's avatar
Paul McCarthy committed
311
| Right mouse click+drag              | Draw/select voxels                    |
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
+-------------------------------------+---------------------------------------+
| *Pencil and eraser tools*                                                   |
+-------------------------------------+---------------------------------------+
| |command_key| + |shift_key| + mouse | Change cursor size                    |
| wheel/scroll                        |                                       |
+-------------------------------------+---------------------------------------+
| *Select-by-intensity tool*                                                  |
+-------------------------------------+---------------------------------------+
| |command_key| + |shift_key| + mouse | Change intensity threshold            |
| wheel/scroll                        |                                       |
+-------------------------------------+---------------------------------------+
| |alt_key| + |shift_key| + mouse     | Change selection radius               |
| wheel/scroll                        |                                       |
+-------------------------------------+---------------------------------------+


The ortho crop tool
-------------------

The following actions are available when using the ortho crop tool.


.. rst-class:: linewrap-table

======================================== =====================================
Shortcut                                 Action
======================================== =====================================
Paul McCarthy's avatar
Paul McCarthy committed
339
340
341
342
Left mouse click+drag                    Adjust crop box
|shift_key| + left mouse click+drag      Change location
|shift_key| + left mouse click+drag      Change location
|alt_key| + left mouse click+drag        Pan
343
344
|command_key| + mouse wheel/scroll       Zoom
======================================== =====================================