SaveImage (Save File)
Save images to output files.
Plugin Type: Global
SaveImage
is a global plugin. Only one instance can be opened.
Usage
This global plugin is used to save any changes made in Ginga back to output
images. For example, a mosaic image that was created by the Mosaic
plugin. Currently, only FITS images (single or multiple extensions) are
supported.
Given the output directory (e.g., /mypath/outputs/
), a suffix
(e.g., ginga
), an image channel (Image
), and a selected image
(e.g., image1.fits
), the output file will be
/mypath/outputs/image1_ginga_Image.fits
. Inclusion of the channel name is
optional and can be omitted using plugin configuration file,
plugin_SaveImage.cfg
.
The modified extension(s) will have new header or data extracted from
Ginga, while those not modified will remain untouched. Relevant change
log entries from the ChangeHistory
global plugin will be inserted into
the history of its PRIMARY
header.
Note
This plugin uses the module astropy.io.fits
to write the output
images, regardless of what is chosen for FITSpkg
in the
general.cfg
configuration file.
It is customizable using ~/.ginga/plugin_SaveImage.cfg
, where ~
is your HOME directory:
#
# SaveImage plugin preferences file
#
# Place this in file under ~/.ginga with the name "plugin_SaveImage.cfg"
# Default output parameters. Can also be changed in the GUI.
output_directory = '.'
output_suffix = 'ginga'
# Include channel name in the suffix.
# If False, only output_suffix is used regardless of channel.
include_chname = True
# Clobber existing output files or not
clobber = False
# Only list modified images from the channel
modified_only = True
# Maximum mosaic size to allow for writing out.
# This is useful to prevent super large mosaic from being written.
# Default is 10k x 10k
max_mosaic_size = 1e8
# Maximum number of rows that will turn off auto column resizing (for speed)
max_rows_for_col_resize = 5000