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.

2mass

Support for 2MASS 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:
-2mass [<object>]
       [name <object>]
       [coord <ra> <dec>] # in wcs fk5
       [survey j|h|k]

       [size <radius>] # in arcsec

Example:
$ds9 -2mass m31

$ds9 -2mass name m31

$ds9 -2mass coord 00:42:44.404 +41:16:08.78

$ds9 -2mass survey j

$ds9 -2mass size 600

blue

For RGB frames, sets the current color channel to blue.
Syntax:
-blue
Example:
$ds9 -blue foo.fits

catalog

Support for catalogs.
Syntax:
-catalog [cds sao|hst|gsc|tycho|ac|ua2|ub1|ucac2|2mass|denis|rosat|rosf|first]
       
[cds <catalogid>]
       
[load <filename>]

        [<catname>] [name <object>]
        [<catname>] [coordinate <ra> <dec> <coordinate system>]
        [<catname>] [size <width> <height> degrees|arcmin|arcsec]

        [<catname>] [save <filename>]
       
[<catname>] [filter <string>]
       
[<catname>] [filter load <filename>]
       
[<catname>] [clear]
       
[<catname>] [retreive]
       
[<catname>] [cancel]
       
[<catname>] [print]
       
[<catname>] [close]

       
[<catname>] [server cds|sao|cadc|adac|iucaa|bejing|cambridge|ukirt]
       
[<catname>] [symbol shape {circle point}|{box point}|{diamond point}|
                    {cross point}|{x point}|{arrow point}|{boxcircle point}|
                    circle|ellipse|box|text]
       
[<catname>] [symbol color <colorname>]
       
[<catname>] [symbol load <filename>]
       
[<catname>] [sort <columnname> incr|decr]
       
[<catname>] [maxrows <number>]
       
[<catname>] [allcols]

Example:
$ds9 -catalog cds 2mass
$ds9 -catalog cds "I/252"
$ds9 -catalog load foo.cat

$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 filter "\$Jmag>10"
$ds9 -catalog filter load foo.flt
$ds9 -catalog clear
$ds9 -catalog retreive
$ds9 -catalog cancel
$ds9 -catalog print
$ds9 -catalog close
$ds9 -catalog server sao
$ds9 -catalog symbol shape "{boxcircle point}"
$ds9 -catalog symbol color red
$ds9 -catalog symbol load foo.sym
$ds9 -catalog sort "Jmag" incr
$ds9 -catalog maxrows 2000
$ds9 -catalog allcols

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> [<sky frame>][<sky format>]]
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

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

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.

sfits

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]]
       [first]
       [next]
       [prev]
       [last]
       [frameno #]
       [#]
Example:
$ds9 -frame center
$ds9 -frame center 1
$ds9 -frame center all
$ds9 -frame clear
$ds9 -frame new
$ds9 -frame new rgb
$ds9 -frame delete
$ds9 -frame reset
$ds9 -frame refresh
$ds9 -frame hide
$ds9 -frame show 1
$ds9 -frame first
$ds9 -frame next
$ds9 -frame prev
$ds9 -frame last
$ds9 -frame frameno 4
$ds9 -frame 3

green

For RGB frames, sets the current color channel to green.
Syntax:
-green
Example:
$ds9 -green foo.fits

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

histequ

Select histogram equalization scale for current frame.
Syntax:
-histequ
Example:
$ds9 -histequ

iconify

Toggles iconification.
Syntax:
-iconify [yes|no]
Example:
$ds9 -iconify yes

medatacube

Load multiple extension FITS file as a data cube.
Syntax:
-medatacube <filename>
Example:
$ds9 -medatacube foo.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 [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

mosaicimagenext

Load entire FITS WCS Mosaic image composed of multiple extensions in one FITS file with out clearing the current frame.  All extensions that are FITS Images and are valid FITS Mosaic Images will be loaded.
Syntax:
-mosaicimagenext [iraf|wcs|wcsa...wcsz|wfpc2] <filename>
Example:
$ds9 -mosaicimagenext wcs bar.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

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]

Example:
$ds9 -nameserver m31

$ds9 -nameserver name m31

$ds9 -nameserver server ned-sao
$ds9 -nameserver skyformat sexagesimal

orient

pixeltable

Display/Hide the pixel table.
Syntax:
-pixeltable [yes|no]
Example:
$ds9 -pixeltable yes

plot

Display and configure data plots. All plot commands take an optional second command, the plot name. Use xpaget plot to retreive 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 coordinates
xyex      x,y coordinates with x errors
xyey      x,y coordinates with y errors
xyexey    x,y coordinates with both x and y errors
To 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.

Syntax:
# create new empty plot window
-plot []
      [new [name <plotname>]]

# 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 plain|bold|italic]

# edit current dataset
-plot
[<plotname>] [dataset #]
     
[<plotname>] [view discrete|line|step|quadratic|errorbar yes|no]
     
[<plotname>] [color discrete|line|step|quadratic|errorbar <color>]
     
[<plotname>] [line discrete circle|diamond|plus|cross]
      [<plotname>] [line line|step|quadratic|errorbar width <value>]
      [<plotname>] [line line|step|quadratic dash yes|no]
      [<plotname>] [line errorbar 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 errorbar style 2

prefs

Controls various preference settings.
Syntax:
prefs [save]
      [clear]
      [mosaicfast yes|no]
      [bgcolor white|black|red|green|blue|cyan|magenta|yellow]
      [nancolor white|black|red|green|blue|cyan|magenta|yellow]

Example:
$ds9 -prefs save
$ds9 -prefs clear
$ds9 -prefs mosaicfast no
$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

regions

Controls regions in the current frame.
Syntax:
-regions [<filename>]
        [load <filename>]
        [save <filename>]
        [move front]
        [move back]
        [select all]
        [select none]
        [select group <groupname>]
        [delete all]
        [delete select]

        [format ds9|ciao|saotng|saoimage|pros|xy]
        [system image|physical|wcs|wcsa...wcsz]
        [sky fk4|fk5|icrs|galactic|ecliptic]
        [skyformat degrees|sexagesimal]
        [strip yes|no]
        [wcs yes|no]
        [shape <shape>]
        [color white|black|red|green|blue|cyan|magenta|yellow]
        [width <width>]
        [delim [nl|<char>]]
        [command <marker command>]

        [composite]
        [desolve]

        [template <filename>]
        [savetemplate <filename>]

        [group <tag>]
        [group <tag> color [black|white|red|green|blue|cyan|magenta|yellow]]
        [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
$ds9 -regions save foo.reg
$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 wcs 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 desolve

$ds9 -regions template foo.tpl
$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.fits

rgb

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 <coordinate system>]
     [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.arr

rgbimage

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

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
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]

smooth

Smooth current image or set smooth parameters.
Syntax:
-smooth [yes|no]
        [function boxcar|tophat|gaussian]
        [radius <int>]

Example:
$ds9 -smooth yes
$ds9 -smooth function tophat
$ds9 -smooth radius 4

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