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
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
|
.. _ginga-quick-reference:
+++++++++++++++
Quick Reference
+++++++++++++++
=================
Main image window
=================
These keyboard and mouse operations are available when the main image
window has the focus.
.. _mode_control_commands:
Mode control commands
=====================
About modes
-----------
Certain keystrokes invoke a *mode*---modes are usually indicated by the
*mode indicator*: a small black rectangle with the mode name in one corner
of the view. In a mode, there are usually some special key, cursor, and
scroll bindings that override *some* of the default ones.
Modes additionally have a *mode type* which can be set to one of the following:
* `held`: mode is active while the activating key is held down
* `oneshot`: mode is released by initiating and finishing a cursor drag
or when `Esc` is pressed, if no cursor drag is performed
* `locked`: mode is locked until the mode key is pressed again (or `Esc`)
By default, most modes are activated in "locked" type. The mode type is
indicated in the brackets after the mode name in the mode indicator.
The following keys are important for initiating a mode:
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| Space | Enter "meta" mode. Next keystroke will trigger |
| | a particular mode. |
+----------------------+--------------------------------------------------+
| Esc | Exit any mode. |
+----------------------+--------------------------------------------------+
.. _meta_mode:
"meta" mode
-----------
Most modes are defined so that they are invoked from a special intermediate
mode called "meta". In that case a two-key sequence is required to enter
the mode: pressing the key that invokes "meta" and then pressing the key that
invokes the desired mode. The following table shows the modes that can be
triggered from meta mode.
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| Space | Exit/Enter "meta" mode. |
+----------------------+--------------------------------------------------+
| b | Enter draw mode (canvas must be enabled to draw).|
+----------------------+--------------------------------------------------+
| q | Enter :ref:`Pan mode <pan_mode>`. |
+----------------------+--------------------------------------------------+
| w | Enter :ref:`Zoom mode <zoom_mode>`. |
+----------------------+--------------------------------------------------+
| r | Enter :ref:`Rotate mode <rotate_mode>`. |
+----------------------+--------------------------------------------------+
| t | Enter :ref:`Contrast mode <contrast_mode>`. |
+----------------------+--------------------------------------------------+
| y | Enter :ref:`CMap (color map) mode <cmap_mode>`. |
+----------------------+--------------------------------------------------+
| s | Enter :ref:`Cuts mode <cuts_mode>`. |
+----------------------+--------------------------------------------------+
| d | Enter Color Distribution ("dist") mode. |
| | See :ref:`Dist mode <dist_mode>`. |
+----------------------+--------------------------------------------------+
| n | Enter naxis (cube axis navigation) mode. |
| | See :ref:`Naxis mode <naxis_mode>`. |
+----------------------+--------------------------------------------------+
| L | Toggle the normal lock to the current mode or |
| | any future modes. |
+----------------------+--------------------------------------------------+
.. _panning_zooming_commands:
Panning and zooming commands
============================
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| scroll-wheel | Zoom in or out. |
+----------------------+--------------------------------------------------+
| Shift + scroll-wheel | Zoom while keeping location under the cursor. |
+----------------------+--------------------------------------------------+
| Ctrl + scroll-wheel | Pan in direction of scroll. |
+----------------------+--------------------------------------------------+
| Digit | Zoom image to zoom steps 1, 2, ..., 9, 10. |
| (1234567890) | |
+----------------------+--------------------------------------------------+
| Shift + Digit | Zoom image to zoom steps -1, -2, ..., -9, -10. |
+----------------------+--------------------------------------------------+
| Backquote (\`) | Zoom image to fit window and center it. |
+----------------------+--------------------------------------------------+
| Minus, Underscore | Zoom out. |
| (-, \_) | |
+----------------------+--------------------------------------------------+
| Equals, Plus | Zoom in. |
| (=, +) | |
+----------------------+--------------------------------------------------+
| Middle (scroll) | Set pan position (under cursor). |
| button click | |
+----------------------+--------------------------------------------------+
| p | Set pan position (under cursor) for zooming. |
+----------------------+--------------------------------------------------+
| Shift + left-click | Set pan position for zooming. |
+----------------------+--------------------------------------------------+
| Shift + arrow key | Move pan position 1 pixel in that direction. |
+----------------------+--------------------------------------------------+
| c | Set pan position to the center of the image. |
+----------------------+--------------------------------------------------+
| Ctrl + left-drag | Proportional pan (press and drag left mouse |
| | button. |
+----------------------+--------------------------------------------------+
| slash (/) | Set autocenter for new images to *override*. |
+----------------------+--------------------------------------------------+
| question (?) | Toggle autocenter for images to *on* or *off*. |
+----------------------+--------------------------------------------------+
| apostrophe (') | Set autozoom for new images to *override*. |
+----------------------+--------------------------------------------------+
| double quote (") | Toggle autozoom for new images to *on* or *off*. |
+----------------------+--------------------------------------------------+
.. _cut_levels_colormap_commands:
Cut levels and colormap commands
================================
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| a | Auto cut levels. |
+----------------------+--------------------------------------------------+
| D | Reset color distribution algorithm to "linear". |
+----------------------+--------------------------------------------------+
| T | Restore the contrast (via colormap) to its |
| | original (unstretched, unshifted) state. |
+----------------------+--------------------------------------------------+
| Y | Restore the color map to default (gray). |
+----------------------+--------------------------------------------------+
| I | Invert the color map. |
+----------------------+--------------------------------------------------+
| semicolon (;) | Set autocuts for new images to *override*. |
+----------------------+--------------------------------------------------+
| colon (:) | Toggle autocuts for new images to *on* or *off*. |
+----------------------+--------------------------------------------------+
.. _transform_commands:
Transform commands
==================
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| Left bracket ([) | Toggle flip image in X. |
+----------------------+--------------------------------------------------+
| Left brace ({) | Reset to no flip of image in X. |
+----------------------+--------------------------------------------------+
| Right bracket (]) | Toggle flip image in Y. |
+----------------------+--------------------------------------------------+
| Right brace (}) | Reset to no flip image in Y. |
+----------------------+--------------------------------------------------+
| Backslash (\\) | Swap X and Y axes. |
+----------------------+--------------------------------------------------+
| Vertical bar (|) | Reset to no swap of X and Y axes. |
+----------------------+--------------------------------------------------+
| R | Restore rotation to 0 degrees and additionally |
| | undo any flip/swap transformations. |
+----------------------+--------------------------------------------------+
| period (.) | Increment current rotation by 90 degrees. |
+----------------------+--------------------------------------------------+
| comma (,) | Decrement current rotation by 90 degrees. |
+----------------------+--------------------------------------------------+
| o | Orient image by transforms and rotation so that |
| | WCS indicates North=Up and East=Left. |
+----------------------+--------------------------------------------------+
| O | Orient image by transforms and rotation so that |
| | WCS indicates North=Up and East=Right. |
+----------------------+--------------------------------------------------+
.. _pan_mode:
Pan mode
========
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| left-drag | Pan proportionally to drag. |
+----------------------+--------------------------------------------------+
| pan-gesture | Pan proportionally to gesture. |
+----------------------+--------------------------------------------------+
| middle-click | Set pan position. |
+----------------------+--------------------------------------------------+
| right-drag | Zoom in/out proportionally to L/R drag. |
+----------------------+--------------------------------------------------+
| scroll-wheel | Zoom in or out. |
+----------------------+--------------------------------------------------+
| pinch-gesture | Zoom in/out porportionally to gesture. |
+----------------------+--------------------------------------------------+
| <Modifier> + | Pan in direction of arrow key. Adding Ctrl |
| arrow key | reduces amount, adding Shift reduces more. |
+----------------------+--------------------------------------------------+
| p | Pan to position under cursor. |
+----------------------+--------------------------------------------------+
| z | Save current scale (see below for use). |
+----------------------+--------------------------------------------------+
| backquote (`) | Zoom to fit window and center. |
+----------------------+--------------------------------------------------+
| r | Pan to cursor and zoom to saved scale level |
| | (or 1:1 if no scale level saved). |
+----------------------+--------------------------------------------------+
| c | Set pan position to the center of the image. |
+----------------------+--------------------------------------------------+
| slash (/) | Set autocenter for new images to *override*. |
+----------------------+--------------------------------------------------+
| question (?) | Toggle autocenter for images to *on* or *off*. |
+----------------------+--------------------------------------------------+
| apostrophe (') | Set autozoom for new images to *override*. |
+----------------------+--------------------------------------------------+
| double quote (") | Toggle autozoom for new images to *on* or *off*. |
+----------------------+--------------------------------------------------+
.. _zoom_mode:
Zoom mode
=========
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| scroll-wheel | Zoom in or out. |
+----------------------+--------------------------------------------------+
| left-click | Set pan position, zoom in a step and warp cursor |
| | to pan position (if supported on backend). |
+----------------------+--------------------------------------------------+
| right-click | Set pan position, zoom out a step and warp |
| | cursor to pan position (if supported on backend).|
+----------------------+--------------------------------------------------+
| middle-drag | Pans freely over entire image in proportion |
| | to cursor position versus window. |
+----------------------+--------------------------------------------------+
| p, z, backquote, r, | (Same as for :ref:`Pan mode <pan_mode>`.) |
| c, arrow keys, pan | |
| and pinch gestures | |
+----------------------+--------------------------------------------------+
.. _dist_mode:
Dist mode
=========
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| scroll-wheel | Select distribution from linear, log, etc. |
+----------------------+--------------------------------------------------+
| b, up-arrow | Select prev distribution in list. |
+----------------------+--------------------------------------------------+
| n, down-arrow | Select next distribution in list. |
+----------------------+--------------------------------------------------+
| D | Reset color distribution algorithm to "linear". |
+----------------------+--------------------------------------------------+
.. _cuts_mode:
Cuts mode
=========
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| left-drag | Interactive cut *both* low and high levels |
| | (vertical cuts low, horizontal cuts high). |
+----------------------+--------------------------------------------------+
| Ctrl + left-drag | Interactive cut low level only |
| | (horizontal drag). |
+----------------------+--------------------------------------------------+
| Ctrl + pan gesture | Change cut high level up/down. |
+----------------------+--------------------------------------------------+
| Shift + left-drag | Interactive cut high level only |
| | (horizontal drag). |
+----------------------+--------------------------------------------------+
| Shift + pan gesture | Change cut low level up/down. |
+----------------------+--------------------------------------------------+
| scroll-wheel | Squeeze or stretch gap between cuts. |
| | Coarse (10%) adjustment in/out. |
+----------------------+--------------------------------------------------+
| Ctrl + scroll-wheel | Squeeze or stretch gap between cuts. |
| | Fine (1%) adjustment in/out. |
+----------------------+--------------------------------------------------+
| pinch gesture | Squeeze or stretch gap between cuts. |
+----------------------+--------------------------------------------------+
| a, right-click | Do an auto level to restore cuts. |
+----------------------+--------------------------------------------------+
| k | Set the high cut to the value under the cursor. |
+----------------------+--------------------------------------------------+
| l | Set the low cut to the value under the cursor. |
+----------------------+--------------------------------------------------+
| S | Set cuts to min/max values. |
+----------------------+--------------------------------------------------+
| A | Set cuts to 0/255 values (for 8bpp RGB images). |
+----------------------+--------------------------------------------------+
| b, up-arrow | Select prev auto cuts algorithm in list. |
+----------------------+--------------------------------------------------+
| n, down-arrow | Select next auto cuts algorithm in list. |
+----------------------+--------------------------------------------------+
| semicolon (;) | Set autocuts for new images to *override*. |
+----------------------+--------------------------------------------------+
| colon (:) | Toggle autocuts for new images to *on* or *off*. |
+----------------------+--------------------------------------------------+
.. _contrast_mode:
Contrast mode
=============
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| left-drag | Interactive shift/stretch colormap (AKA contrast |
| | and bias). Left/Right controls shift, Up/Down |
| | controls stretch. |
+----------------------+--------------------------------------------------+
| right-click | Restore the contrast (via colormap) to its |
| | original (unstretched, unshifted) state. |
+----------------------+--------------------------------------------------+
| scroll-wheel | Increase/decrease contrast. |
| | (add Ctrl to adjust it more finely). |
+----------------------+--------------------------------------------------+
| Shift + scroll-wheel | Increase/decrease brightness (bias). |
| | (add Ctrl to adjust it more finely). |
+----------------------+--------------------------------------------------+
| Ctrl + pan gesture | Increase/decrease contrast. |
+----------------------+--------------------------------------------------+
| Shift + pan gesture | Increase/decrease brightness (bias). |
+----------------------+--------------------------------------------------+
| T | Restore the contrast (via colormap) to its |
| | original (unstretched, unshifted) state. |
+----------------------+--------------------------------------------------+
.. _rotate_mode:
Rotate mode
===========
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| left-drag | Drag around center of window to rotate image. |
+----------------------+--------------------------------------------------+
| right-click | Restore rotation to 0 degrees (does not reset |
| | any flip/swap transformations). |
+----------------------+--------------------------------------------------+
| R | Restore rotation to 0 degrees and additionally |
| | undo any flip/swap transformations. |
+----------------------+--------------------------------------------------+
| Left bracket ([) | Toggle flip image in X. |
+----------------------+--------------------------------------------------+
| Left brace ({) | Reset to no flip of image in X. |
+----------------------+--------------------------------------------------+
| Right bracket (]) | Toggle flip image in Y. |
+----------------------+--------------------------------------------------+
| Right brace (}) | Reset to no flip image in Y. |
+----------------------+--------------------------------------------------+
| Backslash (\\) | Swap X and Y axes. |
+----------------------+--------------------------------------------------+
| Vertical bar (|) | Reset to no swap of X and Y axes. |
+----------------------+--------------------------------------------------+
| period (.) | Increment current rotation by 90 degrees. |
+----------------------+--------------------------------------------------+
| comma (,) | Decrement current rotation by 90 degrees. |
+----------------------+--------------------------------------------------+
| o | Orient image by transforms and rotation so that |
| | WCS indicates North=Up and East=Left. |
+----------------------+--------------------------------------------------+
| O | Orient image by transforms and rotation so that |
| | WCS indicates North=Up and East=Right. |
+----------------------+--------------------------------------------------+
.. _cmap_mode:
Cmap mode
=========
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| scroll | Select color map. |
+----------------------+--------------------------------------------------+
| left-drag | Rotate color map. |
+----------------------+--------------------------------------------------+
| right-click | Unrotate color map. |
+----------------------+--------------------------------------------------+
| b, up-arrow | Select prev color map in list. |
+----------------------+--------------------------------------------------+
| n, down-arrow | Select next color map in list. |
+----------------------+--------------------------------------------------+
| I | Toggle invert color map. |
+----------------------+--------------------------------------------------+
| r | Restore color map to unrotated, uninverted state.|
+----------------------+--------------------------------------------------+
| Ctrl + scroll | Select intensity map. |
+----------------------+--------------------------------------------------+
| j, left-arrow | Select prev intensity map in list. |
+----------------------+--------------------------------------------------+
| k, right-arrow | Select next intensity map in list. |
+----------------------+--------------------------------------------------+
| i | Restore intensity map to "ramp". |
+----------------------+--------------------------------------------------+
| c | Toggle a color bar overlay on the image. |
+----------------------+--------------------------------------------------+
| Y | Restore the color map to default ('gray'). |
+----------------------+--------------------------------------------------+
.. _naxis_mode:
Naxis mode
==========
.. note:: Naxis mode can be used when viewing data that has more than 2
dimensions (e.g., data cubes).
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| scroll | Select previous or next slice of current axis. |
+----------------------+--------------------------------------------------+
| Ctrl + scroll | Select previous or next axis as current axis. |
+----------------------+--------------------------------------------------+
| left drag | select slice as a function of percentage of |
| | cursor/window width. |
+----------------------+--------------------------------------------------+
| up-arrow | Select prev axis as current axis. |
+----------------------+--------------------------------------------------+
| down-arrow | Select next axis as current axis. |
+----------------------+--------------------------------------------------+
.. _plot_mode:
Plot mode
=========
Plot mode is only valid when the viewer is used with a ``PlotAide``
object to display a graph.
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| scroll | Zoom the X axis. |
| | (Sets `autoaxis_x` to `off`, if it was `on`) |
+----------------------+--------------------------------------------------+
| Ctrl + scroll | Zoom the Y axis. (Sets `autoaxis_y` to `off`) |
+----------------------+--------------------------------------------------+
| x | Toggle `autoaxis_x` between `on` and `off`. |
+----------------------+--------------------------------------------------+
| p | Toggle `autoaxis_x` between `pan` and `off`. |
+----------------------+--------------------------------------------------+
| y | Toggle `autoaxis_y` between `on` and `off`. |
+----------------------+--------------------------------------------------+
| v | Toggle `autoaxis_y` between `vis` and `off`. |
+----------------------+--------------------------------------------------+
The graph can be flipped in X or Y and the axes swapped, using the keystroke
commands found in the transform section above (:ref:`transform_commands`).
To understand the role of the `autoaxis_x` and `autoaxis_y` settings, please
see the chapter on plots (:ref:`ch-plots`).
.. _autozoom_setting:
Autozoom setting
================
The "autozoom" setting can be set to one of the following: "on", "override",
"once" or "off". This affects the behavior of the viewer when changing to a
new image (when done in the typical way) as follows:
* `on`: the image will be scaled to fit the window
* `override`: like `on`, except that once the zoom/scale is changed by the
user manually it turns the setting to `off`
* `once`: like `on`, except that the setting is turned to `off` after the
first image
* `off`: an image scaled to the current viewer setting
(In the :ref:`Reference Viewer <reference_viewer>`, this is set under the
"Zoom New" setting in the channel preferences.)
.. _autocenter_setting:
Autocenter setting
==================
The "autocenter" setting can be set to one of the following: "on", "override",
"once" or "off". This affects the behavior of the viewer when changing to a
new image (when done in the typical way) as follows:
* `on`: the pan position will be set to the center of the image
* `override`: like `on`, except that once the pan position is changed by the
user manually it turns the setting to `off`
* `once`: like `on`, except that the setting is turned to `off` after the
first image
* `off`: the pan position is taken from the current viewer setting
(In the :ref:`Reference Viewer <reference_viewer>`, this is set under the
"Center New" setting in the channel preferences.)
.. _autocuts_setting:
Autocuts setting
================
The "autocuts" setting can be set to one of following: "on", "override",
"once" or "off". This affects the behavior of the viewer when changing to a
new image (when done in the typical way) as follows:
* `on`: the cut levels for the image will be calculated and set according
to the autocuts algorithm setting
* `override`: like `on`, except that once the cut levels are changed by the
user manually it turns the setting to `off`
* `once`: like `on`, except that the setting is turned to `off` after the
first image
* `off`: the cut levels are applied from the current viewer setting
(In the ref:`Reference Viewer <reference_viewer>`, this is set under the
"Cut New" setting in the channel preferences.)
.. _reference_viewer:
Reference Viewer Only
=====================
+----------------------+--------------------------------------------------+
| Commmand | Description |
+======================+==================================================+
| H | Raise **Header** tab (if Header plugin has been |
| | started). |
+----------------------+--------------------------------------------------+
| Z | Raise **Zoom** tab (if Zoom plugin has been |
| | started). |
+----------------------+--------------------------------------------------+
| D | Raise **Dialogs** tab. |
+----------------------+--------------------------------------------------+
| C | Raise **Contents** tab. |
+----------------------+--------------------------------------------------+
| less than (<) | Toggle collapse left pane. |
+----------------------+--------------------------------------------------+
| greater than (>) | Toggle collapse right pane. |
+----------------------+--------------------------------------------------+
| f | Toggle full screen. |
+----------------------+--------------------------------------------------+
| F | Panoramic full screen. |
+----------------------+--------------------------------------------------+
| h | Pop up a quick help tab for the current mode. |
+----------------------+--------------------------------------------------+
| m | Maximize window. |
+----------------------+--------------------------------------------------+
| J | Cycle workspace type (tabs/mdi/stack/grid). |
| | Note that "mdi" type is not supported on all |
| | platforms. |
+----------------------+--------------------------------------------------+
| k | Add a channel with a generic name. |
+----------------------+--------------------------------------------------+
| Left, Right | Previous/Next channel. |
| (arrow keys) | |
+----------------------+--------------------------------------------------+
| Up, Down | Previous/Next image in channel. |
| (arrow keys) | |
+----------------------+--------------------------------------------------+
.. note:: If there are one or more plugins active, additional mouse
or keyboard bindings may be present. In general, the left
mouse button is used to select, pick or move, and the right
mouse button is used to draw a shape for the operation.
On the Mac, Ctrl + mouse button can also be used to draw
or right-click. You can also invoke draw mode as described
above in the section on modes.
|
