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
|
.. _ginga-faq:
++++
FAQs
++++
This section contains some frequently asked questions (FAQs) regarding
Ginga usage.
---------
Platforms
---------
Does Ginga run on Mac/Windows/Linux/XYZ?
----------------------------------------
Ginga is written entirely in the Python programming language, and uses only
supporting Python packages. As long as a platform supports Python
and the necessary packages, it can run some version of Ginga. On recent
Linux, Mac and Windows versions, all of these packages are available.
Does Ginga work with Python 3?
------------------------------
Yes, but only Python 3.7 or later. Just install with Python 3.
Of course, you need all the supporting modules for Python 3 (NumPy, SciPy, Qt 5, etc.).
Does Ginga work with Python 2?
------------------------------
No. If you absolutely have to use Python 2, please downgrade to
Ginga 2.x series.
--------
Toolkits
--------
What GUI toolkit does Ginga use?
--------------------------------
It depends what exactly you want to run. Ginga is both a toolkit for
building viewers and also includes a "reference viewer". The example
programs currently support Qt, GTK, Tk, matplotlib and web browser via
HTML5 canvas. Some other toolkits are being worked on and may be
partially supported.
The full reference viewer currently supports Qt (PyQt5, PyQt6, PySide2,
PySide6) and Gtk (ver 3, 4). The difference is explained here, in Section
:ref:`ch-programming-ginga`.
----------------
Control Bindings
----------------
Can I get DS9-like user interface mappings?
-------------------------------------------
Save the file called `bindings.cfg.ds9
<https://raw.github.com/ejeschke/ginga/main/ginga/examples/bindings/bindings.cfg.ds9>`_
and drop it in your ``$HOME/.ginga`` folder as "bindings.cfg".
Then restart Ginga.
Can I customize the user interface mappings?
--------------------------------------------
Yes. There is more information in the :ref:`sec-bindings` section.
Where can I find a quick reference of the bindings?
---------------------------------------------------
See Section :ref:`ginga-quick-reference`.
-------------
Miscellaneous
-------------
Does Ginga work with SAMP?
--------------------------
Yes. See Section :ref:`sec-plugins-SAMP`.
Is it possible to control Ginga remotely?
-----------------------------------------
Yes. See Section :ref:`sec-plugins-RC`.
When are you going to add the XYZ feature that DS9 has?
-------------------------------------------------------
Maybe never. The Ginga package design goal was never to replace DS9,
but to provide a full featured Python FITS widget that we could use to
build directly in Python. This is clearly seen if you look at the
example programs in ``examples/*/example*.py``. The idea was to make it
easy for someone to build any kind of custom viewer by having a
full-featured widget to build on.
That said, we did write a reference viewer because we needed something
with many of the convenience features of a modern FITS viewer. DS9 is
almost the size of a small OS, however, and I'm not sure it is wise to
try to match it feature for feature. Instead, since Ginga is
plugin-based, you can write plugins to give you the features you need.
DS9 is a "everything including kitchen sink" kind of viewer, whereas
ginga reference viewer is more like a "take what you need from the
pantry and whip it up" type viewer.
Please send a pull request!
Can I get Ginga reference viewer to save its size and position?
---------------------------------------------------------------
Yes. Add the line ``"save_layout = True"`` to your ``~/.ginga/general.cfg``
file.
If the file does not exist, create it, or copy the one from
``ginga/examples/configs/general.cfg``.
-----------------------
World Coordinate System
-----------------------
What library are you using for WCS?
-----------------------------------
We are lucky to have several possible choices for a Python WCS package
compatible with Ginga:
`AstLib <http://astlib.sourceforge.net/>`_,
`Kapteyn <http://www.astro.rug.nl/software/kapteyn/>`_,
`Starlink <https://github.com/timj/starlink-pyast>`_, and
:ref:`Astropy WCS <astropy:astropy-wcs>`.
Kapteyn and Astropy wrap Mark Calabretta's "WCSLIB", AstLib wraps
Jessica Mink's "wcstools", and I'm not sure what Starlink uses.
Note that AstLib and Starlink require Astropy to be
installed in order to create a WCS object from a FITS header.
To force the use of a particular one add this to your "general.cfg"
in ``$HOME/.ginga``::
WCSpkg = 'package'
Replace ``'package'`` with one of ``'Astropy'``, ``'Kapteyn'``, ``'Starlink'``,
``'astlib'``, or ``'choose'``. If you pick ``'choose'``, Ginga will try to
pick one for you.
How easy is it for Ginga to support a custom WCS?
-------------------------------------------------
Pretty easy. See Section :ref:`sec-custom-wcs`.
--------------------
I/O and File Formats
--------------------
What library are you using for FITS I/O?
----------------------------------------
There are two possible choices for a Python FITS file reading package
compatible with Ginga:
:ref:`Astropy FITS <astropy:astropy-io-fits>` and
`fitsio <https://github.com/esheldon/fitsio>`_.
Both are originally based on the CFITSIO library (although Astropy's
version uses very little of it any more, while ``fitsio`` is still
tracking the current version).
To force the use of a particular one add this to your "general.cfg"
in ``$HOME/.ginga``:
FITSpkg = 'package'
Replace ``'package'`` with one of ``'Astropy'``, ``'fitsio'``, or ``'choose'``.
If you pick ``'choose'``, Ginga will try to pick one for you.
How easy is it for Ginga to support a new file formats besides FITS?
--------------------------------------------------------------------
Pretty easy. See Section :ref:`sec-custom-io`.
--------------------------
Problems Displaying Images
--------------------------
Nothing changes in the image when I change settings under "Preferences".
.. note:: The Preferences plugin sets the preferences on a *per-channel*
basis. Make sure the channel you are looking at has the same
name as the prefix for the preferences. For example: "Image"
and "Image: Preferences" or "Image1" and "Image1: Preferences".
The preferences for a given channel are copied from the
default "Image" channel until they are explicitly set and
saved using this plugin. So if you want preferences that
follow around from channel to channel, save them as
preferences for "Image" and any new channels created will get
those as well, unless you have saved different ones under
those channel names.
Nothing changes in the image when I change the "Auto Cuts" settings under
Preferences. I've checked that I'm adjusting preferences for the same
channel that I'm viewing.
.. note:: What is the setting for "Cut New" under the New Images section
in Preferences for this channel?
If that setting is "Off" then you have elected not to have
Ginga apply Auto Levels when an image is loaded in that
channel. Press 'a' in the image window to force an auto cut
levels and it will use the new settings.
No image shows in the display, and I get an error in the terminal about
histogram and keyword "density".
.. note:: You need a newer version of NumPy.
I recommend getting NumPy v1.14 or later.
|
