SAMP
SAMP is a messaging protocol that enables astronomy software tools to interoperate and communicate. Broadly speaking, SAMP is an abstract framework for loosely-coupled, asynchronous, RPC-like and/or event-based communication, based on a central service providing multi-directional publish/subscribe message brokering. The message semantics are extensible and use structured but weakly-typed data. For more information on SAMP, please click here.

The samp implementation for DS9 is based on the XPA model with 2 private calls:

ds9.get
    Arguments
        cmd (string) required
        url (string) optional
    Returned value
        OK (samp.result map)
            value (string) optional
                url (string) optional
        ERROR (samp.error map)
            samp.errortxt (string)

ds9.set
    Arguments
        cmd (string) required
        url (string) optional
    Returned value
        OK
        ERROR (samp.error map)
            samp.errortxt (string)


ds9.set maybe called via notification, call and call/wait. ds9.get can only be called via call and call/wait. Most of the ds9.get calls return a value string, but a few will return a url instead.

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:

string value = ds9.get(string
cmd)
2mass name
2mass coord
2mass size
2mass save
2mass frame
2mass survey

ds9.set(string cmd)
2mass m31
2mass name m31
2mass coord 00:42:44.404 +41:16:08.78 sexagesimal
2mass size 60 60 arcmin
2mass save yes
2mass frame current
2mass update frame
2mass survey j

about

Get DS9 credits.

Syntax:
about

Example:

string url = ds9.get(string cmd)
about

analysis

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:

string url = ds9.get(string cmd)
analysis

string value = ds9.get(string cmd)
analysis entry Please enter something
analysis entry okcancel Please enter something

ds9.set(string cmd)
analysis 0
# invoke first analysis task
analysis my.ans
analysis load my.ans
analysis clear
analysis clear load my.ans
analysis message ok {This is a message}
analysis text {this is text}

ds9.set(string cmd, string url)
analysis load
analysis text

array

Load raw data array from stdin. If new is specified, a new frame is created first, before loading.

Syntax:
array [bigendian|littleendian]
array [new|mask][[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,
    arch=[littleendian|bigendian]]
array
[new] rgb [[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,
    arch=[littleendian|bigendian]]

Example:
 
string url = ds9.get(string cmd)
array # default bigendian
array littleendian

ds9.set(string command, string url)
array [dim=512,bitpix=16]
array mask [dim=512,bitpix=16]
array rgb [dim=200,zdim=3,bitpix=8]
array [xdim=512,ydim=512,zdim=1,bitpix=16] # load 512x512 short
array [dim=256,bitpix=-32,skip=4] # 256x256 float with 4 byte head
array [dim=512,bitpix=32,arch=littleendian] # 512x512 long, intel

bin

Controls binning factor, binning buffer size, and  binning function for binning FITS bin tables. The access point blocking is provided for backward compatibility.

Syntax:
bin [about <x> <y>]
    [about center]
    [buffersize <value>]
    [cols <x> <y>]
    [colsz <x> <y> <z>]
    [factor <value> [<vector>]]
    [depth <value>]
    [filter <string>]
    [function average|sum]
    [to fit]

Example:

string value = ds9.get(string cmd)
bin about
bin buffersize
bin cols
bin factor
bin depth
bin filter
bin function
bin smooth
bin smooth function
bin smooth radius

ds9.set(string cmd)
bin about 4096 4096
bin about center
bin buffersize 512
bin cols detx dety
bin colsz detx dety time
bin factor 4
bin factor 4 2
bin depth 10
bin filter {pha > 5}
bin filter {}
bin function sum
bin to fit

blink

Blink mode parameters. Interval is in seconds. 

Syntax:
blink []
      [yes|no]
      [interval <value>]

Example:
 
string value = ds9.get(string cmd)
blink
blink interval

ds9.set(string cmd)
blink
blink yes
blink interval 1

catalog
cat

Support for catalogs. The first three commands will create a new catalog search. All other commands operated on the last search created, unless indicated otherwise.

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> <coordsys>]
        [<catname>] [size <width> <height> degrees|arcmin|arcsec]

        [<catname>] [save <filename>]
        [<catname>] [save [xml|sb|tsv] <filename>]
        [<catname>] [header]
       
[<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>] [show|hide]
        [<catname>] [ra <columnname>]
        [<catname>] [dec <columnname>]
        [<catname>] [show|hide]
        [<catname>] [edit yes|no]
        [<catname>] [panto yes|no]

Example:

string value = ds9.get(string cmd)
catalog
catalog header
catalog cat2mass header

string url = ds9.get(string cmd)
catalog header

ds9.set(string cmd)
catalog 2mass

catalog cds 2mass

catalog cds {I/252}
catalog load foo.cat
catalog load xml foo.xml
catalog samp broadcast
catalog samp send aladin
catalog cat2mass symbol color red
catalog name m51
catalog coordinate 202.48 47.21 fk5
catalog size 22 22 arcmin
catalog save bar.cat
catalog save xml bar.xml
catalog filter {$Jmag>10}
catalog filter load foo.flt
catalog clear
catalog retrieve
catalog cancel
catalog print
catalog close
catalog server sao
catalog symbol condition {$Jmag>15}
catalog symbol 2 shape {boxcircle point}
catalog symbol color red
catalog symbol add
catalog symbol 2 remove
catalog symbol load foo.sym
catalog symbol save bar.sym
catalog sort {Jmag} incr
catalog maxrows 2000
catalog allrows
catalog allcols
catalog ra RA
catalog dec DEC
catalog show
catalog hide
catalog edit yes
catalog panto no

cd

Sets/Returns the current working directory.

Syntax:
cd [<directory>]

Example:
 
string value = ds9.get(string cmd)
cd

ds9.set(string cmd)
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 <constrast> <bias>]

Example:

string value = ds9.get(string cmd)
cmap
cmap file
cmap invert
cmap value

ds9.set(string cmd)
cmap Heat
cmap file foo.sao
cmap invert yes
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:
 
string value = ds9.get(string cmd)
colorbar
colorbar orientation
colorbar numerics
colorbar font
colorbar fontsize
colorbar fontsytle

ds9.set(string cmd)
colorbar yes
colorbar vertical
colorbar orientation vertical
colorbar numerics yes
colorbar font times
colorbar fontsize 14
colorbar fontstyle bold

console

Display tcl console window.
Syntax:
-console

Example:

ds9.set(string cmd)
console

contour

Controls contours in the current frame.

Syntax:
contour []
        [yes|no]
        [<coordsys> [<skyframe>]]
        [clear]
        [generate]
        [load <filename> <coordsys> <skyframe> <color> <width> yes|no]
 
      [save <filename> <coordsys> <skyframe>]
        [convert]
        [loadlevels <filename>]
        [savelevels <filename>]
        [copy]
        [paste <coordsys> <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:

string value = ds9.get(string cmd)
contour
contour color
contour width
contour dash
contour smooth
contour method
contour nlevels
contour scale
contour mode
contour limits
contour levels

string url = ds9.get(string cmd)
contour wcs fk5

ds9.set(string cmd)
contour
contour yes
contour clear
contour generate
contour load ds9.con wcs fk5 yellow 2 no # solid line
contour load ds9.con wcs fk5 red 2 yes # dashed line
contour save ds9.con wcs fk5
contour convert
contour loadlevels ds9.lev
contour savelevels ds9.lev
contour copy
contour paste wcs fk5 red 2 no
contour color yellow
contour width 2
contour dash yes
contour smooth 5
contour method smooth
contour nlevels 10
contour scale sqrt
contour mode zscale
contour limits 1 100
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 <coordsys> [<skyframe>][<skyformat>]]

Example:
 
string value = ds9.get(string cmd)
crosshair # get crosshair in physical coords
crosshair wcs fk4 sexagesimal # get crosshair in wcs coords

ds9.set(string cmd)
crosshair 100 100 physical # set crosshair in physical
crosshair 345 58.8 wcs fk5 # set crosshair in wcs coords
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.set(string cmd)
cursor 10 10

data

Return an array of data values given a lower left corner and a width and height in specified coordinate system. The last argument indicates if the coordinates are listed or just the data values.

Syntax:
data [<coordsys> [<skyframe>] <x> <y> <w> <h> [yes|no]]

Example:

string url = ds9.get(string cmd)

data image 450 520 3 3 yes
data physical 899 1039 6 6 no
data fk5 202.47091 47.196811 0.00016516669 0.00016516669 no
data wcs fk5 13:29:53.018 +47:11:48.52 0.00016516669 0.00016516669 no

datacube

Controls FITS datacube.

Syntax:
datacube [play|stop|next|prev|first|last]
         [#]
         [interval #]

Example:

string value = ds9.get(string cmd)
datacube
datacube interval

ds9.set(string cmd)
datacube play
datacube last
datacube 3
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:
 
string value = ds9.get(string cmd)
dsssao name
dsssao coord
dsssao size
dsssao save
dsssao frame

ds9.set(string cmd)
dsssao m31
dsssao name m31
dsssao coord 00:42:44.404 +41:16:08.78 sexagesimal
dsssao size 60 60 arcmin
dsssao save yes
dsssao frame current
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:
 
string value = ds9.get(string cmd)
dsseso name
dsseso coord
dsseso size
dsseso save
dsseso frame
dsseso survey

ds9.set(string cmd)
dsseso m31
dsseso name m31
dsseso coord 00:42:44.404 +41:16:08.78 sexagesimal
dsseso size 60 60 arcmin
dsseso save yes
dsseso frame current
dsseso update frame
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:

string value = ds9.get(string cmd)
dssstsci name
dssstsci coord
dssstsci size
dssstsci save
dssstsci frame
dssstsci survey

ds9.set(string cmd)
dssstsci m31
dssstsci name m31
dssstsci coord 00:42:44.404 +41:16:08.78 sexagesimal
dssstsci size 60 60 arcmin
dssstsci save yes
dssstsci frame current
dssstsci update frame
dssstsci survey all

exit
quit

Quits DS9.

Syntax:
exit
quit

Example:
 
ds9.set(string cmd)
exit

file

Load a FITS image, FITS Mosaic image(s), or array from a file into the current frame, or return the current file name(s) loaded for the current frame.

Syntax:
file [new|mask][<filename>]
     [new|mask][fits <filename>]
     [new|mask][sfits <filename> <filename>]
     [new|mask][medatacube <filename>]
     [new|mask][mosaicimage [iraf|wcs|wcsa...wcsz|wfpc2] <filename>]
     [new|mask][mosaic [iraf|wcs|wcsa...wcsz] <filename>]
     [new|mask][smosaic [iraf|wcs|wcsa...wcsz] <filename> <filename>]
     [new][multiframe <filename>]
     [new][rgbcube <filename>]
     [new][srgbcube <filename> <filename>]
     [new][rgbimage <filename>]
     [new][rgbarray <filename>[[xdim=<x>,ydim=<y>|dim=<dim>],zdim=3,bitpix=<b>,[skip=<s>]]]
     [new|mask][array <file>[[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,[skip=<s>]]
     [new][url <url>]
     [save <filename>]
     [save gz <filename>]
     [save resample <filename>]
     [save resample gz <filename>]

Example:
string value = ds9.get(string cmd)
file

ds9.set(string cmd)
file foo.fits
file mask foo.fits
file fits foo.fits
file sfits foo.hdr foo.arr
file medatacube foo.fits
file mosaicimage iraf bar.fits
file mosaicimage wcs bar.fits
file mosaicimage wcsa bar.fits
file mosaicimage wfpc2 hst.fits
file mosaic iraf foo.fits
file mosaic wcs bar.fits
file smosaic iraf foo.hdr foo.arr
file smosaic wcs bar.hdr bar.arr
file multiframe foo.fits
file rgbcube rgb.fits
file srgbcube rgb.hdr rgb.arr
file rgbimage rgb.fits
file rgbarray rgb.arr[dim=200,zdim=3,bitpix=-32]
file array array.arr[dim=512,bitpix=-32]
file url 'ftp://foo.bar.edu/img.fits'
file save foo.fits # save the current frame as FITS Image
file save gz foo.fits.gz # save as compressed FITS Image
file save resample foo.fits # save current pan/zoom/rotate as FITS Image
file save resample gz foo.fits.gz # save as compressed FITS Image

first

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:
string value = ds9.get(string cmd)
first name
first coord
first size
first save
first frame

ds9.set(string cmd)
first m31
first name m31
first coord 00:42:44.404 +41:16:08.78 sexagesimal
first size 60 60 arcmin
first save yes
first frame current
first update frame

fits

Load a FITS image from stdin into the current frame. Options can include the FITS extension or binning instructions. xpaget returns the FITS image in the current frame. If new is specified, a new frame is created before loading.

Syntax:
fits [size|width|height|depth|bitpix]
 
   [size [wcs|wcsa...wcsz] [fk4|fk5|icrs|galactic|ecliptic] [degrees|arcmin|arcsecs]]
     [type]
     [header [#] [keyword <string>]]
     [image|table|resample] [gz]
     [new|mask][<options>]
     [new
|mask][medatacube <options>]
     [new|mask][mosaicimage [iraf|wcs|wcsa...wcsz|wfpc2] <options>]
     [new|mask][mosaic [iraf|wcs|wcsa...wcsz] <options>]
     [new][rgbcube <options>]
     [new][rgbimage <options>]
     [save resample gz <filename>]

Example:
 
string value = ds9.get(string cmd)
fits size
fits width
fits height
fits depth
fits bitpix
fits size wcs fk5 arcmin
fits type
fits header keyword "'BITPIX'"
fits header 1 keyword "'BITPIX'"

string url = ds9.get(string cmd)
fits
fits image
fits image gz
fits table
fits table gz
fits resample
fits resample gz
fits header # primary
fits header 2 # hdu 2
fits header -2 # hdu 2 with inherit

ds9.set(string cmd, string url)
fits
fits [2]
fits new [bin=detx,dety]
fits medatacube
fits mosaicimage iraf
fits mosaicimage wcs
fits mosaicimage wcsa

fits mosaicimage wfpc2
fits mosaic iraf
fits mosaic wcs
fits rgbcube
fits rgbimage

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:

string value = ds9.get(string cmd)
frame # returns the id of the current frame
frame frameno # returns the id of the current frame
frame all # returns the id of all frames
frame active # returns the id of all active frames

ds9.set(string cmd)
frame center # center current frame
frame center 1 # center 'Frame1'
frame center all # center all frames
frame clear # clear current frame
frame new # create new frame
frame new rgb # create new rgb frame
frame delete # delete current frame
frame reset # reset current frame
frame refresh # refresh current frame
frame hide # hide current frame
frame show 1 # show frame 'Frame1'
frame move first # move frame to first in order
frame move back # move frame back in order
frame move forward # move frame forward in order
frame move last # move frame to last in order
frame first # goto first frame
frame prev # goto prev frame
frame next # goto next frame
frame last # goto last frame
frame frameno 4 # goto frame 'Frame4', create if needed
frame 3 # goto frame 'Frame3', create if needed

grid

Controls coordinate grid.

Syntax:
grid  []
      [yes|no]

      [type analysis|publication]
      [system <coordsys>]
      [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:

string value = ds9.get(string cmd)
grid
 
grid type
grid system
grid sky
grid skyformat

grid grid
grid grid color
grid grid width
grid grid style
grid grid gap1
grid grid gap2
 
grid axes
grid axes color
grid axes width
grid axes style
grid axes type
 
grid tick
grid tick color
grid tick width
grid tick style

grid border
grid border color
grid border width
grid border style

grid numlab
grid numlab font
grid numlab fontstyle
grid numlab fontsize
grid numlab color
grid numlab gap1
grid numlab gap2
grid numlab type
grid numlab vertical

grid title
grid title text
grid title def
grid title gap
grid title font
grid title fontstyle
grid title fontsize
grid title color

grid textlab
grid textlab text1
grid textlab def1
grid textlab gap1
grid textlab text2
grid textlab def2
grid textlab gap2
grid textlab font
grid textlab fontstyle
grid textlab fontsize
grid textlab color

ds9.set(string cmd)
grid
grid yes
 

grid type analysis
grid system wcs
grid sky fk5
grid skyformat degrees

grid grid yes
grid grid color red
grid grid width 2
grid grid style 1
grid grid gap1 10
grid grid gap2 10
 
grid axes yes
grid axes color red
grid axes width 2
grid axes style 1
grid axes type exterior
 
grid tick yes
grid tick color red
grid tick width 2
grid tick style 1

grid border yes
grid border color red
grid border width 2
grid border style 1

grid numlab yes
grid numlab font courier
grid numlab fontstyle bold
grid numlab fontsize 12
grid numlab color red
grid numlab gap1 10
grid numlab gap2 10
grid numlab type exterior
grid numlab vertical yes

grid title yes
grid title text {Hello World}
grid title def yes
grid title gap 10
grid title font courier
grid title fontstyle bold
grid title fontsize 12
grid title color red

grid textlab yes
grid textlab text1 {Hello World}
grid textlab def1 yes
grid textlab gap1 10
grid textlab text2 {Hello World}
grid textlab def2 yes
grid textlab gap2 10
grid textlab font courier
grid textlab fontstyle bold
grid textlab fontsize 12
grid textlab color red

grid reset
grid load foo.grd

grid save foo.grd

header

Display current fits header dialog. Optional extension number maybe specified. Please note, this differs from xpa fits header.

Syntax:
header [<value>]

Example:

string value = ds9.get(string cmd)
header
header 2

height

Set the height of the image display window.

Syntax:
height [<value>]

Example:

string value = ds9.get(string cmd)
height

ds9.set(string cmd)
height 512

iconify

Toggles iconification.

Syntax:
iconify []
        [yes|no]

Example:

string value = ds9.get(string cmd)
iconify

ds9.set(string cmd)
iconify
iconify yes

iis

Set/Get IIS Filename. Optional mosaic number maybe supplied.

Syntax:
iis [filename <filename> [#]]

Example:
 
string value = ds9.get(string cmd)
iis filename
iis filename 4

ds9.set(string cmd)
iis filename foo.fits
iis filename bar.fits 4

imexam

Interactive examine function. A blinking cursor will indicate to the user to click on a point on an image. The specified information will be returned at that time.

Syntax:
imexam [] [coordinate <coordsys> [<skyframe>] [<skyformat>]]
       [key] [coordinate <coordsys> [<skyframe>] [<skyformat>]]
       [any] [coordinate <coordsys> [<skyframe>] [<skyformat>]]
       [] [data [width][height]]
       [key] [data [width][height]]
      
[any] [data [width][height]]

Example:

string value = ds9.get(string cmd)
imexam coordinate image
imexam key coordinate image # return coordinate and key event
imexam any coordinate image # return coordinate and key/mouse event
imexam coordinate wcs fk5 degrees
imexam coordinate wcs galactic sexagesimal
imexam coordinate fk5
imexam data # return data value
imexam key data # return data value and key event
imexam any data # return data value and key/mouse event
imexam data 3 3 # return all data in 3x3 box about selected point

lock

Lock frames.

Syntax:
lock [crosshair none|wcs|wcsa...wcsz|physical|image]

Example:
 
ds9.set(string cmd)
lock crosshair wcs

lower

Lower ds9 in the window stacking order.

Syntax:
lower

Example:

ds9.set(string cmd)
lower

mask

Controls mask parameters.

Syntax:
mask [color <color>]
     [mark 1|0]
     [transparency <value>]
     [clear]

Example:

string value = ds9.get(string cmd)
mask color
mask mark
mask transparency

ds9.set(string cmd)
mask color red
mask mark 0
mask transparency 50
mask clear

match

Match all other frames to the current frame.

Syntax:
match [frames wcs|physical|image]
      [colorbars]
      [scales]

Example:
 
ds9.set(string cmd)
match frames wcs
match colorbars
match scales

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 [auto|scan|sample|datamin|irafmin]
       [mode auto|scan|sample|datamin|irafmin]
       [interval <value>]

Example:
 
string value = ds9.get(string cmd)
minmax mode
minmax interval

ds9.set(string cmd)
minmax scan
minmax mode scan
minmax interval 10

mode

Controls the first mouse button mode.

Syntax:
mode [none|pointer|crosshair|colorbar|pan|zoom|rotate|catalog|examine]

Example:
 
string value = ds9.get(string cmd)
mode

ds9.set(string cmd)
mode crosshair

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:
 

string value = ds9.get(string cmd)
nameserver
nameserver server
nameserver skyformat

ds9.set(string cmd)
nameserver m31
nameserver name m31
nameserver server ned-sao
nameserver skyformat sexagesimal
nameserver pan
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:
 
string value = ds9.get(string cmd)
nvss name
nvss coord
nvss size
nvss save
nvss frame

ds9.set(string cmd)
nvss m31
nvss name m31
nvss coord 00:42:44.404 +41:16:08.78 sexagesimal
nvss size 60 60 arcmin
nvss save yes
nvss frame current
nvss update frame

orient

Controls the orientation of the current frame.

Syntax:
orient [none|x|y|xy]

Example:
 
string value = ds9.get(string cmd)
orient

ds9.set(string cmd)
orient xy

pagesetup

Controls Page Setup options.

Syntax:
pagesetup [orientation portrait|landscape]
          [pagescale scaled|fixed]
          [pagesize letter|legal|tabloid|poster|a4]

Example:
 
string value = ds9.get(string cmd)
pagesetup orientation
pagesetup pagescale
pagesetup pagesize

ds9.set(string cmd)
pagesetup orientation portrait
pagesetup pagescale scaled
pagesetup pagesize poster

pan

Controls the current image cursor location for the current frame.

Syntax:
pan [x y <coordsys> [<skyframe>][<skyformat>]]
    [to x y <coordsys> [<skyframe>][<skyformat>]

Example:
 
string value = ds9.get(string cmd)
pan # get current image coords
pan wcs fk4 sexagesimal # get current wcs coords

ds9.set(string cmd)
pan 200 200 image # pan relative
pan to 400 400 physical # pan to physical coords
pan to 13:29:55 47:11:50 wcs fk5 # pan to wcs coords

pixeltable

Display/Hide the pixel table.

Syntax:
pixeltable [yes|no]

Example:
 
string url = ds9.get(string cmd)
pixeltable

ds9.set(string cmd)
pixeltable
pixeltable yes

plot

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 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>]]
     [new [name <plotname>] <title> <xaxis label> <yaxis label>  xy|xyex|xyey|xyexey]

# create new plot with data
plot [new [name <plotname>] stdin]
     [new [name <plotname>] <title> <xaxis label> <yaxis label>  xy|xyex|xyey|xyexey]

# load additional dataset into an existing plot
plot
[<plotname>] [data 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:
# return all plotnames
string value = ds9.get(string cmd)
plot

# create new empty plot window
ds9.set(string cmd)
plot
plot new
plot new name foo

# create new plot with data
ds9.set(string cmd, string url)
plot new stdin
plot new name foo stdin

plot new "{The Title}" "{X}" "{Y}" xy
plot new name foo "{The Title}" "
{X}" "{Y}" xy

# load additional dataset into an existing plot
ds9.set(string cmd, string url)
plot data xy # plot additional data
plot foo data xy # plot additional data

# edit existing plot
ds9.set(string cmd)
plot close # close last plot
plot foo close # close plot foo
plot clear # clear all datasets

ds9.set(string cmd)
plot load foo.dat xy # load new dataset with dimension xy
plot save bar.dat # save current dataset
plot loadconfig foo.plt # load plot configuration
plot saveconfig bar.plt # save current plot configuration

ds9.set(string cmd)
plot print
plot print destination file
plot print command "lp"
plot print filename "foo.ps"
plot print palette gray
plot page orientation portrait
plot page pagescale scaled
plot page pagesize letter

ds9.set(string cmd)
plot graph grid yes
plot graph scale loglog
plot graph range x auto yes
plot graph range x min 0
plot graph range x max 100
plot graph range y auto yes
plot graph range y min 0
plot graph range y max 100
plot graph labels title "{The Title}"
plot graph labels xaxis "{X}"
plot graph labels yaxis "{Y}"

ds9.set(string cmd)
plot font numbers font times
plot font numbers size 12
plot font numbers style bold
plot font labels font times
plot font title font times

# edit current dataset
ds9.set(string cmd)
plot dataset 2 # set current dataset to the second dataset loaded
plot view discrete yes
plot color discrete red
plot line discrete cross
plot line step width 2
plot line step dash yes
plot line error style 2

prefs

Controls various preference settings.

Syntax:
prefs [clear]
      [bgcolor &ltcolor>]
      [nancolor &ltcolor>]

Example:

string value = ds9.get(string cmd)
prefs bgcolor
prefs nancolor

ds9.set(string cmd)
prefs clear
prefs bgcolor black
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:

string value = ds9.get(string cmd)
preserve scale
preserve pan
preserve regions

ds9.set(string cmd)
preserve scale yes
preserve pan yes
preserve regions yes

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]
      [resolution 53|72|75|150|300|600]

Example:

string value = ds9.get(string cmd)
print destination
print command
print filename
print palette
print level
print resolution

ds9.set(string cmd)
print
print destination file
print command '{gv -}'
print filename foo.ps
print palette cmyk
print level 2
print resolution 75

raise

Raise ds9 in the window stacking order.

Syntax:
raise

Example:
ds9.set(string cmd)
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 &ltcolor>]
        [width <width>]
        [delim [nl|<char>]]
        [command <marker command>]

        [composite]
        [dissolve]

        [template <filename>]
        [template <filename> at <ra> <dec> <coordsys> <skyframe>]
        [savetemplate <filename>]

       
[groups]
        [group <tag>]
        [group <tag> color &ltcolor>]

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

        [include|exclude|source|background|selected]
        [-format ds9|ciao|saotng|saoimage|pros|xy]
        [-system image|physical|wcs|wcsa...wcsz]
        [-sky fk4|fk5|icrs|galactic|ecliptic]
        [-skyformat degrees|sexagesimal]
        [-delim [nl|<char>]]
        [-prop select|edit|move|rotate|delete|fixed|include|source 1|0]
        [-group <tag>]
        [-strip yes|no]
        [-wcs yes|no]

Example:

string url = ds9.get(string cmd)
regions
regions -format ds9 -system wcs -sky fk5 -skyformat sexagesimal -prop edit 1 -group foo

string value = ds9.get(string cmd)
regions show
regions showtext
regions autocentroid
regions selected
regions format
regions system
regions sky
regions skyformat
regions strip
regions shape
regions color
regions width
regions delim
regions source
regions background
regions include
regions exclude
regions selected
regions groups

ds9.set(string cmd, string url)
regions -format xy -system wcs -sky fk5
regions -format ds9

ds9.set(string cmd)
regions foo.reg
regions load foo.reg # load foo.reg into current frame
regions load all foo.reg # load foo.reg into all frames
regions load *.reg# expand *.reg and load into current frame
regions load all *.reg # expand *.reg and load into all frames
regions save foo.reg
regions list
regions show yes
regions showtext no
regions autocentroid yes
regions getinfo
regions move back
regions move front
regions select all
regions select none
regions select group foo
regions delete all

regions delete select
regions format ds9
regions system wcs
regions sky fk5
regions skyformat degrees
regions delim nl
regions strip yes
regions shape ellipse
regions color red
regions width 3
regions command "circle 100 100 20"

regions composite
regions dissolve

regions template foo.tpl
regions template foo.tpl at 13:29:55.92 +47:12:48.02 fk5
regions savetemplate foo.tpl

regions group foo color red
regions group foo copy

regions group foo delete

regions group foo cut

regions group foo font 'times 14 bold'

regions group foo move 100 100

regions group foo movefront

regions group foo moveback

regions group foo property delete no

regions group foo select

regions copy
regions cut
regions paste wcs fk5
regions undo

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 <coordsys>]
     [lock scale|bin|colorbar [yes|no]]

Example:


string value = ds9.get(string cmd)
rgb channel
rgb lock bin
rgb lock scale
rgb lock colorbar
rgb system
rgb view red
rgb view green
rgb view blue

ds9.set(string cmd)
rgb # create new rgb frame
rgb red # set current channel to red
rgb channel red # set current channel to red
rgb view blue no # turn off blue channel
rgb system wcs # set rgb coordinate system
rgb lock scale yes # lock rgb channels for scaling
rgb lock bin yes # lock rgb channels for binning
rgb lock colorbar yes # lock rgb colorbar channels

rotate

Controls the rotation angle (in degrees) of the current frame.

Syntax:
rotate [<value>]
       [to <value>]

Example:

string value = ds9.get(string cmd)
rotate

ds9.set(string cmd)
rotate 45
rotate to 30

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.set(string cmd)
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.set(string cmd)
savefits ds9.fits

savempeg

Save all active frames as a mpeg movie.

Syntax:
savempeg [<filename>]

Example:
ds9.set(string cmd)
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:

string value = ds9.get(string cmd)
scale
scale datasec
scale limits
scale mode
scale scope

ds9.set(string cmd)
scale datasec yes
scale histequ
scale limits 1 100
scale mode zscale
scale mode 99.5
scale scope local

shm

Load a shared memory segment into the current frame.

Syntax:
shm [<key> [<filename>]]
    [key <key> [<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> [<filename>]]
    [rgbcube [key|shmid] <id> [<filename>]
    [srgbcube [key|shmid] <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>]]
    [startload|finishload]

Example:
 
string value = ds9.get(string cmd)
shm

ds9.set(string cmd)
shm 102
shm key 102
shm shmid 102 foo

shm fits key 100 foo
shm sfits key 100 101 foo
shm mosaicimage iraf key 100 foo
shm mosaicimage wcs key 100 foo
shm mosaicimage wcsa key 100 foo
shm mosaicimage wfpc2 key 100 foo
shm mosaicimagenext wcs key 100 foo
shm mosaic iraf key 100 foo
shm mosaic wcs key 100 foo
shm smosaic wcs key 100 101 foo
shm rgbcube key 100 foo
shm srgbcube key 100 101 foo
shm rgbimage key 100 foo
shm rgbarray key 100 [dim=200,zdim=3,bitpix=-32]
shm array shmid 102 [dim=32,bitpix=-32]
shm startload # start a multiple load sequence without updating the display
shm finishload # finish multiple load sequence

single

Select Single Display mode

Syntax:
single

Example:

string value = ds9.get(string cmd)
single

ds9.set(string cmd)
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:

string value = ds9.get(string cmd)
skyview name
skyview coord
skyview size
skyview save
skyview frame
skyview survey

ds9.set(string cmd)
skyview m31
skyview name m31
skyview coord 00:42:44.404 +41:16:08.78 sexagesimal
skyview size 60 60 arcmin
skyview save yes
skyview frame current
skyview update frame
skyview survey sdssi

sleep

Delays execution for specified number of seconds.

Syntax:
sleep [#]

Example:
ds9.set(string cmd)
sleep 2

smooth

Smooth current image or set smooth parameters.

Syntax:
smooth []
       [yes|no]
       [function boxcar|tophat|gaussian]
       [radius <int>]

Example:

string value = ds9.get(string cmd)
smooth
smooth function
smooth radius

ds9.set(string cmd)
smooth
smooth yes
smooth function tophat
smooth radius 4

source

Source tcl code from a file.

Syntax:
source [filename]

Example:
ds9.set(string cmd)
source foo.tcl

tcl

Execute one tcl command. Must be enabled via the -tcl command line option.

Syntax:
tcl [<tcl command>]

Example:
ds9.set(string cmd)
tcl puts "Hello, World"

ds9.set(string cmd, string url)
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:

string value = ds9.get(string cmd)
tile
tile mode
tile grid mode
tile grid layout
tile grid gap

ds9.set(string cmd)
tile
tile yes

tile mode row
tile grid
tile grid mode manual
tile grid layout 5 5
tile grid gap 10
tile row
tile column

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.set(string cmd)
update
update 1 100 100 300 400
update now
update now 1 100 100 300 400
update off # delay refresh of the screen while loading files
update on # be sure to turn it on when you are finished loading

version

Returns the current version of DS9.

Syntax:
version

Example:

string value = ds9.get(string cmd)
version

view

Controls the GUI.

Syntax:
view  [layout horizontal|vertical]
      [info yes|no]
      [panner yes|no]
      [magnifier yes|no]
      [buttons yes|no]
      [colorbar yes|no]
      [colorbar horizontal|vertical]
      [colorbar numerics 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:
 
string value = ds9.get(string cmd)
view layout
view info
view panner
view magnifier
view buttons
view colorbar
view graph horizontal
view filename
view object
view minmax
view lowhigh
view frame
view image
view wcsa
view red

ds9.set(string cmd)
view layout vertical
view info yes
view panner yes
view magnifier yes
view buttons yes
view colorbar yes
view graph horizontal yes
view filename yes
view object yes
view minmax yes
view lowhigh yes
view frame yes
view wcsa yes
view red yes
view green no
view blue yes

vo

Invoke an connection to a Virtual Observatory site.

Syntax:
vo [method xpa|mime]
   [server <url>]
   [internal yes|no]
   [<url>]
   [connect <url>]
   [disconnect <url>]

Example:
 
string value = ds9.get(string cmd)
vo method
vo server
vo internal
vo connect

ds9.set(string cmd)
vo method xpa
vo server "http://foo.bar.edu/list.txt"
vo internal yes
vo chandra-ed
vo connect chandra-ed
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, using this access point, a new WCS specification can be loaded and used by the current image regardless of the WCS that was contained in the image file. WCS specification can be sent to DS9 as an ASCII 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:

string value = ds9.get(string cmd)
wcs
wcs system
wcs sky
wcs skyformat
wcs align

ds9.set(string cmd)
wcs wcs
wcs system wcs
wcs wcsa
wcs sky fk5
wcs skyformat sexagesimal
wcs align yes
wcs reset
wcs replace foo.wcs
wcs append foo.wcs

ds9.set(string cmd, string url)
wcs replace
wcs append

web

Display specified URL in the web display.

Syntax:
web [new|<webname>] [<url>]
    [<webname>] [click back|forward|stop|reload|#]
    [<webname>] [clear]
    [<webname>] [close]

Example:
 
string value = ds9.get(string cmd)
web

ds9.set(string cmd)
web www.cnn.com
web new www.cnn.com
web hvweb www.apple.com
web click back
web click 2
web clear
web close

width

Set the width of the image display window.

Syntax:
width [<value>]

Example:
 
string value = ds9.get(string cmd)
width

ds9.set(string cmd)
width 512

zscale

Set Scale Limits based  on the IRAF algorithm.

Syntax:
zscale []
       [contrast]
       [sample]
       [line]

Example:

string value = ds9.get(string cmd)
zscale contrast
zscale sample
zscale line

ds9.set(string cmd)
zscale
zscale contrast .25
zscale sample 600
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:

string value = ds9.get(string cmd)
zoom

ds9.set(string cmd)
zoom 2
zoom 2 4
zoom to 4
zoom to 2 4
zoom to fit