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 and the scale changed to zscale. Next, bar.fits is loaded and the colormap for bar.fits is changed to I8.
- 2mass
- about
- analysis
- array
- bin
- blink
- blue
- catalog
- cd
- cmap
- colorbar
- console
- contour
- crosshair
- cursor
- datacube
- dsssao
- dsseso
- dssstsci
- exit
- fifo
- fifo_only
- file
- first
- fits
- sfits
- frame
- geometry
- green
- grid
- header
- height
- help
- histequ
- iconify
- inet_only
- invert
- iis
- language
- linear
- lock
- log
- lower
- mask
- match
- medatacube
- minmax
- mode
- mosaicimage
- mosaic
- multiframe
- smosaic
- msg
- nameserver
- nvss
- orient
- pagesetup
- pan
- pixeltable
- plot
- prefs
- preserve
- private
- port
- port_only
- pow
- quit
- raise
- regions
- rgb
- rgbarray
- rgbcube
- srgbcube
- rgbimage
- red
- rotate
- samp
- saveimage
- savefits
- savempeg
- scale
- shm
- single
- skyview
- sleep
- smooth
- squared
- sqrt
- source
- tcl
- tile
- title
- unix
- unix_only
- update
- url
- version
- view
- visual
- vo
- wcs
- web
- width
- xpa
- zmax
- zscale
- zoom
2mass
Support for 2MASS Digital Sky Survey.
Syntax:
-2mass [<object>]
[name <object>]
[coord <ra> <dec> degrees|sexagesimal] # in wcs fk5
[size <width> <height> degrees|arcmin|arcsec]
[save yes|no]
[frame new|current]
[update frame|crosshair]
[survey j|h|k]
Example:
$ds9 -2mass m31
$ds9 -2mass name m31
$ds9 -2mass coord 00:42:44.404 +41:16:08.78 sexagesimal
$ds9 -2mass size 60 60 arcmin
$ds9 -2mass save yes
$ds9 -2mass frame current
$ds9 -2mass update frame
$ds9 -2mass survey j
about
Get DS9 credits.
Syntax:
-about
Example:
$ds9 -aboutanalysis
Control external analysis tasks. Tasks are numbered as they are loaded, starting with 0. Can also be used to display a message and display text in the text dialog window.
Syntax:
-analysis [<task number>]
[<filename>]
[load <filename>]
[clear]
[clear][load <filename>]
[message ok|okcancel|yesno <message>]
[entry <message>]
[text]
Example:
$ds9 -analysis 0 # invoke first analysis task
$ds9 -analysis my.ans
$ds9 -analysis load my.ans
$ds9 -analysis clear
$ds9 -analysis clear load my.ans
$ds9 -analysis message '{This is a message}'
$ds9 -analysis message okcancel '{This is a message}'
$ds9 -analysis text '{This is text}'array
Load an array.
Syntax:
-array <filename>[[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,
arch=[littleendian|bigendian]]
Example:
$ds9 -array bar.arr[xdim=512,ydim=512,zdim=1,bitpix=16] # load 512x512 short
$ds9 -array bar.arr[dim=256,bitpix=-32,skip=4] # load 256x256 float with 4 byte head
$ds9 -array bar.arr[dim=512,bitpix=32,arch=littleendian] # load 512x512 long, intelbin
Controls binning factor, binning buffer size, and binning function for binning FITS bin tables.
Syntax:
-bin [about <x> <y>]
[about center]
[buffersize <value>]
[cols <x> <y>]
[colsz <x> <y> <z>]
[factor <value> [<value>]]
[depth <value>]
[filter <string>]
[function average|sum]
[to fit]
Example:
$ds9 -bin about 4096 4096
$ds9 -bin about center
$ds9 -bin buffersize 512
$ds9 -bin cols detx dety
$ds9 -bin colsz detx dety time
$ds9 -bin factor 4
$ds9 -bin factor 4 2
$ds9 -bin depth 10
$ds9 -bin filter '{pha > 5}'
$ds9 -bin filter ''
$ds9 -bin function sum
$ds9 -bin to fit
blink
Blink mode parameters. Interval is in seconds.
Syntax:
-blink []
[yes|no]
[interval <value>]
Example:
$ds9 -blink
$ds9 -blink yes
$ds9 -blink interval 1
blue
For RGB frames, sets the current color channel to blue.
Syntax:
-blue
Example:
$ds9 -blue foo.fits
catalog
Support for catalogs.
cat
Syntax:
-catalog [ned|simbad|denis]
[ascss|cmc|gsc1|gsc2|gsc3|ac|nomad|ppmx|sao|sdss5|sdss6|tycho|ua2|ub1|ucac2]
[2mass|iras]
[csc|xmm|rosat]
[first|nvss]
[chandralog|cfhtlog|esolog|stlog|xmmlog]
[cds <catalogname>]
[cds <catalogid>]
[load <filename>]
[load [xml|sb|tsv] <filename>]
[<catname>] [samp]
[<catname>] [samp broadcast]
[<catname>] [samp send <application>]
[<catname>] [name <object>]
[<catname>] [coordinate <ra> <dec> <coordinate system>]
[<catname>] [size <width> <height> degrees|arcmin|arcsec]
[<catname>] [save <filename>]
[<catname>] [save [xml|sb|tsv] <filename>]
[<catname>] [filter <string>]
[<catname>] [filter load <filename>]
[<catname>] [clear]
[<catname>] [retrieve]
[<catname>] [cancel]
[<catname>] [print]
[<catname>] [close]
[<catname>] [server cds|sao|cadc|adac|iucaa|bejing|cambridge|ukirt]
[<catname>] [symbol [#] condition|shape|color|text|size|size2|units|angle <value>]
[<catname>] [symbol shape {circle point}|{box point}|{diamond point}|
{cross point}|{x point}|{arrow point}|{boxcircle point}|
circle|ellipse|box|text]
[<catname>] [symbol add| [#] remove]
[<catname>] [symbol save|load <filename>]
[<catname>] [sort <columnname> incr|decr]
[<catname>] [maxrows <number>]
[<catname>] [allrows]
[<catname>] [allcols]
[<catname>] [ra <columnname>]
[<catname>] [dec <columnname>]
[<catname>] [show|hide]
[<catname>] [edit yes|no]
[<catname>] [panto yes|no]
Example:
$ds9 -catalog 2mass
$ds9 -catalog cds 2mass
$ds9 -catalog cds "I/252"
$ds9 -catalog load foo.cat
$ds9 -catalog load xml foo.xml
$ds9 -catalog samp broadcast
$ds9 -catalog samp send aladin
$ds9 -catalog cat2mass symbol color red
$ds9 -catalog name m51
$ds9 -catalog coordinate 202.48 47.21 fk5
$ds9 -catalog size 22 22 arcmin
$ds9 -catalog save bar.cat
$ds9 -catalog save xml bar.xml
$ds9 -catalog filter "\$Jmag>10"
$ds9 -catalog filter load foo.flt
$ds9 -catalog clear
$ds9 -catalog retrieve
$ds9 -catalog cancel
$ds9 -catalog print
$ds9 -catalog close
$ds9 -catalog server sao
$ds9 -catalog symbol condition "\$Jmag>15"
$ds9 -catalog symbol 2 shape "boxcircle point"
$ds9 -catalog symbol color red
$ds9 -catalog symbol add
$ds9 -catalog symbol 2 remove
$ds9 -catalog symbol load foo.sym
$ds9 -catalog symbol save bar.sym
$ds9 -catalog sort "Jmag" incr
$ds9 -catalog maxrows 2000
$ds9 -catalog allrows
$ds9 -catalog allcols
$ds9 -catalog ra RA
$ds9 -catalog dec DEC
$ds9 -catalog show
$ds9 -catalog hide
$ds9 -catalog edit yes
$ds9 -catalog panto no
cd
Sets the current working directory.
Syntax:
cd [<directory>]
Example:
$ds9 -cd /home/mrbill
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
colorbar
Controls colorbar parameters.
Syntax:
-colorbar [yes|no]
[horizontal|vertical]
[orientation horizontal|vertical]
[numerics yes|no]
[font courier|times|helivetica|symbol]
[fontsize <value>]
[fontstyle normal|bold|italic]
Example:
$ds9 -colorbar yes
$ds9 -colorbar vertical
$ds9 -colorbar orientation vertical
$ds9 -colorbar numerics yes
$ds9 -colorbar font times
$ds9 -colorbar fontsize 14
$ds9 -colorbar fontstyle bold
console
Display tcl console window.
Syntax:
-console
Example:
$ds9 -console
contour
Controls contours in the current frame.
Syntax:
-contour []
[yes|no]
[clear]
[generate]
[load <filename> <coordinate system> <skyframe> <color> <width> yes|no]
[save <filename> <coordinate system> <skyframe>]
[convert]
[loadlevels <filename>]
[savelevels <filename>]
[copy]
[paste <coordinate system> <skyframe> <color> <width> yes|no]
[color <color>]
[width <width>]
[dash yes|no]
[smooth <smooth>]
[method block|smooth]
[nlevels <number of levels>]
[scale linear|log|squared|sqrt|histequ]
[mode minmax|<value>|zscale|zmax]
[limits <min> <max>]
[levels <value value value...>]
Example:
$ds9 -contour
$ds9 -contour yes
$ds9 -contour generate
$ds9 -contour clear
$ds9 -contour load ds9.con wcs fk5 yellow 2 no
$ds9 -contour load ds9.con wcs fk5 red 2 yes
$ds9 -contour save ds9.con wcs fk5
$ds9 -contour convert
$ds9 -contour loadlevels ds9.lev
$ds9 -contour savelevels ds9.lev
$ds9 -contour copy
$ds9 -contour paste wcs fk5 red 2 no
$ds9 -contour color yellow
$ds9 -contour width 2
$ds9 -contour dash yes
$ds9 -contour smooth 5
$ds9 -contour method smooth
$ds9 -contour nlevels 10
$ds9 -contour scale sqrt
$ds9 -contour mode zscale
$ds9 -contour limits 1 100
$ds9 -contour levels "1 10 100 1000"crosshair
Controls the current position of the crosshair in the current frame. DS9 is placed in crosshair mode when the crosshair is set.
Syntax:
-crosshair [x y <coordinate system> [<skyframe>][<skyformat>]]
Example:
$ds9 -crosshair 100 100 physical # set crosshair in physical
$ds9 -crosshair 345 58.8 wcs fk5 # set crosshair in wcs coords
$ds9 -crosshair 23:01:00 +58:52:51 wcs fk5
cursor
Move mouse pointer or crosshair in image pixels in the current frame. Note, this will move selected Regions also.
Syntax:
-cursor [x y]
Example:
$ds9 -cursor 10 10
datacube
Controls FITS datacube.
Syntax:
-datacube [play|stop|next|prev|first|last]
[#]
[interval #]
Example:
$ds9 -datacube play
$ds9 -datacube last
$ds9 -datacube 3
$ds9 -datacube interval 2
dsssao
Support for Digital Sky Survey at SAO.
Syntax:
-dsssao [<object>]
[name <object>]
[coord <ra> <dec> degrees|sexagesimal] # in wcs fk5
[size <width> <height> degrees|arcmin|arcsec]
[save yes|no]
[frame new|current]
[update frame|crosshair]
Example:
$ds9 -dsssao m31
$ds9 -dsssao name m31
$ds9 -dsssao coord 00:42:44.404 +41:16:08.78 sexagesimal
$ds9 -dsssao size 60 60 arcmin
$ds9 -dsssao save yes
$ds9 -dsssao frame current
$ds9 -dsssao update frame
dsseso
Support for Digital Sky Survey at ESO.
Syntax:
-dsseso [<object>]
[name <object>]
[coord <ra> <dec> degrees|sexagesimal] # in wcs fk5
[size <width> <height> degrees|arcmin|arcsec]
[save yes|no]
[frame new|current]
[update frame|crosshair]
[survey DSS1|DSS2-red|DSS2-blue|DSS2-infrared]
Example:
$ds9 -dsseso m31
$ds9 -dsseso name m31
$ds9 -dsseso coord 00:42:44.404 +41:16:08.78 sexagesimal
$ds9 -dsseso size 60 60 arcmin
$ds9 -dsseso save yes
$ds9 -dsseso frame current
$ds9 -dsseso update frame
$ds9 -dsseso survey DSS2-red
dssstsci
Support for Digital Sky Survey at STSCI.
Syntax:
-dssstsci [<object>]
[name <object>]
[coord <ra> <dec> degrees|sexagesimal] # in wcs fk5
[size <width> <height> degrees|arcmin|arcsec]
[save yes|no]
[frame new|current]
[update frame|crosshair]
[survey poss2ukstu_red|poss2ukstu_ir|poss2ukstu_blue]
[survey poss1_blue|poss1_red]
[survey all|quickv|phase2_gsc2|phase2_gsc1]
Example:
$ds9 -dssstsci m31
$ds9 -dssstsci name m31
$ds9 -dssstsci coord 00:42:44.404 +41:16:08.78 sexagesimal
$ds9 -dssstsci size 60 60 arcmin
$ds9 -dssstsci save yes
$ds9 -dssstsci frame current
$ds9 -dssstsci update frame
$ds9 -desstsci survey all
exit
Quits DS9.
quit
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/imt1fifo_only
Only use IRAF input and output fifos. Same as -port 0 -unix none.
Syntax:
-fifo_only
Example:
$ds9 -fifo_only
file
Load FITS file. Note, this the default mode. Use this command to reset after using -mosaicimage, -mosaic, -array, and -mask.
Syntax:
-file <filename>
Example:
$ds9 -file foo.fitsfirst
Support for VLA First Sky Survey.
Syntax:
-first [<object>]
[name <object>]
[coord <ra> <dec> degrees|sexagesimal] # in wcs fk5
[size <width> <height> degrees|arcmin|arcsec]
[save yes|no]
[frame new|current]
[update frame|crosshair]
Example:
$ds9 -first m31
$ds9 -first name m31
$ds9 -first coord 00:42:44.404 +41:16:08.78 sexagesimal
$ds9 -first size 60 60 arcmin
$ds9 -first save yes
$ds9 -first frame current
$ds9 -first update frame
fits
Load FITS file.
Syntax:
-fits <filename>
Example:
$ds9 -fits foo.fitssfits
Load split FITS file.
Syntax:
-sfits <filename> <filename>
Example:
$ds9 -sfits foo.hdr foo.arr
frame
Controls frame functions. Frames may be created, deleted, reset, and centered. While return the current frame number. If you goto a frame that does not exists, it will be created. If the frame is hidden, it will be shown. The 'frameno' option is available for backward compatibility.
Syntax:
-frame [center [#|all]]
[clear [#|all]]
[new [rgb]]
[delete [#|all]]
[reset [#|all]]
[refresh [#|all]]
[hide [#|all]]
[show [#|all]]
[move first]
[move back]
[move forward]
[move last]
[first]
[prev]
[next]
[last]
[frameno #]
[#]
Example:
$ds9 -frame center # center current frame
$ds9 -frame center 1 # center 'Frame1'
$ds9 -frame center all # center all frames
$ds9 -frame clear # clear current frame
$ds9 -frame new # create new frame
$ds9 -frame new rgb # create new rgb frame
$ds9 -frame delete # delete current frame
$ds9 -frame reset # reset current frame
$ds9 -frame refresh # refresh current frame
$ds9 -frame hide # hide current frame
$ds9 -frame show 1 # show frame 'Frame1'
$ds9 -frame move first # move frame to first in order
$ds9 -frame move back # move frame back in order
$ds9 -frame move forward # move frame forward in order
$ds9 -frame move last # move frame to last in order
$ds9 -frame first # goto first frame
$ds9 -frame prev # goto prev frame
$ds9 -frame next # goto next frame
$ds9 -frame last # goto last frame
$ds9 -frame frameno 4 # goto frame 'Frame4', create if needed
$ds9 -frame 3 # goto frame 'Frame3', create if neededgeometry
Define the initial window geometry. This includes all of the ds9 window, not just the image space. see X(1).
Syntax:
-geometry value
Example:
$ds9 -geometry 640x480green
For RGB frames, sets the current color channel to green.
Syntax:
-green
Example:
$ds9 -green foo.fitsgrid
Controls coordinate grid.
Syntax:
-grid []
[yes|no]
[type analysis|publication]
[system <coordinate system>]
[sky <skyframe>]
[skyformat <skyformat>]
[grid yes|no]
[grid color <color>]
[grid width <value>]
[grid style 0|1]
[grid gap1 <value>]
[grid gap2 <value>]
[axes yes|no]
[axes color <color>]
[axes width <value>]
[axes style 0|1]
[axes type interior|exterior]
[tick yes|no]
[tick color <color>]
[tick width <value>]
[tick style 0|1]
[border yes|no]
[border color <color>]
[border width <value>]
[border style 0|1]
[numlab yes|no]
[numlab font times|helvetica|courier|symbol]
[numlab fontstye normal|italic|bold]
[numlab fontsize <value>]
[numlab color <color>]
[numlab gap1 <value>]
[numlab gap2 <value>]
[numlab type interior|exterior]
[numlab vertical yes|no]
[title yes|no]
[title text <text>]
[title def yes|no]
[title gap <value>]
[title font times|helvetica|courier|symbol]
[title fontstye normal|italic|bold]
[title fontsize <value>]
[title color <color>]
[textlab yes|no]
[textlab text1 <text>]
[textlab def1 yes|no]
[textlab gap1 <value>]
[textlab text2 <text>]
[textlab def2 yes|no]
[textlab gap2 <value>]
[textlab font times|helvetica|courier|symbol]
[textlab fontstye normal|italic|bold]
[textlab fontsize <value>]
[textlab color <color>]
[reset]
[load <filename>]
[save <filename>]
Example:
$ds9 -grid
$ds9 -grid yes
$ds9 -grid type analysis
$ds9 -grid system wcs
$ds9 -grid sky fk5
$ds9 -grid skyformat degrees
$ds9 -grid grid yes
$ds9 -grid grid color red
$ds9 -grid grid width 2
$ds9 -grid grid style 1
$ds9 -grid grid gap1 10
$ds9 -grid grid gap2 10
$ds9 -grid axes yes
$ds9 -grid axes color red
$ds9 -grid axes width 2
$ds9 -grid axes style 1
$ds9 -grid axes type exterior
$ds9 -grid tick yes
$ds9 -grid tick color red
$ds9 -grid tick width 2
$ds9 -grid tick style 1
$ds9 -grid border yes
$ds9 -grid border color red
$ds9 -grid border width 2
$ds9 -grid border style 1
$ds9 -grid numlab yes
$ds9 -grid numlab font courier
$ds9 -grid numlab fontstyle bold
$ds9 -grid numlab fontsize 12
$ds9 -grid numlab color red
$ds9 -grid numlab gap1 10
$ds9 -grid numlab gap2 10
$ds9 -grid numlab type exterior
$ds9 -grid numlab vertical yes
$ds9 -grid title yes
$ds9 -grid title text {Hello World}
$ds9 -grid title def yes
$ds9 -grid title gap 10
$ds9 -grid title font courier
$ds9 -grid title fontstyle bold
$ds9 -grid title fontsize 12
$ds9 -grid title color red
$ds9 -grid textlab yes
$ds9 -grid textlab text1 {Hello World}
$ds9 -grid textlab def1 yes
$ds9 -grid textlab gap1 10
$ds9 -grid textlab text2 {Hello World}
$ds9 -grid textlab def2 yes
$ds9 -grid textlab gap2 10
$ds9 -grid textlab font courier
$ds9 -grid textlab fontstyle bold
$ds9 -grid textlab fontsize 12
$ds9 -grid textlab color red
$ds9 -grid reset
$ds9 -grid load foo.grd
$ds9 -grid save foo.grd
height
Set the height of the image display window. Use the geometry command to set the overall width and height of the ds9 window.
Syntax:
-height [<value>]
Example:
$ds9 -height 512
help
Display help information. To maintain backward compatability, -help will display a brief help message and exit. --help will display all command line options within the built-in help facility.
Syntax:
-help # Display brief help message and exit.
--help # Display command line options within help facility.
-? # Display command line options within help facility.
Example:
$ds9 -help # Display brief help message and exit.
$ds9 --help # Display command line options within help facility
$ds9 -? # Display command line options within help facility.
histequ
Select histogram equalization scale for current frame.
Syntax:
-histequ
Example:
$ds9 -histequ
iconify
Toggles iconification.
Syntax:
-iconify []
[yes|no]
Example:
$ds9 -iconify
$ds9 -iconify yesinvert
Invert Colormap.
Syntax:
-invert
Example:
$ds9 -invert
iis
Set IIS Filename. Optional mosaic number maybe supplied.
Syntax:
-iis [filename <filename> [#]]
Example:
$ds9 -iis filename foo.fits
$ds9 -iis filename bar.fits 4
language
Select current language.
Syntax:
-language [locale|da|de|es|en|fr|ja|pt]
Example:
$ds9 -language fr
linear
Select Linear scale for current frame.
Syntax:
-linear
Example:
$ds9 -linearlock
Lock frames.
Syntax:
lock [crosshair none|wcs|wcsa...wcsz|physical|image]
Example:
$ds9 -lock crosshair wcslog
Select LOG scale for current frame. This is the same algorithm as used in IRAF.
Syntax:
-log
Example:
$ds9 -loglower
Lower ds9 in the window stacking order.
Syntax:
-lower
Example:
$ds9 -lower
mask
Controls mask parameters.
Syntax:
-mask [color <color>]
[mark 1|0]
[transparency <value>]
[clear]
Example:
$ds9 -mask color red
$ds9 -mask mark 0
$ds9 -mask transparency 50
$ds9 -mask clear
match
Match all other frames to the current frame.
Syntax:
-match [frames wcs|physical|image]
[colorbars]
[scales]
Example:
$ds9 -match frames wcs
$ds9 -match colorbars
$ds9 -match scales
medatacube
Load multiple extension FITS file as a data cube.
Syntax:
-medatacube <filename>
Example:
$ds9 -medatacube foo.fitsminmax
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. DATAMINIRAFMIN 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 [auto|scan|sample|datamin|irafmin]
[mode auto|scan|sample|datamin|irafmin]
[interval <value>]
Example:
$ds9 -minmax scan
$ds9 -minmax mode scan
$ds9 -minmax interval 10mode
Select the current mode.
Syntax:
-mode [none|pointer|crosshair|colorbar|pan|zoom|rotate|catalog|examine]
Example:
$ds9 -mode crosshair
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 [iraf|wcs|wcsa...wcsz|wfpc2] <filename>
Example:
$ds9 -mosaicimage iraf bar.fits
$ds9 -mosaicimage wcs bar.fits
$ds9 -mosaicimage wcsa bar.fits
$ds9 -mosaicimage wfpc2 hst.fits
mosaic
Load FITS Mosaic image segment.
Syntax:
-mosaic [iraf|wcs|wcsa...wcsz] <filename>
Example:
$ds9 -mosaic iraf foo.fits
$ds9 -mosaic wcs bar.fits
smosaic
Load split FITS Mosaic image segment.
Syntax:
-smosaic [iraf|wcs|wcsa...wcsz] <filename> <filename>
Example:
$ds9 -smosaic iraf foo.hdr foo.arr
$ds9 -smosaic wcs foo.hdr foo.arr
msg
Specify a directory of translation tables to be loaded.
Syntax:
-msg <directory>
Example:
$ds9 -msg $HOME/msgs
multiframe
Load multiple extension FITS file into multiple frames. NOTE: multiframe can not be used for files that have been loaded via stdin.
Syntax:
-multiframe <filename>
Example:
$ds9 -multiframe foo.fits
nameserver
Support Name Server functions. Coordinates are in fk5.
Syntax:
-nameserver [<object>]
[name <object>]
[server ned-sao|ned-eso|simbad-sao|simbad-eso]
[skyformat degrees|sexagesimal]
[pan]
[crosshair]
Example:
$ds9 -nameserver m31
$ds9 -nameserver name m31
$ds9 -nameserver server ned-sao
$ds9 -nameserver skyformat sexagesimal
$ds9 -nameserver pan
$ds9 -nameserver crosshair
nvss
Support for NRAO VLA Sky Survey.
Syntax:
-nvss [<object>]
[name <object>]
[coord <ra> <dec> degrees|sexagesimal] # in wcs fk5
[size <width> <height> degrees|arcmin|arcsec]
[save yes|no]
[frame new|current]
[update frame|crosshair]
Example:
$ds9 -nvss m31
$ds9 -nvss name m31
$ds9 -nvss coord 00:42:44.404 +41:16:08.78 sexagesimal
$ds9 -nvss size 60 60 arcmin
$ds9 -nvss save yes
$ds9 -nvss frame current
$ds9 -nvss update frame
orient
Controls the orientation of the current frame.
Syntax:
-orient [none|x|y|xy]
Example:
$ds9 -orient xypagesetup
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 posterpan
Controls the current image cursor location for the current frame.
Syntax:
-pan [x y <coordinate system> [<skyframe>][<skyformat>]
[to x y <coordinate system> [<skyframe>][<skyformat>]
Example:
$ds9 -pan 200 200 image
$ds9 -pan to 400 400 physical
$ds9 -pan to 13:29:55 47:11:50 wcs fk5
pixeltable
Display/Hide the pixel table.
Syntax:
-pixeltable []
[yes|no]
Example:
$ds9 -pixeltable
$ds9 -pixeltable yesplot
Display and configure data plots. All plot commands take an optional second command, the plot name. Use xpaget plot to retrieve all plot names. If no plot name is specified, the last plot created is assumed. Plot data is assumed to be a pair of coordinates, with optional error values. The follow are valid data descriptions:
xy x and y coordinatesTo create a new plot, use the plot new command. If the second arg is stdin, the title, x axis title, y axis title, and dimension are assumed to be on the first line of the data.
xyex x,y coordinates with x errors
xyey x,y coordinates with y errors
xyexey x,y coordinates with both x and y errors
Syntax:
# create new empty plot window
-plot []
[new [name <plotname>]]
[new [name <plotname>] <title> <xaxis label> <yaxis label> xy|xyex|xyey|xyexey]
# edit existing plot
-plot [<plotname>] [close]
[<plotname>] [clear]
[<plotname>] [load <filename> xy|xyex|xyey|xyexey]
[<plotname>] [save <filename>]
[<plotname>] [loadconfig <filename>]
[<plotname>] [saveconfig <filename>]
[<plotname>] [print]
[<plotname>] [print destination printer|file]
[<plotname>] [print command <command>]
[<plotname>] [print filename <filename>]
[<plotname>] [print palette color|gray|mono]
[<plotname>] [page orientation portrait|landscape]
[<plotname>] [page pagescale scaled|fixed]
[<plotname>] [page pagesize letter|legal|tabloid|poster|a4]
[<plotname>] [graph grid yes|no]
[<plotname>] [graph scale linearlinear|linearlog|loglinear|loglog]
[<plotname>] [graph range x|y auto yes|no]
[<plotname>] [graph range x|y min <value>]
[<plotname>] [graph range x|y max <value>]
[<plotname>] [graph labels title|xaxis|yaxis <value>]
[<plotname>] [font numbers|labels|title font times|helvetica|symbol|courier]
[<plotname>] [font numbers|labels|title size <value>]
[<plotname>] [font numbers|labels|title style normal|bold|italic]
# edit current dataset
-plot [<plotname>] [dataset #]
[<plotname>] [view discrete|linear|step|quadratic|error yes|no]
[<plotname>] [color discrete|linear|step|quadratic|error <color>]
[<plotname>] [line discrete circle|diamond|plus|cross]
[<plotname>] [line linear|step|quadratic|error width <value>]
[<plotname>] [line linear|step|quadratic dash yes|no]
[<plotname>] [line error style 1|2]
Example:
# create new empty plot window
$ds9 -plot
$ds9 -plot new
$ds9 -plot new name foo
# edit existing plot
$ds9 -plot close # close last plot
$ds9 -plot foo close # close plot foo
$ds9 -plot clear # clear all datasets
$ds9 -plot load foo.dat xy # load new dataset with dimension xy
$ds9 -plot save bar.dat # save current dataset
$ds9 -plot loadconfig foo.plt # load plot configuration
$ds9 -plot saveconfig bar.plt # save current plot configuration
$ds9 -plot print
$ds9 -plot print destination file
$ds9 -plot print command "lp"
$ds9 -plot print filename "foo.ps"
$ds9 -plot print palette gray
$ds9 -plot page orientation portrait
$ds9 -plot page pagescale scaled
$ds9 -plot page pagesize letter
$ds9 -plot graph grid yes
$ds9 -plot graph scale loglog
$ds9 -plot graph range x auto yes
$ds9 -plot graph range x min 0
$ds9 -plot graph range x max 100
$ds9 -plot graph range y auto yes
$ds9 -plot graph range y min 0
$ds9 -plot graph range y max 100
$ds9 -plot graph labels title {The Title}
$ds9 -plot graph labels xaxis {X}
$ds9 -plot graph labels yaxis {Y}
$ds9 -plot font numbers font times
$ds9 -plot font numbers size 12
$ds9 -plot font numbers style bold
$ds9 -plot font labels font times
$ds9 -plot font title font times
# edit current dataset
$ds9 -plot dataset 2 # set current dataset to the second dataset loaded
$ds9 -plot view discrete yes
$ds9 -plot color discrete red
$ds9 -plot line discrete cross
$ds9 -plot line step width 2
$ds9 -plot line step dash yes
$ds9 -plot line error style 2
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 5137port_only
Only use the IRAF port number. This is the same as -fifo none -unix none.
inet_only
Syntax:
-port_only
Example:
$ds9 -port_only
pow
Select Power scale for current frame.
Syntax:
-pow
Example:
$ds9 -powprefs
Controls various preference settings.
Syntax:
prefs [clear]
[bgcolor <color>]
[nancolor <color>]
Example:
$ds9 -prefs clear
$ds9 -prefs bgcolor black
$ds9 -prefs nancolor red
preserve
Preserve the follow attributes while loading a new image.
Syntax:
preserve [scale yes|no]
[pan yes|no]
[regions yes|no]
Example:
$ds9 -preserve scale yes
$ds9 -preserve pan yes
$ds9 -preserve regions yes
Syntax:
-print [destination printer|file]
[command <command>]
[filename <filename>]
[palette rgb|cmyk|gray]
[level 1|2]
[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 resolution 75private
use private colormap, valid for pseudocolor 8 mode.
Syntax:
-private
Example:
$ds9 -privateraise
Raise ds9 in the window stacking order.
Syntax:
-raise
Example:
$ds9 -raise
regions
Controls regions in the current frame.
Syntax:
-regions [<filename>]
[load [all] <filename>]
[save <filename>]
[list]
[show yes|no]
[showtext yes|no]
[autocentroid yes|no]
[getinfo]
[move front]
[move back]
[select all]
[select none]
[select group <groupname>]
[delete all]
[delete select]
[format ds9|xml|ciao|saotng|saoimage|pros|xy]
[system image|physical|wcs|wcsa...wcsz]
[sky fk4|fk5|icrs|galactic|ecliptic]
[skyformat degrees|sexagesimal]
[strip yes|no]
[shape <shape>]
[color <color>]
[width <width>]
[delim [nl|<char>]]
[command <marker command>]
[composite]
[dissolve]
[template <filename>]
[template <filename> at <ra> <dec> <coordinate system> <skyframe>]
[savetemplate <filename>]
[group <tag>]
[group <tag> color <color>]
[group <tag> copy]
[group <tag> delete]
[group <tag> cut]
[group <tag> font <font>]
[group <tag> move <int> <int>]
[group <tag> movefront]
[group <tag> moveback]
[group <tag> property <property> yes|no]
[group <tag> select]
[copy]
[cut]
[paste image|physical|wcs|wcsa...wcsz fk4|fk5|icrs|galactic|ecliptic]
[undo]
Example:
$ds9 -regions foo.reg
$ds9 -regions load foo.reg # load foo.reg into current frame
$ds9 -regions load all foo.reg # load foo.reg into all frames
$ds9 -regions load '*.reg'# expand *.reg and load into current frame
$ds9 -regions load all '*.reg' # expand *.reg and load into all frames
$ds9 -regions save foo.reg
$ds9 -regions list
$ds9 -regions show yes
$ds9 -regions showtext no
$ds9 -regions autocentroid yes
$ds9 -regions getinfo
$ds9 -regions move back
$ds9 -regions move front
$ds9 -regions select all
$ds9 -regions select none
$ds9 -regions select group foo
$ds9 -regions delete all
$ds9 -regions delete select
$ds9 -regions format ds9
$ds9 -regions system wcs
$ds9 -regions sky fk5
$ds9 -regions skyformat degrees
$ds9 -regions delim nl
$ds9 -regions strip yes
$ds9 -regions shape ellipse
$ds9 -regions color red
$ds9 -regions width 3
$ds9 -regions command {circle 100 100 20}
$ds9 -regions composite
$ds9 -regions dissolve
$ds9 -regions template foo.tpl
$ds9 -regions template foo.tpl at 13:29:55.92 +47:12:48.02 fk5
$ds9 -regions savetemplate foo.tpl
$ds9 -regions group foo color red
$ds9 -regions group foo copy
$ds9 -regions group foo delete
$ds9 -regions group foo cut
$ds9 -regions group foo font {times 14 bold}
$ds9 -regions group foo move 100 100
$ds9 -regions group foo movefront
$ds9 -regions group foo moveback
$ds9 -regions group foo property delete no
$ds9 -regions group foo select
$ds9 -regions copy
$ds9 -regions cut
$ds9 -regions paste wcs fk5
$ds9 -regions undo
red
For RGB frames, sets the current color channel to red.
Syntax:
-red
Example:
$ds9 -red foo.fitsrgb
Create RGB frame and control RGB frame parameters.
Syntax:
-rgb # empty
[red|green|blue]
[channel [red|green|blue]]
[view [red|green|blue] [yes|no]]
[system <coordsys>]
[lock scale|bin|colorbar [yes|no]
Example:
$ds9 -rgb # create new rgb frame
$ds9 -rgb red # set current channel to red
$ds9 -rgb channel red # set current channel to red
$ds9 -rgb view blue no # turn off blue channel
$ds9 -rgb system wcs # set rgb coordinate system
$ds9 -rgb lock scale yes # lock rgb channels for scaling
$ds9 -rgb lock bin yes # lock rgb channels for binning
$ds9 -rgb lock colorbar yes # lock rgb colorbar channels
rgbarray
Load entire RGB image composed of a 3D Array Data Cube that contains red, green, and blue channels.
Syntax:
-rgbarray <filename>[xdim=<x>,ydim=<y>|dim=<dim>,zdim=3],bitpix=<b>,[skip=<s>]]
Example:
$ds9 -rgbarray rgb.arr[dim=200,zdim=3,bitpix=-32]
rgbcube
Load entire RGB image composed of a FITS 3D Data Cube that contains red, green, and blue channels.
Syntax:
-rgbcube <filename>
Example:
$ds9 -rgbcube rgb.fits
srgbcube
Load entire RGB image composed of a split FITS 3D Data Cube that contains red, green, and blue channels.
Syntax:
-srgbcube <filename> <filename>
Example:
$ds9 -srgbcube rgb.hdr rgb.arrrgbimage
Load entire RGB image composed of a FITS multiple extension file that contains red, green, and blue channels.
Syntax:
-rgbimage <filename>
Example:
$ds9 -rgbimage rgb.fits
rotate
Controls the rotation angle (in degrees) of the current frame.
Syntax:
-rotate [<value>]
[to <value>]
Example:
$ds9 -rotate 45
$ds9 -rotate to 30
samp
Enable/Disable SAMP protocol.
Syntax:
-samp [yes|no]
[broadcast]
[send <application>]
Example:
$ds9 -samp yes
$ds9 -samp broadcast
$ds9 -samp send aladin
saveimage
Save visible image(s) as a raster. If image is a data cube, the mpeg option will cycle thru each slice creating a mpeg movie.
Syntax:
-saveimage [fits|jpeg|tiff|png|ppm|mpeg] <filename>
Example:
$ds9 -saveimage jpeg ds9.jpg
savefits
Save current frame data as FITS. This differs from SAVEIMAGE in that the entire image of the current frame is saved as a FITS, without graphics.
Syntax:
-savefits <filename>
Example:
$ds9 -savefits ds9.fits
savempeg
Save all active frames as a mpeg movie.
Syntax:
-savempeg <filename>
Example:
$ds9 -savempeg ds9.mpg
scale
Controls the limits, color scale distribution, and use of DATASEC keyword.
Syntax:
-scale [linear|log|pow|sqrt|squared|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 localshm
Load a shared memory segment into the current frame.
Syntax:
-shm [<key> [<filename>]]
[key <id> [<filename>]]
[shmid <id> [<filename>]]
[fits [key|shmid] <id> [<filename>]]
[sfits [key|shmid] <id> <id> [<filename>]]
[mosaicimage [iraf|wcs|wcsa...wcsz|wfpc2] [key|shmid] <id> [<filename>]]
[mosaicimagenext [wcs|wcsa...wcsz] [key|shmid] <id> [<filename>]]
[mosaic [iraf|wcs|wcsa...wcsz] [key|shmid] <id> [<filename>]]
[smosaic [iraf|wcs|wcsa...wcsz] [key|shmid] <id> <id> [<filename>]]
[rgbcube [key|shmid] <id> [<filename>]]
[srgbcube [key|shmid] <id> <id> [<filename>]]
[rgbimage [key|shmid] <id> [<filename>]]
[rgbarray [key|shmid] <id> [xdim=<x>,ydim=<y>|dim=<dim>,zdim=3],bitpix=<b>,[skip=<s>]]
[array [key|shmid] <id> [xdim=<x>,ydim=<y>|dim=<dim>],bitpix=<b>,[skip=<s>]]
Example:
$ds9 -shm 102
$ds9 -shm key 102
$ds9 -shm shmid 102 foo
$ds9 -shm fits 100 foo
$ds9 -shm sfits 100 101 foo
$ds9 -shm mosaicimage iraf key 100 foo
$ds9 -shm mosaicimage wcs key 100 foo
$ds9 -shm mosaicimage wcsa key 100 foo
$ds9 -shm mosaicimage wfpc2 key 100 foo
$ds9 -shm mosaicimagenext wcs key 100 foo
$ds9 -shm mosaic iraf key 100 foo
$ds9 -shm mosaic wcs key 100 foo
$ds9 -shm smosaic wcs key 100 101 foo
$ds9 -shm rgbcube key 100 foo
$ds9 -shm srgbcube key 100 101 foo
$ds9 -shm rgbimage key 100 foo
$ds9 -shm rgbarray shmid 102 [dim=32,zdim=3,bitpix=-32]
$ds9 -shm array shmid 102 [dim=32,bitpix=-32]single
Set display mode to single.
Syntax:
-single
Example:
$ds9 -single
skyview
Support for SkyView image server at HEASARC.
Syntax:
-skyview [<object>]
[name <object>]
[coord <ra> <dec> degrees|sexagesimal] # in wcs fk5
[size <width> <height> degrees|arcmin|arcsec]
[save yes|no]
[frame new|current]
[update frame|crosshair]
[survey sdssi|sdssr|sdssg|sdssu|sdssg]
Example:
$ds9 -skyview m31
$ds9 -skyview name m31
$ds9 -skyview coord 00:42:44.404 +41:16:08.78 sexagesimal
$ds9 -skyview size 60 60 arcmin
$ds9 -skyview save yes
$ds9 -skyview frame current
$ds9 -skyview update frame
$ds9 -skyview survey sdssi
sleep
Delays execution for specified number of seconds.
Syntax:
-sleep [#]
Example:
$ds9 -sleep 2
smooth
Smooth current image or set smooth parameters.
Syntax:
-smooth []
[yes|no]
[function boxcar|tophat|gaussian]
[radius <int>]
Example:
$ds9 -smooth
$ds9 -smooth yes
$ds9 -smooth function tophat
$ds9 -smooth radius 4
squared
Select Squared scale for current frame.
Syntax:
-squared
Example:
$ds9 -squaredsqrt
Select Square Root scale for current frame.
Syntax:
-sqrt
Example:
$ds9 -sqrtsource
Sources a valid TCL file.
Syntax:
-source filename
Example:
$ds9 -source extensions.tcl
tcl
Enable tcl commands to be executed via XPA or SAMP. This can be a major security risk and is disabled by default. Please use with caution.
Syntax:
-tcl [yes|no]
Example:
$ds9 -tcl yes
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 columntitle
Changes the display window title to the specified name.
Syntax:
-title name
Example:
$ds9 -title Voyagerunix
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
update
Updates the current frame or region of frame. In the second form, the first argument is the number of the fits HDU (starting with 1) and the remaining args are a bounding box in IMAGE coordinates. By default, the screen is updated the next available idle cycle. However, you may force an immediate update by specifying the NOW option.
Syntax:
-update []
[# x1 y1 x2 y2]
[now]
[now # x1 y1 x2 y2]
[on]
[off]
Example:
$ds9 -update
$ds9 -update 1 100 100 300 400
$ds9 -update now
$ds9 -update now 1 100 100 300 400
$ds9 -update off # delay refresh of the screen while loading files
$ds9 -update on # be sure to turn it on when you are finished loading
url
Load FITS file from specified url.
Syntax:
-url <url>
Example:
$ds9 -url 'ftp://foo.bar.edu/img.fits'version
Returns the current version of DS9 and exits.
Syntax:
-version
Example:
$ds9 -versionview
Controls the GUI and visible RGB frame color channels.
Syntax:
-view [layout horizontal|vertical]
[info yes|no]
[panner yes|no]
[magnifier yes|no]
[buttons yes|no]
[colorbar yes|no]
[graph horizontal|vertical yes|no]
[filename yes|no]
[object yes|no]
[minmax yes|no]
[lowhigh yes|no]
[frame yes|no]
[image|physical|wcs|wcsa...wcsz yes|no]
[red yes|no]
[green yes|no]
[blue yes|no]
Example:
$ds9 -view layout vertical
$ds9 -view info yes
$ds9 -view panner yes
$ds9 -view magnifier yes
$ds9 -view buttons yes
$ds9 -view colorbar yes
$ds9 -view graph horizontal yes
$ds9 -view filename yes
$ds9 -view object yes
$ds9 -view minmax yes
$ds9 -view lowhigh yes
$ds9 -view frame yes
$ds9 -view wcsa yes
$ds9 -view red yes
$ds9 -view green yes
$ds9 -view blue yes
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 truecolor24vo
Invoke an connection to a Virtual Observatory site.
Syntax:
-vo [method xpa|mime]
[server <url>]
[internal yes|no]
[<url>]
[connect <url>]
[disconnect <url>]
Example:
$ds9 -vo method xpa
$ds9 -vo server "http://foo.bar.edu/list.txt"
$ds9 -vo internal yes
$ds9 -vo chandra-ed
$ds9 -vo connect chandra-ed
$ds9 -vo disconnect chandra-ed
wcs
Controls the World Coordinate System for the current frame. If the wcs system, skyframe, or skyformat is modified, the info panel, compass, grid, and alignment will be modified accordingly. Also, a new WCS specification can be loaded and used by the current image regardless of the WCS that was contained in the image file. Please see WCS for more information.Syntax:
-wcs [wcs|wcsa...wcsz]
[system wcs|wcsa...wcsz]
[sky fk4|fk5|icrs|galactic|ecliptic]
[skyformat degrees|sexagesimal]
[align yes|no]
[reset]
[replace <filename>]
[append <filename>]
Example:
$ds9 -wcs wcs
$ds9 -wcs system wcs
$ds9 -wcs wcsa
$ds9 -wcs sky fk5
$ds9 -wcs skyformat sexagesimal
$ds9 -wcs align yes
$ds9 -wcs reset
$ds9 -wcs replace foo.wcs
$ds9 -wcs append foo.wcsweb
Display specified URL in the web display.
Syntax:
-web [new|<webname>] [<url>]
[<webname>] [click back|forward|stop|reload|#]
[<webname>] [clear]
[<webname>] [close]
Example:
$ds9 -web www.cnn.com
$ds9 -web new www.cnn.com
$ds9 -web hvweb www.apple.com
$ds9 -web click back
$ds9 -web click 2
$ds9 -web clear
$ds9 -web close
width
Set the width of the image display window. Use the geometry command to set the overall width and height of the ds9 window.
Syntax:
-width [<value>]
Example:
$ds9 -width 512
xpa
Configure XPA at startup.
Syntax:
-xpa [yes|no]
[inet|local|unix|localhost]
[noxpans]
Example:
$ds9 -xpa no
$ds9 -xpa local
$ds9 -xpa noxpans
zmax
Set Scale Limits based on the IRAF algorithm and maximum data value.
Syntax:
-zmax
Example:
$ds9 -zmaxzscale
Set Scale Limits based on the IRAF algorithm.
Syntax:
-zscale []
[contrast]
[sample]
[line]
Example:
$ds9 -zscale
$ds9 -zscale contrast .25
$ds9 -zscale sample 600
$ds9 -zscale line 120
zoom
Controls the current zoom value for the current frame.
Syntax:
-zoom [<value>]
[<value> <value>]
[to <value>]
[to <value> <value>]
[to fit]
Example:
$ds9 -zoom 2
$ds9 -zoom 2 4
$ds9 -zoom to 4
$ds9 -zoom to 2 4
$ds9 -zoom to fit