Command
Line Options
DS9 will process each command
line option, one at a time, as the last step in the initialization process.
Therefore, it is possible to use command line options as a little script.
For example, the following command line option is used:
$ds9 -tile foo.fits -cmap Heat -zscale bar.fits -cmap I8
First DS9 is put in tile mode, then foo.fits
is loaded. Then the colormap for foo.fits
is changed to Heat. Next,
a new frame is created and bar.fits
is loaded. And finally, the colormap for bar.fits
is changed to I8.
about
align
analysis
array
bin
blink
cmap
contour
coords
dss
exit
fifo
fifo_only
geometry
grid
help
histequ
iconify
inet_only
invert
linear
log
lower
minmax
minmaxmode
minmaxsample
mode
mosaic
mosaicimage
orient
pagesetup
pan
pixeltable
port
port_only
print
private
raise
region
rotate
saveas
scale
shm
single
squared
sqrt
source
tile
title
unix
unix_only
url
version
view
visual
wcs
wcsformat
zmax
zscale
zoom
about
Get DS9 credits.
Syntax:
-about
Example:
$ds9 -about
align
Aligns current frame to WCS equatorial coordinate
axis, if present.
Syntax:
-align
Example:
$ds9 -align
analysis
Load analysis file.
Syntax:
-analysis filename
Example:
$ds9 -analysis my.analysis
array
Load an array.
Syntax:
-array filename
Example:
$ds9 -array foo.arr[dim=512,bitpix=-32]
bin
Controls binning factor, binning buffer size,
and binning function for binning FITS bin tables.
Syntax:
-bin [about <x> <y>]
[buffersize <value>]
[cols <x> <y>]
[factor <value>]
[filter <string>]
[function average|sum]
[to fit]
Example:
$ds9 -bin about 4096 4096
$ds9 -bin buffersize 512
$ds9 -bin cols detx dety
$ds9 -bin factor 4
$ds9 -bin filter "pha>5"
$ds9 -bin function sum
$ds9 -bin to fit
blink
Activates Blink Mode.
Syntax:
-blink
Example:
$ds9 -blink
cmap
Controls the colormap for the current frame.
The colormap name is not case sensitive. A valid contrast value is
from 0 to 10 and bias value from 0 to 1.
Syntax:
-cmap [<colormap>]
[file <filename>]
[invert yes|no]
[value <contrast> <bias>]
Example:
$ds9 -cmap Heat
$ds9 -cmap file foo.sao
$ds9 -cmap invert yes
$ds9 -cmap value 5 .5
contour
Controls contours in the current frame.
Syntax:
contour [yes|no]
[copy]
[paste <coordinate
system> <color> <width>]
[load filename <coordinate
system> <color <width>]
[save filename <coordinate
system>]
Example:
$ds9 -contour
$ds9 -contour yes
$ds9 -contour copy
$ds9 -contour paste fk4 red 2
$ds9 -contour load foo.con fk5 yellow 2
$ds9 -contour save foo.con fk5
coords
Toggles specified coordinate system display
in information panel.
Syntax:
-coords [wcs|detector|amplifier|physical|image] [yes|no]
Example:
$ds9 -coords physical yes wcs no
dss
Support for Digital Sky Survey. The first
three options will download an image based on the name or specified fk5
coordinate. The remaining options are used to configure downloads.
Syntax:
-dss [<object>]
[name <object>]
[coord <ra> <dec>] # in fk5
[server sao|stsci|eso]
[survey dss|dss2red|dss2blue]
[size <width> <height>] # in arcmin
Example:
$ds9 -dss m31
$ds9 -dss name m31
$ds9 -dss coord 00:42:44.404 +41:16:08.78
$ds9 -dss server eso
$ds9 -dss survey dss2red
$ds9 -dss size 10 10
exit
quit
Quits DS9.
Syntax:
-exit
-quit
Example:
$ds9 -exit
fifo
Set the name of the IRAF input and output
fifos. The default is /dev/imt1.
These fifos are used by IRAF to communicate with DS9.
Syntax:
-fifo name
Example:
$ds9 -fifo /dev/imt1
fifo_only
Only use IRAF input and output fifos. Same
as -port 0 -unix none.
Syntax:
-fifo_only
Example:
$ds9 -fifo_only
geometry
Define the initial window geometry. see X(1).
Syntax:
-geometry value
Example:
$ds9 -geometry 640x480
grid
Controls coordinate grid.
Syntax:
-grid [yes|no]
[load <filename>]
[save <filename>]
Example:
$ds9 -grid
$ds9 -grid yes
$ds9 -grid load foo.grd
$ds9 -grid save foo.grd
help
Displays list of Command Line Options. Users
of csh and tcsh may have to quote.
Syntax:
-?
-- -help
Example:
$ds9 -- -help
$ds9 '-?'
histequ
Select histogram equalization scale for current
frame.
Syntax:
-histequ
Example:
$ds9 -histequ
iconify
DS9 is iconified at startup.
Syntax:
-iconify
Example:
$ds9 -iconify
invert
Invert Colormap.
Syntax:
-invert
Example:
$ds9 -invert
linear
Select Linear scale for current frame.
Syntax:
-linear
Example:
$ds9 -linear
log
Select LOG scale for current frame. This is
the same algorithm as used in IRAF.
Syntax:
-log
Example:
$ds9 -log
lower
Lower ds9 in the window stacking order.
Syntax:
-lower
Example:
$ds9 -lower
minmax
This is how DS9 determines the min and
max data values from the data. SCAN
will scan all data. SAMPLE
will sample the data every n samples. DATAMIN
and IRAFMIN will use the values
of the keywords if present. In general, it is recommended to use SCAN
unless your computer is slow or your data files are very large. Select
the increment interval for determining the min and max data values
during sampling. The larger the interval, the quicker the process.
Syntax:
-minmax []
[scan|sample|datamin|irafmin]
[mode scan|sample|datamin|irafmin]
[interval <value>]
Example:
$ds9 -minmax
$ds9 -minmax scan
$ds9 -minmax mode sample
$ds9 -minmax interval 10
mode
Select the current mode.
Syntax:
-mode [pointer|crosshair|colorbar|pan|zoom|rotate]
Example:
$ds9 -mode crosshair
mosaic
Load FITS mosaic image segment.
Syntax:
-mosaic filename
Example:
$ds9 -mosaic amp1.fits amp2.fits
mosaicimage
Load entire FITS Mosaic image composed of
multiple extensions in one FITS file. All extensions that are FITS
Images and are valid FITS Mosaic Images will be loaded.
Syntax:
-mosaicimage filename
Example:
$ds9 -mosaicimage fourshooter.fits
nameserver
Support Name Server functions. Coordinates
are in fk5.
Syntax:
-nameserver [<object>]
[name <object>]
[server ned-sao|ned-eso|simbad-sao|simbad-eso]
[format degrees|sexagesimal]
Example:
$ds9 -nameserver m31
$ds9 -nameserver name m31
$ds9 -nameserver server ned-sao
$ds9 -nameserver format sexagesimal
orient
Controls the orientation of the current frame.
Syntax:
-orient [none|x|y|xy]
Example:
$ds9 -orient xy
pagesetup
Controls Page Setup options.
Syntax:
-pagesetup [orientation portrait|landscape]
[pagescale scaled|fixed]
[pagesize letter|legal|tabloid|poster|a4]
Example:
$ds9 -pagesetup orientation portrait
$ds9 -pagesetup pagescale scaled
$ds9 -pagesetup pagesize poster
pan
Controls the current image cursor location
for the current frame.
Syntax:
-pan [x y image|physical|fk4|fk5|icrs|galactic|ecliptic|linear][pixels|degrees|sexagesimal]
[to x y image|physical|fk4|fk5|icrs|galactic|ecliptic|linear]pixels|degrees|sexagesimal]
Example:
$ds9 -pan 200 200 image
$ds9 -pan to 400 400 physical
$ds9 -pan to 13:29:55 47:11:50 fk5
pixeltable
nopixeltable
Display/Hide pixel table
Syntax:
-pixeltable
-nopixeltable
Example:
$ds9 -pixeltable
port
Set the IRAF port number, used by IRAF to
communicate with DS9. The default is 5137, the standard IRAF port used
by ximtool.
Syntax:
-port number
Example:
$ds9 -port 5137
port_only
inet_only
Only use the IRAF port number. This is the
same as -fifo none -unix none.
Syntax:
-port_only
Example:
$ds9 -port_only
print
Controls printing. Use print option
to set printing options. Use print
to actually print.
Syntax:
-print [destination printer|file]
[command <command>]
[filename <filename>]
[palette rgb|cmyk|gray]
[level 1|2]
[interpolate yes|no]
[resolution 53|72|75|150|300|600]
Example:
$ds9 -print
$ds9 -print destination file
$ds9 -print command 'gv -'
$ds9 -print filename foo.ps
$ds9 -print palette cmyk
$ds9 -print level 2
$ds9 -print interpolate no
$ds9 -print resolution 75
private
use private colormap, valid for pseudocolor
8 mode.
Syntax:
-private
Example:
$ds9 -private
raise
Raise ds9 in the window stacking order.
Syntax:
-raise
Example:
$ds9 -raise
region
Loads a Regions File into the current frame.
Syntax: -region filename
Example: $ds9 -region catalog.reg
rotate
Controls the rotation angle (in degrees) of
the current frame.
Syntax:
-rotate [<value>]
[to <value>]
Example:
$ds9 -rotate 45
$ds9 -rotate to 30
saveas
Save image, with regions, contours and coordinate
grids as raster image. Currently, the follow formats are supported: JPEG,
TIFF, PGN, PPM. Please Note: Ghostscript
is required for support of this feature. gs
must be in your path for this function to work properly. If DS9 is unable
to locate gs, an error message
will be generated.
Syntax:
-saveas [jpeg|tiff|png|ppm <filename>]
Example:
$ds9 -saveas jpeg foo.jpg
scale
Controls the limits, color scale distribution,
and use of DATASEC keyword.
Syntax:
-scale [linear|log|squared|sqrt|histequ]
[datasec yes|no]
[limits <minvalue> <maxvalue>]
[mode minmax|<value>|zscale|zmax]
[scope local|global]
Example:
$ds9 -scale datasec yes
$ds9 -scale histequ
$ds9 -scale limits 1 100
$ds9 -scale mode zscale
$ds9 -scale mode 99.5
$ds9 -scale scope local
shm
Load a shared memory segment into the current
frame.
id is the shared memory
id,
size is the size of the
segment in bytes.
Syntax:
-shm [<key> <size> [<filename>]]
[key <id> <size> [<filename>]]
[shmid <id> <size> [<filename>]]
[mosaicimage [key|shmid] <id> <size>
[<filename>]]
[mosaic [key|shmid] <id> <size>
[<filename>]]
[array [key|shmid] <id> <size> [xdim=<x>,ydim=<y>|dim=<dim>],bitpix=<b>,[skip=<s>]]
Example:
$ds9 -shm 102 8640
$ds9 -shm key 102 8640
$ds9 -shm shmid 102 8640 foo[2]
$ds9 -shm mosaicimage key 100 10240 foo
$ds9 -shm mosaic key 100 10240 foo
$ds9 -shm array shmid 102 8640 [dim=32,bitpix=-32]
single
Set display mode to single.
Syntax:
-single
Example:
$ds9 -single
squared
Select Squared scale for current frame.
Syntax:
-squared
Example:
$ds9 -squared
sqrt
Select Square Root scale for current frame.
Syntax:
-sqrt
Example:
$ds9 -sqrt
source
Sources a valid TCL file.
Syntax:
-source filename
Example:
$ds9 -source extensions.tcl
tile
Controls the tile display mode.
Syntax:
-tile [yes|no]
[mode grid|column|row]
[grid]
[grid mode [automatic|manual]]
[grid layout <row> <col>]
[grid gap <pixels>]
[row]
[column]
Example:
$ds9 -tile
$ds9 -tile yes
$ds9 -tile mode row
$ds9 -tile grid
$ds9 -tile grid mode manual
$ds9 -tile grid layout 5 5
$ds9 -tile grid gap 10
$ds9 -tile row
$ds9 -tile column
title
Changes the display window title to the specified
name.
Syntax:
-title name
Example:
$ds9 -title Voyager
unix
Set the IRAF unix socket name, used by IRAF
to communicate with DS9. The default is /tmp/.IMT%d,
so that the standard IRAF unix socket is defined.
Syntax:
-unix name
Example:
$ds9 -unix "/tmp/.IMT%d"
unix_only
Only use the IRAF unix socket name. This is
the same as -fifo none -port 0.
Syntax:
-unix_only
Example:
$ds9 -unix_only
url
Load FITS file from specified url.
Syntax:
-url <url>
Example:
$ds9 -url 'ftp://legacy.gsfc.nasa.gov/rosat/data/hri/img.fits'
version
Returns the current version of DS9.
Syntax:
-version
Example:
$ds9 -version
view
Controls the GUI.
Syntax:
-view [info yes|no]
[panner yes|no]
[magnifier yes|no]
[buttons yes|no]
[colorbar yes|no]
[horzgraph yes|no]
[vertgraph yes|no]
[wcs yes|no]
[detector yes|no]
[amplifier yes|no]
[physical yes|no]
[image yes|no]
Example:
$ds9 -view info no
visual
Force DS9 to use the specified color visual.
This argument MUST be the first argument listed. Requires the visual be
available.
Syntax:
-visual [pseudocolor|pseudocolor8|truecolor|truecolor8|truecolor16|truecolor24]
Example:
$ds9 -visual truecolor24
wcs
Selects WCS display coordinate system.
Syntax:
-wcs [fk4|fk5|galactic|ecliptic]
Example:
$ds9 -wcs fk4
wcsformat
Toggles WCS display format.
Syntax:
-wcsformat [degrees|sexagesimal]
Example:
$ds9 -wcsformat sexagesimal
zmax
Set Scale Limits based on the IRAF
algorithm and maximum data value.
Syntax:
-zmax
Example:
$ds9 -zmax
zscale
Set Scale Limits based on the IRAF
algorithm.
Syntax:
-zscale
Example:
$ds9 -zscale
zoom
Controls the current zoom value for the current
frame.
Syntax:
-zoom [<value>]
[to <value>]
[to fit]
Example:
$ds9 -zoom 2
$ds9 -zoom to 4
$ds9 -zoom to fit