XPA Access Points

The XPA messaging system provides seamless communication between DS9 and other Unix programs, including X programs, Perl, S-Lang, and Tcl/Tk. It also provides an easy way for users to communicate with DS9 by executing XPA client commands in the shell or by utilizing such commands in scripts. Because XPA works both at the programming level and the shell level, it is a powerful tool for unifying any analysis environment.

2mass
about
analysis
array
bin
blink
catalog
cd
cmap
colorbar
console
contour
crosshair
cursor
data
datacube
dsssao
dsseso
dssstsci
exit
file
first
fits
frame
grid
header
height
iconify
iis
imexam
lock
lower
magnifier
mask
match
minmax
mode
nameserver
nvss
orient
pagesetup
pan
pixeltable
plot
prefs
preserve
psprint
print
quit
raise
regions
rgb
rotate
saveimage
savefits
savempeg
scale
shm
single
skyview
sleep
smooth
source
tcl
tile
update
version
view
vo
wcs
web
width
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]
      [open|close]
 
Example:
$xpaget ds9 2mass name
$xpaget ds9 2mass coord
$xpaget ds9 2mass size
$xpaget ds9 2mass save
$xpaget ds9 2mass frame
$xpaget ds9 2mass survey
$xpaset -p ds9 2mass m31
$xpaset -p ds9 2mass name m31
$xpaset -p ds9 2mass coord 00:42:44.404 +41:16:08.78 sexagesimal
$xpaset -p ds9 2mass size 60 60 arcmin
$xpaset -p ds9 2mass save yes
$xpaset -p ds9 2mass frame current
$xpaset -p ds9 2mass update frame
$xpaset -p ds9 2mass survey j
$xpaset -p ds9 2mass open
$xpaset -p ds9 2mass close

about

Get DS9 credits.

Syntax:
about
 
Example:
$xpaget ds9 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>]
         [task <task number>|<task name>]
         [load <filename>]
         [clear]
         [clear][load <filename>]
         [message ok|okcancel|yesno <message>]
         [entry <message>]
         [text]
 
Example:
$xpaget ds9 analysis
$xpaget ds9 analysis task
$xpaget ds9 analysis entry 'Please enter something'
$xpaget ds9 analysis entry okcancel 'Please enter something'
$xpaset -p ds9 analysis 0 # invoke first analysis task
$xpaset -p ds9 analysis task 0
$xpaset -p ds9 analysis task foobar
$xpaset -p ds9 analysis "{foo bar}"
$xpaset -p ds9 analysis my.ans
$xpaset -p ds9 analysis load my.ans
$xpaset -p ds9 analysis clear
$xpaset -p ds9 analysis clear load my.ans
$xpaset -p ds9 analysis message ok {This is a message}
$xpaset -p ds9 analysis text {this is text}
$cat my.ans | xpaset ds9 analysis load
$cat foo.txt | xpaset ds9 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:
$xpaget ds9 array # default bigendian
$xpaget ds9 array littleendian
$cat foo.arr | xpaset ds9 array [dim=512,bitpix=16]
$cat foo.arr | xpaset ds9 array mask [dim=512,bitpix=16]
$cat rgb.arr | xpaset ds9 array rgb [dim=200,zdim=3,bitpix=8]
$cat bar.arr | xpaset ds9 array [xdim=512,ydim=512,zdim=1,bitpix=16] # load 512x512 short
$cat bar.arr | xpaset ds9 array [dim=256,bitpix=-32,skip=4] # 256x256 float with 4 byte head
$cat bar.arr | xpaset ds9 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]
    [open|close]
 
Example:
$xpaget ds9 bin about
$xpaget ds9 bin buffersize
$xpaget ds9 bin cols
$xpaget ds9 bin factor
$xpaget ds9 bin depth
$xpaget ds9 bin filter
$xpaget ds9 bin function
$xpaget ds9 bin smooth
$xpaget ds9 bin smooth function
$xpaget ds9 bin smooth radius
$xpaset -p ds9 bin about 4096 4096
$xpaset -p ds9 bin about center
$xpaset -p ds9 bin buffersize 512
$xpaset -p ds9 bin cols detx dety
$xpaset -p ds9 bin colsz detx dety time
$xpaset -p ds9 bin factor 4
$xpaset -p ds9 bin factor 4 2
$xpaset -p ds9 bin depth 10
$xpaset -p ds9 bin filter '{pha > 5}'
$xpaset -p ds9 bin filter ''
$xpaset -p ds9 bin function sum
$xpaset -p ds9 bin to fit
$xpaset -p ds9 bin open
$xpaset -p ds9 bin close

blink

Blink mode parameters. Interval is in seconds.

Syntax:
blink []
      [yes|no]
      [interval <value>]
 
Example:
$xpaget ds9 blink
$xpaget ds9 blink interval
$xpaset -p ds9 blink
$xpaset -p ds9 blink yes
$xpaset -p ds9 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|skybot]
        [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|font|fontsize|fontweight|fontslant <value>]
        [<catname>] [symbol [#] 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>] [system <coordsys>]
        [<catname>] [sky <skyframe>]
        [<catname>] [show|hide]
        [<catname>] [edit yes|no]
        [<catname>] [panto yes|no]
 
Example:
$xpaget ds9 catalog
$xpaget ds9 catalog header
$xpaget ds9 catalog cat2mass header
$xpaset -p ds9 catalog
$xpaset -p ds9 catalog 2mass
$xpaset -p ds9 catalog cds 2mass
$xpaset -p ds9 catalog cds "I/252"
$xpaset -p ds9 catalog load foo.cat
$xpaset -p ds9 catalog load xml foo.xml
$xpaset -p ds9 catalog samp broadcast
$xpaset -p ds9 catalog samp send aladin
$xpaset -p ds9 catalog cat2mass symbol color red
$xpaset -p ds9 catalog name m51
$xpaset -p ds9 catalog coordinate 202.48 47.21 fk5
$xpaset -p ds9 catalog size 22 22 arcmin
$xpaset -p ds9 catalog save bar.cat
$xpaset -p ds9 catalog save xml bar.xml
$xpaset -p ds9 catalog filter "\$Jmag>10"
$xpaset -p ds9 catalog filter load foo.flt
$xpaset -p ds9 catalog clear
$xpaset -p ds9 catalog retrieve
$xpaset -p ds9 catalog cancel
$xpaset -p ds9 catalog print
$xpaset -p ds9 catalog close
$xpaset -p ds9 catalog server sao
$xpaset -p ds9 catalog symbol condition "\$Jmag>15"
$xpaset -p ds9 catalog symbol 2 shape "boxcircle point"
$xpaset -p ds9 catalog symbol color red
$xpaset -p ds9 catalog font times
$xpaset -p ds9 catalog fontsize 14
$xpaset -p ds9 catalog fontweight bold
$xpaset -p ds9 catalog fontslant italic
$xpaset -p ds9 catalog symbol add
$xpaset -p ds9 catalog symbol 2 remove
$xpaset -p ds9 catalog symbol load foo.sym
$xpaset -p ds9 catalog symbol save bar.sym
$xpaset -p ds9 catalog sort "Jmag" incr
$xpaset -p ds9 catalog maxrows 2000
$xpaset -p ds9 catalog allrows
$xpaset -p ds9 catalog allcols
$xpaset -p ds9 catalog ra RA
$xpaset -p ds9 catalog dec DEC
$xpaset -p ds9 catalog system wcs
$xpaset -p ds9 catalog sky fk5
$xpaset -p ds9 catalog show
$xpaset -p ds9 catalog hide
$xpaset -p ds9 catalog edit yes
$xpaset -p ds9 catalog panto no

cd

Sets/Returns the current working directory.

Syntax:
cd [<directory>]
 
Example:
$xpaget ds9 cd
$xpaset -p 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 <constrast> <bias>]
     [open|close]
 
Example:
$xpaget ds9 cmap
$xpaget ds9 cmap file
$xpaget ds9 cmap invert
$xpaget ds9 cmap value
$xpaset -p ds9 cmap Heat
$xpaset -p ds9 cmap file foo.sao
$xpaset -p ds9 cmap invert yes
$xpaset -p ds9 cmap value 5 .5
$xpaset -p ds9 cmap open
$xpaset -p ds9 cmap close

colorbar

Controls colorbar parameters.

Syntax:
colorbar [yes|no]
         [horizontal|vertical]
         [orientation horizontal|vertical]
         [numerics yes|no]
         [space value|distance]
         [font times|helvetica|courier]
         [fontsize <value>]
         [fontweight normal|bold]
         [fontslant roman|italic]
         [size]
         [ticks]
 
Example:
$xpaget ds9 colorbar
$xpaget ds9 colorbar orientation
$xpaget ds9 colorbar numerics
$xpaget ds9 colorbar space
$xpaget ds9 colorbar font
$xpaget ds9 colorbar fontsize
$xpaget ds9 colorbar fontweight
$xpaget ds9 colorbar fontslant
$xpaget ds9 colorbar size
$xpaget ds9 colorbar ticks
$xpaset -p ds9 colorbar yes
$xpaset -p ds9 colorbar vertical
$xpaset -p ds9 colorbar orientation vertical
$xpaset -p ds9 colorbar numerics yes
$xpaset -p ds9 colorbar space value
$xpaset -p ds9 colorbar font times
$xpaset -p ds9 colorbar fontsize 14
$xpaset -p ds9 colorbar fontweight bold
$xpaset -p ds9 colorbar fontslant italic
$xpaset -p ds9 colorbar size 20
$xpaset -p ds9 colorbar ticks 11

console

Display tcl console window.

Syntax:
-console
 
Example:
$xpaset -p ds9 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> <color> <width> yes|no]
        [color <color>]
        [width <width>]
        [dash yes|no]
        [smooth <smooth>]
        [method block|smooth]
        [nlevels <number of levels>]
        [scale linear|log|pow|squared|sqrt|histequ]
        [log exp <value>]
        [mode minmax|<value>|zscale|zmax]
        [limits <min> <max>]
        [levels <value value value...>]
        [open|close]
 
Example:
$xpaget ds9 contour
$xpaget ds9 contour wcs fk5
$xpaget ds9 contour color
$xpaget ds9 contour width
$xpaget ds9 contour dash
$xpaget ds9 contour smooth
$xpaget ds9 contour method
$xpaget ds9 contour nlevels
$xpaget ds9 contour scale
$xpaget ds9 contour log exp
$xpaget ds9 contour mode
$xpaget ds9 contour limits
$xpaget ds9 contour levels
$xpaset -p ds9 contour
$xpaset -p ds9 contour yes
$xpaset -p ds9 contour clear
$xpaset -p ds9 contour generate
$xpaset -p ds9 contour load ds9.con wcs fk5 yellow 2 no # solid line
$xpaset -p ds9 contour load ds9.con wcs fk5 red 2 yes # dashed line
$xpaset -p ds9 contour save ds9.con wcs fk5
$xpaset -p ds9 contour convert
$xpaset -p ds9 contour loadlevels ds9.lev
$xpaset -p ds9 contour savelevels ds9.lev
$xpaset -p ds9 contour copy
$xpaset -p ds9 contour paste wcs red 2 no
$xpaset -p ds9 contour color yellow
$xpaset -p ds9 contour width 2
$xpaset -p ds9 contour dash yes
$xpaset -p ds9 contour smooth 5
$xpaset -p ds9 contour method smooth
$xpaset -p ds9 contour nlevels 10
$xpaset -p ds9 contour scale sqrt
$xpaset -p ds9 contour log exp 1000
$xpaset -p ds9 contour mode zscale
$xpaset -p ds9 contour limits 1 100
$xpaset -p ds9 contour levels "{1 10 100 1000}"
$xpaset -p ds9 contour open
$xpaset -p ds9 contour close

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:
$xpaget ds9 crosshair # get crosshair in physical coords
$xpaget ds9 crosshair wcs fk4 sexagesimal # get crosshair in wcs coords
$xpaset -p ds9 crosshair 100 100 physical # set crosshair in physical
$xpaset -p ds9 crosshair 345 58.8 wcs fk5 # set crosshair in wcs coords
$xpaset -p 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:
$xpaset -p ds9 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 of yes indicates to strip the coordinates from the output and just list the data values. The default is yes.

Syntax:
data [<coordsys> [<skyframe>] <x> <y> <w> <h> [yes|no]]
 
Example:
$xpaget ds9 data image 450 520 3 3 yes
$xpaget ds9 data physical 899 1039 6 6 no
$xpaget ds9 data fk5 202.47091 47.196811 0.00016516669 0.00016516669 no
$xpaget ds9 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 #]
         [axis #]
         [open|close]
 
Example:
$xpaget ds9 datacube
$xpaget ds9 datacube interval
$xpaget ds9 datacube axis
$xpaset -p ds9 datacube play
$xpaset -p ds9 datacube last
$xpaset -p ds9 datacube 3
$xpaset -p ds9 datacube interval 2
$xpaset -p ds9 datacube axis 3
$xpaset -p ds9 datacube open
$xpaset -p ds9 datacube close

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]
       [open|close]
 
Example:
$xpaget ds9 dsssao name
$xpaget ds9 dsssao coord
$xpaget ds9 dsssao size
$xpaget ds9 dsssao save
$xpaget ds9 dsssao frame
$xpaset -p ds9 dsssao m31
$xpaset -p ds9 dsssao name m31
$xpaset -p ds9 dsssao coord 00:42:44.404 +41:16:08.78 sexagesimal
$xpaset -p ds9 dsssao size 60 60 arcmin
$xpaset -p ds9 dsssao save yes
$xpaset -p ds9 dsssao frame current
$xpaset -p ds9 dsssao update frame
$xpaset -p ds9 dsssao open
$xpaset -p ds9 dsssao close

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]
       [open|close]
 
Example:
$xpaget ds9 dsseso name
$xpaget ds9 dsseso coord
$xpaget ds9 dsseso size
$xpaget ds9 dsseso save
$xpaget ds9 dsseso frame
$xpaget ds9 dsseso survey
$xpaset -p ds9 dsseso m31
$xpaset -p ds9 dsseso name m31
$xpaset -p ds9 dsseso coord 00:42:44.404 +41:16:08.78 sexagesimal
$xpaset -p ds9 dsseso size 60 60 arcmin
$xpaset -p ds9 dsseso save yes
$xpaset -p ds9 dsseso frame current
$xpaset -p ds9 dsseso update frame
$xpaset -p ds9 dsseso survey DSS2-red
$xpaset -p ds9 dsseso open
$xpaset -p ds9 dsseso close

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]
         [open|close]
 
Example:
$xpaget ds9 dssstsci name
$xpaget ds9 dssstsci coord
$xpaget ds9 dssstsci size
$xpaget ds9 dssstsci save
$xpaget ds9 dssstsci frame
$xpaget ds9 dssstsci survey
$xpaset -p ds9 dssstsci m31
$xpaset -p ds9 dssstsci name m31
$xpaset -p ds9 dssstsci coord 00:42:44.404 +41:16:08.78 sexagesimal
$xpaset -p ds9 dssstsci size 60 60 arcmin
$xpaset -p ds9 dssstsci save yes
$xpaset -p ds9 dssstsci frame current
$xpaset -p ds9 dssstsci update frame
$xpaset -p ds9 dssstsci survey all
$xpaset -p ds9 dssstsci open
$xpaset -p ds9 dssstsci close

exit
quit

Quits DS9.

Syntax:
exit
quit
 
Example:
$xpaset -p ds9 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:
$xpaget ds9 file
$xpaset -p ds9 file foo.fits
$xpaset -p ds9 file mask foo.fits
$xpaset -p ds9 file fits foo.fits
$xpaset -p ds9 file sfits foo.hdr foo.arr
$xpaset -p ds9 file medatacube foo.fits
$xpaset -p ds9 file mosaicimage iraf bar.fits
$xpaset -p ds9 file mosaicimage wcs bar.fits
$xpaset -p ds9 file mosaicimage wcsa bar.fits
$xpaset -p ds9 file mosaicimage wfpc2 hst.fits
$xpaset -p ds9 file mosaic iraf foo.fits
$xpaset -p ds9 file mosaic wcs bar.fits
$xpaset -p ds9 file smosaic iraf foo.hdr foo.arr
$xpaset -p ds9 file smosaic wcs bar.hdr bar.arr
$xpaset -p ds9 file multiframe foo.fits
$xpaset -p ds9 file rgbcube rgb.fits
$xpaset -p ds9 file srgbcube rgb.hdr rgb.arr
$xpaset -p ds9 file rgbimage rgb.fits
$xpaset -p ds9 file rgbarray rgb.arr[dim=200,zdim=3,bitpix=-32]
$xpaset -p ds9 file array array.arr[dim=512,bitpix=-32]
$xpaset -p ds9 file url 'ftp://foo.bar.edu/img.fits'
$xpaset -p ds9 file save foo.fits # save the current frame as FITS Image
$xpaset -p ds9 file save gz foo.fits.gz # save as compressed FITS Image
$xpaset -p ds9 file save resample foo.fits # save current pan/zoom/rotate as FITS Image
$xpaset -p ds9 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]
      [open|close]
 
Example:
$xpaget ds9 first name
$xpaget ds9 first coord
$xpaget ds9 first size
$xpaget ds9 first save
$xpaget ds9 first frame
$xpaset -p ds9 first m31
$xpaset -p ds9 first name m31
$xpaset -p ds9 first coord 00:42:44.404 +41:16:08.78 sexagesimal
$xpaset -p ds9 first size 60 60 arcmin
$xpaset -p ds9 first save yes
$xpaset -p ds9 first frame current
$xpaset -p ds9 first update frame
$xpaset -p ds9 first open
$xpaset -p ds9 first close

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:
$xpaget ds9 fits > foo.fits
$xpaget ds9 fits size
$xpaget ds9 fits width
$xpaget ds9 fits height
$xpaget ds9 fits depth
$xpaget ds9 fits bitpix
$xpaget ds9 fits size wcs fk5 arcmin
$xpaget ds9 fits type
$xpaget ds9 fits header # primary
$xpaget ds9 fits header 2 # hdu 2
$xpaget ds9 fits header -2 # hdu 2 with inherit
$xpaget ds9 fits header keyword "'BITPIX'"
$xpaget ds9 fits header 1 keyword "'BITPIX'"
$xpaget ds9 fits image > foo.fits
$xpaget ds9 fits image gz > foo.fits.gz
$xpaget ds9 fits table > bar.fits
$xpaget ds9 fits table gz > bar.fits.gz
$xpaget ds9 fits resample > bar.fits
$xpaget ds9 fits resample gz > bar.fits.gz
$cat foo.fits | xpaset ds9 fits
$cat abc.fits | xpaset ds9 fits [2]
$cat bar.fits | xpaset ds9 fits new [bin=detx,dety]
$cat foo.fits | xpaset ds9 fits medatacube
$cat bar.fits | xpaset ds9 fits mosaicimage iraf
$cat bar.fits | xpaset ds9 fits mosaicimage wcs
$cat bar.fits | xpaset ds9 fits mosaicimage wcsa
$cat hst.fits | xpaset ds9 fits mosaicimage wfpc2
$cat bar.fits | xpaset ds9 fits mosaic iraf
$cat bar.fits | xpaset ds9 fits mosaic wcs
$cat rgb.fits | xpaset ds9 fits rgbcube
$cat rgb.fits | xpaset ds9 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 #]
      [#]
      [has [amplifier|datamin|datasec|detector|grid|iis|irafmin|physical|smooth]]
      [has contour [aux]]]
      [has fits [ |bin|cube|mosaic]]
      [has marker [highlite|paste|select|undo]]
      [has system <coordsys>]
      [has wcs [<wcssys>|equatorial <wcssys>|linear <wcssys>]]
 
Example:
$xpaget ds9 frame # returns the id of the current frame
$xpaget ds9 frame frameno # returns the id of the current frame
$xpaget ds9 frame all # returns the id of all frames
$xpaget ds9 frame active # returns the id of all active frames
$xpaget ds9 frame has amplifier
$xpaget ds9 frame has datamin
$xpaget ds9 frame has datasec
$xpaget ds9 frame has detector
$xpaget ds9 frame has grid
$xpaget ds9 frame has iis
$xpaget ds9 frame has irafmin
$xpaget ds9 frame has physical
$xpaget ds9 frame has smooth
$xpaget ds9 frame has contour
$xpaget ds9 frame has contour aux
$xpaget ds9 frame has fits
$xpaget ds9 frame has fits bin
$xpaget ds9 frame has fits cube
$xpaget ds9 frame has fits mosaic
$xpaget ds9 frame has marker highlite
$xpaget ds9 frame has marker paste
$xpaget ds9 frame has marker select
$xpaget ds9 frame has marker undo
$xpaget ds9 frame has system physical
$xpaget ds9 frame has wcs wcsa
$xpaget ds9 frame has wcs equatorial wcsa
$xpaget ds9 frame has wcs linear wcsa
$xpaset -p ds9 frame center # center current frame
$xpaset -p ds9 frame center 1 # center 'Frame1'
$xpaset -p ds9 frame center all # center all frames
$xpaset -p ds9 frame clear # clear current frame
$xpaset -p ds9 frame new # create new frame
$xpaset -p ds9 frame new rgb # create new rgb frame
$xpaset -p ds9 frame delete # delete current frame
$xpaset -p ds9 frame reset # reset current frame
$xpaset -p ds9 frame refresh # refresh current frame
$xpaset -p ds9 frame hide # hide current frame
$xpaset -p ds9 frame show 1 # show frame 'Frame1'
$xpaset -p ds9 frame move first # move frame to first in order
$xpaset -p ds9 frame move back # move frame back in order
$xpaset -p ds9 frame move forward # move frame forward in order
$xpaset -p ds9 frame move last # move frame to last in order
$xpaset -p ds9 frame first # goto first frame
$xpaset -p ds9 frame prev # goto prev frame
$xpaset -p ds9 frame next # goto next frame
$xpaset -p ds9 frame last # goto last frame
$xpaset -p ds9 frame frameno 4 # goto frame 'Frame4', create if needed
$xpaset -p ds9 frame 3 # goto frame 'Frame3', create if needed

grid

Controls coordinate grid. For grid numeric format syntax,  click here.

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]
      [format1 <format>]
      [format2 <format>]
      [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]
      [numlab fontsize <value>]
      [numlab fontweight normal|bold]
      [numlab fontslant roman|italic]
      [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]
      [title fontsize <value>]
      [title fontweight normal|bold]
      [title fontslant roman|italic]
      [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]
      [textlab fontsize <value>]
      [textlab fontweight normal|bold]
      [textlab fontslant roman|italic]
      [textlab color <color>]
      [reset]
      [load <filename>]
      [save <filename>]
      [open|close]
 
Example:
$xpaget ds9 grid
$xpaget ds9 grid type
$xpaget ds9 grid system
$xpaget ds9 grid sky
$xpaget ds9 grid skyformat
$xpaget ds9 grid grid
$xpaget ds9 grid grid color
$xpaget ds9 grid grid width
$xpaget ds9 grid grid style
$xpaget ds9 grid grid gap1
$xpaget ds9 grid grid gap2
$xpaget ds9 grid axes
$xpaget ds9 grid axes color
$xpaget ds9 grid axes width
$xpaget ds9 grid axes style
$xpaget ds9 grid axes type
$xpaget ds9 grid format1
$xpaget ds9 grid format2
$xpaget ds9 grid tick
$xpaget ds9 grid tick color
$xpaget ds9 grid tick width
$xpaget ds9 grid tick style
$xpaget ds9 grid border
$xpaget ds9 grid border color
$xpaget ds9 grid border width
$xpaget ds9 grid border style
$xpaget ds9 grid numlab
$xpaget ds9 grid numlab font
$xpaget ds9 grid numlab fontsize
$xpaget ds9 grid numlab fontweight
$xpaget ds9 grid numlab fontslant
$xpaget ds9 grid numlab color
$xpaget ds9 grid numlab gap1
$xpaget ds9 grid numlab gap2
$xpaget ds9 grid numlab type
$xpaget ds9 grid numlab vertical
$xpaget ds9 grid title
$xpaget ds9 grid title text
$xpaget ds9 grid title def
$xpaget ds9 grid title gap
$xpaget ds9 grid title font
$xpaget ds9 grid title fontsize
$xpaget ds9 grid title fontweight
$xpaget ds9 grid title fontslant
$xpaget ds9 grid title color
$xpaget ds9 grid textlab
$xpaget ds9 grid textlab text1
$xpaget ds9 grid textlab def1
$xpaget ds9 grid textlab gap1
$xpaget ds9 grid textlab text2
$xpaget ds9 grid textlab def2
$xpaget ds9 grid textlab gap2
$xpaget ds9 grid textlab font
$xpaget ds9 grid textlab fontsize
$xpaget ds9 grid textlab fontweight
$xpaget ds9 grid textlab fontslant
$xpaget ds9 grid textlab color
$xpaset -p ds9 grid
$xpaset -p ds9 grid yes
$xpaset -p ds9 grid type analysis
$xpaset -p ds9 grid system wcs
$xpaset -p ds9 grid sky fk5
$xpaset -p ds9 grid skyformat degrees
$xpaset -p ds9 grid grid yes
$xpaset -p ds9 grid grid color red
$xpaset -p ds9 grid grid width 2
$xpaset -p ds9 grid grid style 1
$xpaset -p ds9 grid grid gap1 10
$xpaset -p ds9 grid grid gap2 10
$xpaset -p ds9 grid axes yes
$xpaset -p ds9 grid axes color red
$xpaset -p ds9 grid axes width 2
$xpaset -p ds9 grid axes style 1
$xpaset -p ds9 grid axes type exterior
$xpaset -p ds9 grid format1 d.2
$xpaset -p ds9 grid format2 d.2
$xpaset -p ds9 grid tick yes
$xpaset -p ds9 grid tick color red
$xpaset -p ds9 grid tick width 2
$xpaset -p ds9 grid tick style 1
$xpaset -p ds9 grid border yes
$xpaset -p ds9 grid border color red
$xpaset -p ds9 grid border width 2
$xpaset -p ds9 grid border style 1
$xpaset -p ds9 grid numlab yes
$xpaset -p ds9 grid numlab font courier
$xpaset -p ds9 grid numlab fontsize 12
$xpaset -p ds9 grid numlab fontweight bold
$xpaset -p ds9 grid numlab fontslant italic
$xpaset -p ds9 grid numlab color red
$xpaset -p ds9 grid numlab gap1 10
$xpaset -p ds9 grid numlab gap2 10
$xpaset -p ds9 grid numlab type exterior
$xpaset -p ds9 grid numlab vertical yes
$xpaset -p ds9 grid title yes
$xpaset -p ds9 grid title text {Hello World}
$xpaset -p ds9 grid title def yes
$xpaset -p ds9 grid title gap 10
$xpaset -p ds9 grid title font courier
$xpaset -p ds9 grid title fontsize 12
$xpaset -p ds9 grid title fontweight bold
$xpaset -p ds9 grid title fontslant italic
$xpaset -p ds9 grid title color red
$xpaset -p ds9 grid textlab yes
$xpaset -p ds9 grid textlab text1 {Hello World}
$xpaset -p ds9 grid textlab def1 yes
$xpaset -p ds9 grid textlab gap1 10
$xpaset -p ds9 grid textlab text2 {Hello World}
$xpaset -p ds9 grid textlab def2 yes
$xpaset -p ds9 grid textlab gap2 10
$xpaset -p ds9 grid textlab font courier
$xpaset -p ds9 grid textlab fontsize 12
$xpaset -p ds9 grid textlab fontweight boldj
$xpaset -p ds9 grid textlab fontslant italic
$xpaset -p ds9 grid textlab color red
$xpaset -p ds9 grid reset
$xpaset -p ds9 grid load foo.grd
$xpaset -p ds9 grid save foo.grd
$xpaset -p ds9 grid open
$xpaset -p ds9 grid close

header

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

Syntax:
header [<value>]
       [close [<value>]]
 
Example:
$xpaset -p ds9 header
$xpaset -p ds9 header 2
$xpaset -p ds9 header close

height

Set the height of the image display window.

Syntax:
height [<value>]
 
Example:
$xpaget ds9 height
$xpaset -p ds9 height 512

iconify

Toggles iconification.

Syntax:
iconify []
        [yes|no]
 
Example:
$xpaget ds9 iconify
$xpaset -p ds9 iconify
$xpaset -p ds9 iconify yes

iis

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

Syntax:
iis [filename <filename> [#]]
 
Example:
$xpaget ds9 iis filename
$xpaget ds9 iis filename 4
$xpaset -p ds9 iis filename foo.fits
$xpaset -p ds9 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:
$xpaget ds9 imexam coordinate image
$xpaget ds9 imexam key coordinate image # return coordinate and key event
$xpaget ds9 imexam any coordinate image # return coordinate and key/mouse event
$xpaget ds9 imexam coordinate wcs fk5 degrees
$xpaget ds9 imexam coordinate wcs galactic sexagesimal
$xpaget ds9 imexam coordinate fk5
$xpaget ds9 imexam data # return data value
$xpaget ds9 imexam key data # return data value and key event
$xpaget ds9 imexam any data # return data value and key/mouse event
$xpaget ds9 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:
$xpaset -p ds9 lock crosshair wcs

lower

Lower in the window stacking order.

Syntax:
lower
 
Example:
$xpaset -p ds9 lower

pmagnifier

Controls the magnifier settings.

Syntax:
magnifier [color <color>]
          [zoom <value>]
          [cursor yes|no]
          [region yes|no]
 
Example:
$xpaget ds9 magnifier color
$xpaget ds9 magnifier zoom
$xpaget ds9 magnifier cursor
$xpaget ds9 magnifier region
$xpaset -p ds9 magnifier color yellow
$xpaset -p ds9 magnifier zoom 2
$xpaset -p ds9 magnifier cursor no
$xpaset -p ds9 magnifier region no

mask

Controls mask parameters.

Syntax:
mask [color <color>]
     [mark 1|0]
     [transparency <value>]
     [clear]
     [open|close]
 
Example:
$xpaget ds9 mask color
$xpaget ds9 mask mark
$xpaget ds9 mask transparency
$xpaset -p ds9 mask color red
$xpaset -p ds9 mask mark 0
$xpaset -p ds9 mask transparency 50
$xpaset -p ds9 mask clear
$xpaset -p ds9 mask open
$xpaset -p ds9 mask close

match

Match all other frames to the current frame.

Syntax:
match [frames wcs|physical|image]
      [colorbars]
      [scales]
      [bin]
 
Example:
$xpaset -p ds9 match frames wcs
$xpaset -p ds9 match colorbars
$xpaset -p ds9 match scales
$xpaset -p ds9 match bin

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:
$xpaget ds9 minmax mode
$xpaget ds9 minmax interval
$xpaset -p ds9 minmax scan
$xpaset -p ds9 minmax mode scan
$xpaset -p ds9 minmax interval 10

mode

Controls the first mouse button mode.

Syntax:
mode [none|pointer|crosshair|colorbar|pan|zoom|rotate|catalog|examine]
 
Example:
$xpaget ds9 mode
$xpaset -p ds9 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]
           [open|close]

Example:
$xpaget ds9 nameserver
$xpaget ds9 nameserver server
$xpaget ds9 nameserver skyformat
$xpaget ds9 nameserver m31
$xpaset -p ds9 nameserver m31
$xpaset -p ds9 nameserver name m31
$xpaset -p ds9 nameserver server ned-sao
$xpaset -p ds9 nameserver skyformat sexagesimal
$xpaset -p ds9 nameserver pan
$xpaset -p ds9 nameserver crosshair
$xpaset -p ds9 nameserver open
$xpaset -p ds9 nameserver close

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]
     [open|close]
 
Example:
$xpaget ds9 nvss name
$xpaget ds9 nvss coord
$xpaget ds9 nvss size
$xpaget ds9 nvss save
$xpaget ds9 nvss frame
$xpaset -p ds9 nvss m31
$xpaset -p ds9 nvss name m31
$xpaset -p ds9 nvss coord 00:42:44.404 +41:16:08.78 sexagesimal
$xpaset -p ds9 nvss size 60 60 arcmin
$xpaset -p ds9 nvss save yes
$xpaset -p ds9 nvss frame current
$xpaset -p ds9 nvss update frame
$xpaset -p ds9 nvss open
$xpaset -p ds9 nvss close

orient

Controls the orientation of the current frame.

Syntax:
orient [none|x|y|xy]
       [open|close]
 
Example:
$xpaget ds9 orient
$xpaset -p ds9 orient xy
$xpaset -p ds9 orient open
$xpaset -p ds9 orient close

pagesetup

Controls Page Setup options.

Syntax:
pagesetup [orientation portrait|landscape]
          [pagescale scaled|fixed]
          [pagesize letter|legal|tabloid|poster|a4]
 
Example:
$xpaget ds9 pagesetup orientation
$xpaget ds9 pagesetup pagescale
$xpaget ds9 pagesetup pagesize
$xpaset -p ds9 pagesetup orientation portrait
$xpaset -p ds9 pagesetup pagescale scaled
$xpaset -p ds9 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>]
    [open|close]
 
Example:
$xpaget ds9 pan # get current image coords
$xpaget ds9 pan wcs fk4 sexagesimal # get current wcs coords
$xpaset -p ds9 pan 200 200 image # pan relative
$xpaset -p ds9 pan to 400 400 physical # pan to physical coords
$xpaset -p ds9 pan to 13:29:55 47:11:50 wcs fk5 # pan to wcs coords
$xpaset -p ds9 pan open
$xpaset -p ds9 pan close

pixeltable

Display/Hide the pixel table.

Syntax:
pixeltable []
           [yes|open]
           [no|close]
 
Example:
$xpaget ds9 pixeltable
$xpaset -p ds9 pixeltable
$xpaset -p ds9 pixeltable yes
$xpaset -p ds9 pixeltable open
$xpaset -p ds9 pixeltable close

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|courier]
     [<plotname>] [font numbers|labels|title size <value>]
     [<plotname>] [font numbers|labels|title weight normal|bold]
     [<plotname>] [font numbers|labels|title slant roman|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
$xpaget ds9 plot
# create new empty plot window
$xpaset -p ds9 plot
$xpaset -p ds9 plot new
$xpaset -p ds9 plot new name foo
# create new plot with data
$cat foo.dat | xpaset ds9 plot new stdin
$cat foo.dat | xpaset ds9 plot new name foo stdin
$cat bar.dat | xpaset ds9 plot new "{The Title}" "{X}" "{Y}" xy
$cat bar.dat | xpaset ds9 plot new name foo "{The Title}" "{X}" "{Y}" xy
# load additional dataset into an existing plot
$cat bar.dat | xpaset ds9 plot data xy # plot additional data
$cat bar.dat | xpaset ds9 plot foo data xy # plot additional data
# edit existing plot
$xpaset -p ds9 plot close # close last plot
$xpaset -p ds9 plot foo close # close plot foo
$xpaset -p ds9 plot clear # clear all datasets
$xpaset -p ds9 plot load foo.dat xy # load new dataset with dimension xy
$xpaset -p ds9 plot save bar.dat # save current dataset
$xpaset -p ds9 plot loadconfig foo.plt # load plot configuration
$xpaset -p ds9 plot saveconfig bar.plt # save current plot configuration
$xpaset -p ds9 plot print
$xpaset -p ds9 plot print destination file
$xpaset -p ds9 plot print command "lp"
$xpaset -p ds9 plot print filename "foo.ps"
$xpaset -p ds9 plot print palette gray
$xpaset -p ds9 plot page orientation portrait
$xpaset -p ds9 plot page pagescale scaled
$xpaset -p ds9 plot page pagesize letter
$xpaset -p ds9 plot graph grid yes
$xpaset -p ds9 plot graph scale loglog
$xpaset -p ds9 plot graph range x auto yes
$xpaset -p ds9 plot graph range x min 0
$xpaset -p ds9 plot graph range x max 100
$xpaset -p ds9 plot graph range y auto yes
$xpaset -p ds9 plot graph range y min 0
$xpaset -p ds9 plot graph range y max 100
$xpaset -p ds9 plot graph labels title {The Title}
$xpaset -p ds9 plot graph labels xaxis {X}
$xpaset -p ds9 plot graph labels yaxis {Y}
$xpaset -p ds9 plot font numbers font times
$xpaset -p ds9 plot font numbers size 12
$xpaset -p ds9 plot font numbers weight bold
$xpaset -p ds9 plot font numbers slant italic
$xpaset -p ds9 plot font labels font times
$xpaset -p ds9 plot font title font times
# edit current dataset
$xpaset -p ds9 plot dataset 2 # set current dataset to the second dataset loaded
$xpaset -p ds9 plot view discrete yes
$xpaset -p ds9 plot color discrete red
$xpaset -p ds9 plot line discrete cross
$xpaset -p ds9 plot line step width 2
$xpaset -p ds9 plot line step dash yes
$xpaset -p ds9 plot line error style 2

prefs

Controls various preference settings.

Syntax:
prefs [clear]
      [bgcolor <color>]
      [nancolor <color>]
 
Example:
$xpaget ds9 prefs bgcolor
$xpaget ds9 prefs nancolor
$xpaget ds9 prefs magnifier
$xpaset -p ds9 prefs clear
$xpaset -p ds9 prefs bgcolor black
$xpaset -p 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:
$xpaget ds9 preserve scale
$xpaget ds9 preserve pan
$xpaget ds9 preserve regions
$xpaset -p ds9 preserve scale yes
$xpaset -p ds9 preserve pan yes
$xpaset -p ds9 preserve regions yes

psprint

For MacOSX and Windows, invokes postscript printing. For all others, same as print. Please see print for further details.

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:
$xpaget ds9 print destination
$xpaget ds9 print command
$xpaget ds9 print filename
$xpaget ds9 print palette
$xpaget ds9 print level
$xpaget ds9 print resolution
$xpaset -p ds9 print
$xpaset -p ds9 print destination file
$xpaset -p ds9 print command '{gv -}'
$xpaset -p ds9 print filename foo.ps
$xpaset -p ds9 print palette cmyk
$xpaset -p ds9 print level 2
$xpaset -p ds9 print resolution 75

raise

Raise in the window stacking order.

Syntax:
raise
 
Example:
$xpaset -p ds9 raise

regions

Controls regions in the current frame.

Syntax:
regions [<filename>]
        [load [all] <filename>]
        [save <filename>]
        [list [close]]
        [show yes|no]
        [showtext yes|no]
        [centroid]
        [centroid auto yes|no]
        [centroid radius <value>|iteration <value>]
        [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]
        [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:
$xpaget ds9 regions
$xpaget ds9 regions -format ds9 -system wcs -sky fk5 -skyformat sexagesimal -prop edit 1 -group foo
$xpaget ds9 regions show
$xpaget ds9 regions showtext
$xpaget ds9 regions centroid auto
$xpaget ds9 regions centroid radius
$xpaget ds9 regions centroid iteration
$xpaget ds9 regions selected
$xpaget ds9 regions format
$xpaget ds9 regions system
$xpaget ds9 regions sky
$xpaget ds9 regions skyformat
$xpaget ds9 regions strip
$xpaget ds9 regions shape
$xpaget ds9 regions color
$xpaget ds9 regions width
$xpaget ds9 regions delim
$xpaget ds9 regions source
$xpaget ds9 regions background
$xpaget ds9 regions include
$xpaget ds9 regions exclude
$xpaget ds9 regions selected
$xpaget ds9 regions groups
$cat foo.reg | xpaset ds9 regions -format xy -system wcs -sky fk5
$cat bar.reg | xpaget ds9 regions -format ds9
$echo "image; circle 100 100 20" | xpaset ds9 regions
$echo "image; circle 100 100 20" | xpaset ds9 regions
$echo "fk5; circle 13:29:55 47:11:50 .5'" | xpaset ds9 regions
$echo "physical; ellipse 100 100 20 40" | xpaset ds9 regions
$echo "box 100 100 20 40 25" | xpaset ds9 regions
$echo "image; line 100 100 200 400" | xpaset ds9 regions
$echo "physical; ruler 200 300 200 400" | xpaset ds9 regions
$echo "image; text 100 100 # text={Hello, World}" | xpaset ds9 regions
$echo "fk4; boxcircle point 13:29:55 47:11:50" | xpaset ds9 regions
$xpaset -p ds9 regions foo.reg
$xpaset -p ds9 regions -format ciao bar.reg # load as ciao format
$xpaset -p ds9 regions foo.fits # FITS regions files do not need a format specification
$xpaset -p ds9 regions load foo.reg # load foo.reg into current frame
$xpaset -p ds9 regions load all foo.reg # load foo.reg into all frames
$xpaset -p ds9 regions load '*.reg'# expand *.reg and load into current frame
$xpaset -p ds9 regions load all '*.reg' # expand *.reg and load into all frames
$xpaset -p ds9 regions save foo.reg
$xpaset -p ds9 regions list
$xpaset -p ds9 regions list close
$xpaset -p ds9 regions show yes
$xpaset -p ds9 regions showtext no
$xpaset -p ds9 regions centroid
$xpaset -p ds9 regions centroid auto yes
$xpaset -p ds9 regions centroid radius 10
$xpaset -p ds9 regions centroid iteration 20
$xpaset -p ds9 regions getinfo
$xpaset -p ds9 regions move back
$xpaset -p ds9 regions move front
$xpaset -p ds9 regions select all
$xpaset -p ds9 regions select none
$xpaset -p ds9 regions select group foo
$xpaset -p ds9 regions delete all
$xpaset -p ds9 regions delete select
$xpaset -p ds9 regions format ds9
$xpaset -p ds9 regions system wcs
$xpaset -p ds9 regions sky fk5
$xpaset -p ds9 regions skyformat degrees
$xpaset -p ds9 regions delim nl
$xpaset -p ds9 regions strip yes
$xpaset -p ds9 regions shape ellipse
$xpaset -p ds9 regions color red
$xpaset -p ds9 regions width 3
$xpaset -p ds9 regions command {circle 100 100 20}
$xpaset -p ds9 regions composite
$xpaset -p ds9 regions dissolve
$xpaset -p ds9 regions template foo.tpl
$xpaset -p ds9 regions template foo.tpl at 13:29:55.92 +47:12:48.02 fk5
$xpaset -p ds9 regions savetemplate foo.tpl
$xpaset -p ds9 regions group foo color red
$xpaset -p ds9 regions group foo copy
$xpaset -p ds9 regions group foo delete
$xpaset -p ds9 regions group foo cut
$xpaset -p ds9 regions group foo font {times 14 bold}
$xpaset -p ds9 regions group foo move 100 100
$xpaset -p ds9 regions group foo movefront
$xpaset -p ds9 regions group foo moveback
$xpaset -p ds9 regions group foo property delete no
$xpaset -p ds9 regions group foo select
$xpaset -p ds9 regions copy
$xpaset -p ds9 regions cut
$xpaset -p ds9 regions paste wcs
$xpaset -p ds9 regions undo

rgb

Create RGB frame and control RGB frame parameters.

Syntax:
rgb  []
     [red|green|blue]
     [channel [red|green|blue]]
     [view [red|green|blue] [yes|no]]
     [system <coordsys>]
     [lock scale|bin|colorbar|slice|smooth [yes|no]]
     [open|close]
 
Example:
$xpaget ds9 rgb channel
$xpaget ds9 rgb lock bin
$xpaget ds9 rgb lock scale
$xpaget ds9 rgb lock colorbar
$xpaget ds9 rgb lock slice
$xpaget ds9 rgb lock smooth
$xpaget ds9 rgb system
$xpaget ds9 rgb view red
$xpaget ds9 rgb view green
$xpaget ds9 rgb view blue
$xpaset -p ds9 rgb # create new rgb frame
$xpaset -p ds9 rgb red # set current channel to red
$xpaset -p ds9 rgb channel red # set current channel to red
$xpaset -p ds9 rgb view blue no # turn off blue channel
$xpaset -p ds9 rgb system wcs # set rgb coordinate system
$xpaset -p ds9 rgb lock scale yes # lock rgb channels for scaling
$xpaset -p ds9 rgb lock bin yes # lock rgb channels for binning
$xpaset -p ds9 rgb lock colorbar yes # lock rgb colorbar channels
$xpaset -p ds9 rgb lock slice yes # lock rgb slice channels
$xpaset -p ds9 rgb lock smooth yes # lock rgb smooth channels
$xpaset -p ds9 rgb open
$xpaset -p ds9 rgb close

rotate

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

Syntax:
rotate [<value>]
       [to <value>]
       [open|close]

Example:
$xpaget ds9 rotate
$xpaset -p ds9 rotate 45
$xpaset -p ds9 rotate to 30
$xpaset -p ds9 rotate open
$xpaset -p ds9 rotate close

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 <filename>
saveimage jpeg [1-100] <filename>
saveimage tiff [none|jpeg|packbits|deflate] <filename>
saveimage png <filename>
saveimage ppm <filename>
saveimage mpeg [1-31] <filename>

 
Example:
$xpaset -p ds9 saveimage fits ds9.fits
$xpaset -p ds9 saveimage jpeg 75 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:
$xpaset -p ds9 savefits ds9.fits

savempeg

Save all active frames as a mpeg movie.

Syntax:
savempeg [<filename>]
 
Example:
$xpaset -p ds9 savempeg ds9.mpg

scale

Controls the limits, color scale distribution, and use of DATASEC keyword.

Syntax:
scale [linear|log|pow|sqrt|squared|histequ]
      [log exp <value>]
      [datasec yes|no]
      [limits <minvalue> <maxvalue>]
      [mode minmax|<value>|zscale|zmax]
      [scope local|global]
      [open|close]

Example:
$xpaget ds9 scale
$xpaget ds9 scale log exp
$xpaget ds9 scale datasec
$xpaget ds9 scale limits
$xpaget ds9 scale mode
$xpaget ds9 scale scope
$xpaset -p ds9 scale linear
$xpaset -p ds9 scale log 100
$xpaset -p ds9 scale datasec yes
$xpaset -p ds9 scale histequ
$xpaset -p ds9 scale limits 1 100
$xpaset -p ds9 scale mode zscale
$xpaset -p ds9 scale mode 99.5
$xpaset -p ds9 scale scope local
$xpaset -p ds9 scale open
$xpaset -p ds9 scale close

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:
$xpaget ds9 shm
$xpaset -p ds9 shm 102
$xpaset -p ds9 shm key 102
$xpaset -p ds9 shm shmid 102 foo
$xpaset -p ds9 shm fits key 100 foo
$xpaset -p ds9 shm sfits key 100 101 foo
$xpaset -p ds9 shm mosaicimage iraf key 100 foo
$xpaset -p ds9 shm mosaicimage wcs key 100 foo
$xpaset -p ds9 shm mosaicimage wcsa key 100 foo
$xpaset -p ds9 shm mosaicimage wfpc2 key 100 foo
$xpaset -p ds9 shm mosaicimagenext wcs key 100 foo
$xpaset -p ds9 shm mosaic iraf key 100 foo
$xpaset -p ds9 shm mosaic wcs key 100 foo
$xpaset -p ds9 shm smosaic wcs key 100 101 foo
$xpaset -p ds9 shm rgbcube key 100 foo
$xpaset -p ds9 shm srgbcube key 100 101 foo
$xpaset -p ds9 shm rgbimage key 100 foo
$xpaset -p ds9 shm rgbarray key 100 [dim=200,zdim=3,bitpix=-32]
$xpaset -p ds9 shm array shmid 102 [dim=32,bitpix=-32]
$xpaset -p ds9 shm startload # start a multiple load sequence without updating the display
$xpaset -p ds9 shm finishload # finish multiple load sequence

single

Select Single Display mode

Syntax:
single
 
Example:
$xpaget ds9 single
$xpaset -p 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]
        [open|close]

Example:
$xpaget ds9 skyview name
$xpaget ds9 skyview coord
$xpaget ds9 skyview size
$xpaget ds9 skyview save
$xpaget ds9 skyview frame
$xpaget ds9 skyview survey
$xpaset -p ds9 skyview m31
$xpaset -p ds9 skyview name m31
$xpaset -p ds9 skyview coord 00:42:44.404 +41:16:08.78 sexagesimal
$xpaset -p ds9 skyview size 60 60 arcmin
$xpaset -p ds9 skyview save yes
$xpaset -p ds9 skyview frame current
$xpaset -p ds9 skyview update frame
$xpaset -p ds9 skyview survey sdssi
$xpaset -p ds9 skyview open
$xpaset -p ds9 skyview close

sleep

Delays execution for specified number of seconds. Default is 1 second.

Syntax:
sleep [#]
 
Example:
$xpaset -p ds9 sleep
$xpaset -p ds9 sleep 2

smooth

Smooth current image or set smooth parameters.

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

Example:
$xpaget ds9 smooth
$xpaget ds9 smooth function
$xpaget ds9 smooth radius
$xpaset -p ds9 smooth
$xpaset -p ds9 smooth yes
$xpaset -p ds9 smooth function tophat
$xpaset -p ds9 smooth radius 4
$xpaset -p ds9 smooth open
$xpaset -p ds9 smooth close

source

Source TCL code from a file.

Syntax:
source [filename]
 
Example:
$xpaset -p ds9 source foo.tcl

tcl

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

Syntax:
tcl [<tcl command>]
 
Example:
$echo 'puts "Hello, World"' | xpaset ds9 tcl
$xpaset -p ds9 tcl 'puts "Hello, World"'

tile

Controls the tile display mode.

Syntax:
tile []
     [yes|no]
     [mode grid|column|row]
     [grid]
     [grid mode [automatic|manual]]
     [grid layout <col> <row>]
     [grid gap <pixels>]
     [row]
     [column]
 
Example:
$xpaget ds9 tile
$xpaget ds9 tile mode
$xpaget ds9 tile grid mode
$xpaget ds9 tile grid layout
$xpaget ds9 tile grid gap
$xpaset -p ds9 tile
$xpaset -p ds9 tile yes
$xpaset -p ds9 tile mode row
$xpaset -p ds9 tile grid
$xpaset -p ds9 tile grid mode manual
$xpaset -p ds9 tile grid layout 5 5
$xpaset -p ds9 tile grid gap 10
$xpaset -p ds9 tile row
$xpaset -p ds9 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:
$xpaset -p ds9 update
$xpaset -p ds9 update 1 100 100 300 400
$xpaset -p ds9 update now
$xpaset -p ds9 update now 1 100 100 300 400
$xpaset -p ds9 update off # delay refresh of the screen while loading files
$xpaset -p ds9 update on # be sure to turn it on when you are finished loading

version

Returns the current version of DS9.

Syntax:
version
 
Example:
$xpaget ds9 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:
$xpaget ds9 view layout
$xpaget ds9 view info
$xpaget ds9 view panner
$xpaget ds9 view magnifier
$xpaget ds9 view buttons
$xpaget ds9 view colorbar
$xpaget ds9 view graph horizontal
$xpaget ds9 view filename
$xpaget ds9 view object
$xpaget ds9 view minmax
$xpaget ds9 view lowhigh
$xpaget ds9 view frame
$xpaget ds9 view image
$xpaget ds9 view wcsa
$xpaget ds9 view red
$xpaset -p ds9 view layout vertical
$xpaset -p ds9 view info yes
$xpaset -p ds9 view panner yes
$xpaset -p ds9 view magnifier yes
$xpaset -p ds9 view buttons yes
$xpaset -p ds9 view colorbar yes
$xpaset -p ds9 view graph horizontal yes
$xpaset -p ds9 view filename yes
$xpaset -p ds9 view object yes
$xpaset -p ds9 view minmax yes
$xpaset -p ds9 view lowhigh yes
$xpaset -p ds9 view frame yes
$xpaset -p ds9 view wcsa yes
$xpaset -p ds9 view red yes
$xpaset -p ds9 view green no
$xpaset -p ds9 view blue yes

vo

Invoke an connection to a Virtual Observatory site.

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

Example:
$xpaget ds9 vo
$xpaget ds9 vo method
$xpaget ds9 vo server
$xpaget ds9 vo internal
$xpaget ds9 vo delay
$xpaget ds9 vo connect
$xpaset -p ds9 vo method xpa
$xpaset -p ds9 vo server "http://foo.bar.edu/list.txt"
$xpaset -p ds9 vo internal yes
$xpaset -p ds9 vo delay 15 # keep-alive delay
$xpaset -p ds9 vo chandra-ed
$xpaset -p ds9 vo connect chandra-ed
$xpaset -p ds9 vo disconnect chandra-ed
$xpaset -p ds9 vo open
$xpaset -p ds9 vo close

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

Example:
$xpaget ds9 wcs
$xpaget ds9 wcs system
$xpaget ds9 wcs sky
$xpaget ds9 wcs skyformat
$xpaget ds9 wcs align
$xpaset -p ds9 wcs wcs
$xpaset -p ds9 wcs system wcs
$xpaset -p ds9 wcs wcsa
$xpaset -p ds9 wcs sky fk5
$xpaset -p ds9 wcs skyformat sexagesimal
$xpaset -p ds9 wcs align yes
$xpaset -p ds9 wcs reset
$xpaset -p ds9 wcs reset 3
$xpaset -p ds9 wcs replace foo.wcs
$xpaset -p ds9 wcs replace 3 foo.wcs
$xpaset -p ds9 wcs append foo.wcs
$xpaset -p ds9 wcs append 3 foo.wcs
$cat foo.wcs | xpaset ds9 wcs replace
$cat foo.wcs | xpaset ds9 wcs append
$echo "OBJECT = 'foobar'" | xpaset ds9 wcs append
$xpaset -p ds9 open
$xpaset -p ds9 close

web

Display specified URL in the web display.

Syntax:
web [new|<webname>] [<url>]
    [<webname>] [click back|forward|stop|reload|#]
    [<webname>] [clear]
    [<webname>] [close]
 
Example:
$xpaget ds9 web
$xpaset -p ds9 web www.cnn.com
$xpaset -p ds9 web new www.cnn.com
$xpaset -p ds9 web hvweb www.apple.com
$xpaset -p ds9 web click back
$xpaset -p ds9 web click 2
$xpaset -p ds9 web clear
$xpaset -p ds9 web close

width

Set the width of the image display window.

Syntax:
width [<value>]
 
Example:
$xpaget ds9 width
$xpaset -p ds9 width 512

zscale

Set Scale Limits based  on the IRAF algorithm.

Syntax:
zscale []
       [contrast]
       [sample]
       [line]
 
Example:
$xpaget ds9 zscale contrast
$xpaget ds9 zscale sample
$xpaget ds9 zscale line
$xpaset -p ds9 zscale
$xpaset -p ds9 zscale contrast .25
$xpaset -p ds9 zscale sample 600
$xpaset -p 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]
     [open|close]
 
Example:
$xpaget ds9 zoom
$xpaset -p ds9 zoom 2
$xpaset -p ds9 zoom 2 4
$xpaset -p ds9 zoom to 4
$xpaset -p ds9 zoom to 2 4
$xpaset -p ds9 zoom to fit
$xpaset -p ds9 zoom open
$xpaset -p ds9 zoom close