Thumbs plugin

The Thumbs plugin provides a thumbnail index of all images viewed since the program was started.

Plugin Type: Global

Thumbs is a global plugin. Only one instance can be opened.


By default, Thumbs appear in cronological viewing history, with the newest images at the bottom and the oldest at the top. The sorting can be made alphanumeric by a setting in the “plugin_Thumbs.cfg” configuration file.

Clicking on a thumbnail navigates you directly to that image in the associated channel. Hovering the cursor over a thumbnail will show a tool tip that contains a couple of useful pieces of metadata from the image.

The “Auto Scroll” checkbox, if checked, will cause the Thumbs pan to scroll to the active image.

This plugin is not usually configured to be closeable, but the user can make it so by setting the “closeable” setting to True in the configuration file–then Close and Help buttons will be added to the bottom of the UI.

Excluding images from Thumbs


This also controls the behavior of Contents.

Although the default behavior is for every image that is loaded into the reference viewer to show up in Thumbs, there may be cases where this is undesirable (e.g., when there are many images being loaded at a periodic rate by some automated process). In such cases there are two mechanisms for suppressing certain images from showing up in Thumbs:

  • Assigning the “genthumb” setting to False in a channel’s settings (for example from the Preferences plugin, under the “General” settings) will exclude the channel itself and any of its images.

  • Setting the “nothumb” keyword in the metadata of an image wrapper (not the FITS header, but by e.g., image.set(nothumb=True)) will exclude that particular image from Thumbs, even if the “genthumb” setting is True for that channel.

It is customizable using ~/.ginga/plugin_Thumbs.cfg, where ~ is your HOME directory:

# Thumbs plugin preferences file
# Place this in file under ~/.ginga with the name "plugin_Thumbs.cfg"

# If you revisit the same directories frequently
# caching thumbs saves a lot of time when they need to be regenerated
cache_thumbs = False

# cache location-- "local" puts them in a .thumbs subfolder, otherwise
# they are cached in ~/.ginga/thumbs
cache_location = 'local'

# Scroll the pane automatically when new thumbnails arrive
auto_scroll = True

# Keywords to extract and show if we mouse over the thumbnail
tt_keywords = ['OBJECT', 'FRAMEID', 'UT', 'DATE-OBS']

# Mandatory unique image identifier in tooltip
mouseover_name_key = 'NAME'

# How many seconds to wait after an image is altered to begin trying
# to rebuild a matching thumb.  Usually a few seconds is good in case
# there is ongoing adjustment of the image
rebuild_wait = 0.5

# Max length of thumb on the long side
thumb_length = 180

# Separation between thumbs in pixels
thumb_hsep = 15
thumb_vsep = 15

# Sort the thumbs alphabetically: 'alpha' or None
sort_order = None

# Thumbnail label length in num of characters (None = no limit)
label_length = 25

# Cut off long label ('left', 'right', or None)
label_cutoff = 'right'

# Option to highlight images that are displayed in channels.
# If set to True this option will only highlight the image that is in the
# channel with the keyboard focus
highlight_tracks_keyboard_focus = True

# Highlighted label colors
label_bg_color = 'lightgreen'
label_font_color = 'white'

label_font_size = 10

# Load visible thumbs in the background to replace placeholder icons
autoload_visible_thumbs = True

# Length of time to wait after scrolling to begin autoloading
autoload_interval = 1.0

# list of attributes to transfer from the channel viewer to the
# thumbnail generator if the channel has an image in it
transfer_attrs = ['transforms', 'cutlevels', 'rgbmap']

# Add a close button to this plugin, so that it can be stopped
closeable = False