Command Line Options

From b736fb52cd792aed5816a911577d17867cb31d05 Mon Sep 17 00:00:00 2001 From: William Joye Date: Thu, 10 Oct 2019 14:37:38 -0400 Subject: udate tests --- ds9/doc/ref/command.html | 5047 +++++++++++++++++++------------------ ds9/doc/ref/samp.html | 6203 ++++++++++++++++++++++++---------------------- ds9/doc/ref/xpa.html | 6002 +++++++++++++++++++++++--------------------- 3 files changed, 9071 insertions(+), 8181 deletions(-) diff --git a/ds9/doc/ref/command.html b/ds9/doc/ref/command.html index eda5e1a..c191f93 100644 --- a/ds9/doc/ref/command.html +++ b/ds9/doc/ref/command.html @@ -1,2386 +1,2669 @@ - - - - -Command Line Options - - -

Command Line Options

-
DS9 will process each command line option, one at a time, as the last step in the initialization process. Therefore, it is possible to use command line options as a little script. For example, the following command line option is used:
-$ds9 -tile foo.fits -cmap Heat -zscale bar.fits -cmap I8 -
First DS9 is put in tile mode, then foo.fits is loaded. Then the colormap for foo.fits is changed to Heat and the scale changed to zscale. Next, bar.fits is loaded and the colormap for bar.fits is changed to I8.
-2mass -3d -about -align -analysis -array -asinh -background -backup -bin -blink -block -blue -catalog -cd -cmap -colorbar -console -contour -crop -crosshair -cube -cursor -dsssao -dsseso -dssstsci -envi -exit -export -fifo -fifo_only -fits -frame -geometry -gif -green -grid -header -height -help -histequ -iconify -inet_only -invert -iis -jpeg -language -linear -lock -log -lower -magnifier -mask -match -mecube -minmax -mode -mosaic -mosaicimage -movie -msg -multiframe -nameserver -nan -nrrd -nvss -orient -pagesetup -pan -pixeltable -plot -png -precision -prefs -preserve -psprint -print -port -port_only -pow -quit -raise -regions -red -restore -rgb -rgbarray -rgbcube -rgbimage -rotate -samp -save -saveimage -scale -shm -sia -single -sinh -skyview -sleep -slice -smooth -squared -sqrt -source -tcl -threads -tiff -tile -title -unix -unix_only -update -url -version -view -visual -vla -vlss -vo -wcs -web -width -xpa -zmax -zoom -zscale
-
2mass
-
Support for 2MASS Digital Sky Survey.
-Syntax: --2mass [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # 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: -$ds9 -2mass -$ds9 -2mass m31 -$ds9 -2mass name m31 -$ds9 -2mass name clear -$ds9 -2mass 00:42:44.404 +41:16:08.78 -$ds9 -2mass size 60 60 arcmin -$ds9 -2mass save yes -$ds9 -2mass frame current -$ds9 -2mass update frame -$ds9 -2mass survey j -$ds9 -2mass open -$ds9 -2mass close -
3d
-
Support for 3D frame.
-Syntax: --3d [] -    [view <az> <el>] -    [az <az>] -    [el <el>] -    [scale <scale>] -    [method mip|aip] -    [background none|azimuth|elevation] -    [border yes|no] -    [border color] -    [highlite yes|no] -    [highlite color] -    [compass yes|no] -    [compass color] -    [match] -    [lock [yes|no]] -    [open|close] - -Example: -$ds9 -3d # create new 3D frame -$ds9 -3d view 45 30 -$ds9 -3d az 45 -$ds9 -3d el 30 -$ds9 -3d scale 10 -$ds9 -3d method mip -$ds9 -3d background azimuth -$ds9 -3d border yes -$ds9 -3d border color red -$ds9 -3d highlite yes -$ds9 -3d highlite color red -$ds9 -3d compass yes -$ds9 -3d compass color red -$ds9 -3d match -$ds9 -3d lock yes -$ds9 -3d open -$ds9 -3d close
-
about
-
Get DS9 credits.
-Syntax: --about - -Example: -$ds9 -about -
align
-
Controls the World Coordinate System alignment for the current frame.
-Syntax: --align [yes|no] - -Example: -$ds9 -align yes -
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: -$ds9 -analysis 0 # invoke first analysis task -$ds9 -analysis task 0 -$ds9 -analysis task foobar -$ds9 -analysis task {foo bar} -$ds9 -analysis my.ans -$ds9 -analysis load my.ans -$ds9 -analysis clear -$ds9 -analysis clear load my.ans -$ds9 -analysis message {This is a message} -$ds9 -analysis text {This is text} -
array
-
Load raw data array into current frame.
-Syntax: --array <filename> [[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,endian=[little|big]] - -Example: -$ds9 -array foo.arr[dim=512,bitpix=-32,endian=little] -$cat foo.arr | ds9 -array -[dim=512,bitpix=-32,endian=little] -
asinh
-
Select ASINH scale function for the current frame.
-Syntax: --asinh - -Example: -$ds9 -asinh
-
bg
-background
-
Set image background color.
-Syntax: --bg <color> - -Example: -$ds9 -background red -$ds9 -bg red
-
backup
-
Create a backup save set.
-Syntax: --backup <filename> - -Example: -$ds9 -backup ds9.bck
-
bin
-
Controls binning factor, binning buffer size, and binning function for binning FITS bin tables.
-Syntax: --bin [about <x> <y>] -    [about center] -    [buffersize <value>] -    [cols <x> <y>] -    [colsz <x> <y> <z>] -    [factor <value> [<value>]] -    [depth <value>] -    [filter <string>] -    [filter clear] -    [function average|sum] -    [in] -    [out] -    [to fit] -    [match] -    [lock [yes|no]] -    [open|close] - -Example: -$ds9 -bin about 4096 4096 -$ds9 -bin about center -$ds9 -bin buffersize 512 -$ds9 -bin cols detx dety -$ds9 -bin colsz detx dety time -$ds9 -bin factor 4 -$ds9 -bin factor 4 2 -$ds9 -bin depth 10 -$ds9 -bin filter 'pha > 5' -$ds9 -bin filter clear -$ds9 -bin function sum -$ds9 -bin in -$ds9 -bin out -$ds9 -bin to fit -$ds9 -bin match -$ds9 -bin lock yes -$ds9 -bin open -$ds9 -bin close -
blink
-
Blink mode parameters. Interval is in seconds.
-Syntax: --blink [] -    [yes|no] -    [interval <value>] - -Example: -$ds9 -blink -$ds9 -blink yes -$ds9 -blink interval 1
-
block
-
Controls blocking parameters.
-Syntax: --block[<value>] -    [<value> <value>] -    [to <value>] -    [to <value> <value>] -    [in] -    [out] -    [to fit] -    [match] -    [lock [yes|no]] -    [open|close] - -Example: -$ds9-block4 -$ds9-block4 2 -$ds9-blockto 4 -$ds9-blockto 4 2 -$ds9-blockin -$ds9-blockout -$ds9-blockto fit -$ds9-blockmatch -$ds9-blocklock yes -$ds9-blockopen -$ds9-blockclose -
blue
-
For RGB frames, sets the current color channel to blue.
-Syntax: --blue - -Example: -$ds9 -blue foo.fits -
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 [new] -    [ned|simbad|denis|skybot] -    [aavso|ac|ascss|cmc|gaia|gsc1|gsc2|gsc3|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|sdss9|tycho] -    [ua2|ub1|ucac2|ucac2sup|ucac3|ucac4|urat1] -    [2mass|iras] -    [csc|xmm|rosat] -    [first|nvss] -    [chandralog|cfhtlog|esolog|stlog|xmmlog] -    [cds <catalogname>] -    [cds <catalogid>] - -    [load <filename>] -    [import sb|tsv <filename>] - -    [<ref>] [<ra> <dec> <coordsys>] -    [<ref>] [allcols] -    [<ref>] [allrows] -    [<ref>] [cancel] -    [<ref>] [clear] -    [<ref>] [close] -    [<ref>] [crosshair] -    [<ref>] [dec <col>] -    [<ref>] [edit yes|no] -    [<ref>] [export sb|tsv <filename>] -    [<ref>] [filter <string>] -    [<ref>] [filter load <filename>] -    [<ref>] [header] -    [<ref>] [location <code>] -    [<ref>] [match <ref> <ref>] -    [<ref>] [match] -    [<ref>] [match error <value> degrees|arcmin|arcsec] -    [<ref>] [match function 1and2|1not2|2not1] -    [<ref>] [match return 1and2|1only|2only] -    [<ref>] [match unique yes|no] -    [<ref>] [maxrows <number>] -    [<ref>] [name <object>] -    [<ref>] [panto yes|no] -    [<ref>] [plot <xcol> <ycol> <xerrcol> <yerrcol>] -    [<ref>] [print] -    [<ref>] [psky <skyframe>] -    [<ref>] [psystem <coordsys>] -    [<ref>] [ra <col>] -    [<ref>] [regions] -    [<ref>] [retrieve] -    [<ref>] [samp] -    [<ref>] [samp broadcast] -    [<ref>] [samp send <application>] -    [<ref>] [save <filename>] -    [<ref>] [servercds|adac|cadc|cambridge|sao|ukirt|iucaa|bejing|saao] -    [<ref>] [show yes|no] -    [<ref>] [radius <value> degrees|arcmin|arcsec] -    [<ref>] [sky <skyframe>] -    [<ref>] [skyformat <skyformat>] -    [<ref>] [sort <col> incr|decr] -    [<ref>] [symbol [#] condition|shape|color|text|font|fontsize|fontweight|fontslant <value>] -    [<ref>] [symbol [#] text|size|size2|units|angle <value>] -    [<ref>] [symbol shape circle|ellipse|box|text|point] -    [<ref>] [symbol shapecircle point|box point|diamond point|cross point|x point|arrow point|boxcircle point] -    [<ref>] [symbol add| [#] remove] -    [<ref>] [symbol save|load <filename>] -    [<ref>] [system <coordsys>] -    [<ref>] [update] -    [<ref>] [x <col>] -    [<ref>] [y <col>] - -Example: -$ds9 -catalog new -$ds9 -catalog 2mass -$ds9 -catalog cds 2mass -$ds9 -catalog cds "I/252" - -$ds9 -catalog load foo.xml -$ds9 -catalog import tsv foo.tsv - -$ds9 -catalog 202.48 47.21 fk5 -$ds9 -catalog allrows -$ds9 -catalog allcols -$ds9 -catalog cancel -$ds9 -catalog clear -$ds9 -catalog close -$ds9 -catalog crosshair -$ds9 -catalog dec DEC -$ds9 -catalog edit yes -$ds9 -catalog export tsv bar.tsv -$ds9 -catalog filter'\$Jmag>15' -$ds9 -catalog filter load foo.flt -$ds9 -catalog header -$ds9 -catalog location 500 -$ds9 -catalog match error 2 arcsec -$ds9 -catalog match function 1and2 -$ds9 -catalog match unique no -$ds9 -catalog match return 1only -$ds9 -catalog match # last two catalogs loaded -$ds9 -catalog match 2mass csc -$ds9 -catalog maxrows 2000 -$ds9 -catalog name m51 -$ds9 -catalog panto no -$ds9 -catalog plot'$Jmag' '$Hmag' '$e_Jmag' '$e_Hmag' -$ds9 -catalog print -$ds9 -catalog psky fk5 -$ds9 -catalog psystem wcs -$ds9 -catalog ra RA -$ds9 -catalog regions -$ds9 -catalog retrieve -$ds9 -catalog samp broadcast -$ds9 -catalog samp send aladin -$ds9 -catalog save foo.xml -$ds9 -catalog server sao -$ds9 -catalog show yes -$ds9 -catalog radius 1 degrees -$ds9 -catalog symbol condition '\$Jmag>15' -$ds9 -catalog symbol 2 shape "boxcircle point" -$ds9 -catalog symbol color red -$ds9 -catalog symbol font times -$ds9 -catalog symbol fontsize 14 -$ds9 -catalog symbol fontweight bold -$ds9 -catalog symbol fontslant italic -$ds9 -catalog symbol add -$ds9 -catalog symbol 2 remove -$ds9 -catalog symbol load foo.sym -$ds9 -catalog symbol save bar.sym -$ds9 -catalog sky fk5 -$ds9 -catalog skyformat degrees -$ds9 -catalog sort "Jmag" incr -$ds9 -catalog system wcs -$ds9 -catalog update -$ds9 -catalog x RA -$ds9 -catalog y DEC
-
cd
-
Sets the current working directory.
-Syntax: -cd [<directory>] - -Example: -$ds9 -cd /home/mrbill -
cmap
-
Controls the colormap for the current frame. The colormap name is not case sensitive. A valid contrast value is from 0 to 10 and bias value from 0 to 1.
-Syntax: --cmap [<colormap>] -    [load <filename>] -    [save <filename>] -    [invert yes|no] -    [<contrast> <bias>] -    [tag [load|save] <filename>] -    [tag delete] -    [open|close] - -Example: -$ds9 -cmap Heat -$ds9 -cmap load foo.sao -$ds9 -cmap save bar.sao -$ds9 -cmap invert yes -$ds9 -cmap 5 .5 -$ds9 -cmap tag load foo.tag -$ds9 -cmap tag save foo.tag -$ds9 -cmap tag delete -$ds9 -cmap open -$ds9 -cmap close -
colorbar
-
Controls colorbar parameters.
-Syntax: --colorbar [] -    [yes|no] -    [horizontal|vertical] -    [numerics yes|no] -    [space value|distance] -    [font times|helvetica|courier] -    [fontsize <value>] -    [fontweight normal|bold] -    [fontslant roman|italic] -    [size] -    [ticks] -    [match] -    [lock [yes|no]] - -Example: -$ds9 -colorbar yes -$ds9 -colorbar vertical -$ds9 -colorbar numerics yes -$ds9 -colorbar space value -$ds9 -colorbar font times -$ds9 -colorbar fontsize 14 -$ds9 -colorbar fontweight bold -$ds9 -colorbar fontslant italic -$ds9 -colorbar size 20 -$ds9 -colorbar ticks 11 -$ds9 -colorbar match -$ds9 -colorbar lock yes
-
console
-
Display tcl console window.
-Syntax: --console - -Example: -$ds9 -console -
contour
-
Controls contours in the current frame.
-Syntax: --contour [] -    [yes|no] -    [clear] -    [generate] -    [load <filename>] -    [save <filename> [<coordsys> <skyframe>]] -    [convert] -    [load levels <filename>] -    [save levels <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|asinh|sinh|histequ] -    [log exp <value>] -    [mode minmax|<value>|zscale|zmax] -    [scope global|local] -    [limits <min> <max>] -    [levels <value value value...>] -    [open|close] - -Example: -$ds9 -contour -$ds9 -contour yes -$ds9 -contour generate -$ds9 -contour clear -$ds9 -contour load ds9.ctr -$ds9 -contour save ds9.ctr -$ds9 -contour save ds9.ctr wcs fk5 -$ds9 -contour convert -$ds9 -contour load levels ds9.ctr -$ds9 -contour save levels ds9.lev -$ds9 -contour copy -$ds9 -contour paste -$ds9 -contour paste wcs red 2 no -$ds9 -contour color yellow -$ds9 -contour width 2 -$ds9 -contour dash yes -$ds9 -contour smooth 5 -$ds9 -contour method smooth -$ds9 -contour nlevels 10 -$ds9 -contour scale sqrt -$ds9 -contour log exp 1000 -$ds9 -contour mode zscale -$ds9 -contour scope local -$ds9 -contour limits 1 100 -$ds9 -contour levels 1 10 100 1000 -$ds9 -contour open -$ds9 -contour close -
crop
-
Set current image display area.
-Syntax: --crop [<x> <y> <width> <height> [<coordsys>][<skyframe>][degrees|arcmin|arcsec] -    [match <coordsys>] -    [lock <coordsys>|none] -    [reset] -    [3d zmin zmax <coordsys>] -    [open|close] - -Example: -$ds9 foo.fits -crop 40 30 10 20 # set crop in physical coords -$ds9 foo.fits -crop +104:51:06.915 +68:33:40.761 28.144405 22.000204 wcs galactic arcsec -$ds9 foo.fits -crop match wcs -$ds9 foo.fits -crop lock wcs -$ds9 foo.fits -crop reset -$ds9 foo.fits -crop 3d .25 .5 wcs -$ds9 foo.fits -crop open -$ds9 foo.fits -crop 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> <h> <coordsys> [<skyframe>]] -   [match <coordsys>] -    [lock <coordsys>|none] - -Example: -$ds9 -crosshair 100 100 physical # set crosshair in physical -$ds9 -crosshair 345 58.8 wcs fk5 # set crosshair in wcs coords -$ds9 -crosshair 23:01:00 +58:52:51 wcs fk5 -$ds9 -crosshair match -$ds9 -crosshair lock wcs -
cube
-
Controls FITS cube.
-Syntax: --cube [] -    [play|stop|next|prev|first|last] -    [<slice> [<coordsys>]] -    [interval <numeric>] -    [match <coordsys>] -    [lock <coordsys>|none] -    [order 123|132|213|231|312|321] -    [axes lock [yes|no]] -    [open|close] - -Example: -$ds9 -cube -$ds9 -cube play -$ds9 -cube last -$ds9 -cube 3 -$ds9 -cube 4.5 wcs -$ds9 -cube interval 2 -$ds9 -cube match wcs -$ds9 -cube lock wcs -$ds9 -cube order 123 -$ds9 -cube axes lock yes -$ds9 -cube open -$ds9 -cube close
-
cursor
-
Move mouse pointer or crosshair in image pixels in the current frame. Note, this will move selected Regions also.
-Syntax: --cursor [<x> <h>] - -Example: -$ds9 -cursor 10 10 -
dsssao
-dss
-
Support for Digital Sky Survey at SAO.
-Syntax: --dsssao [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [open|close] - -Example: -$ds9 -dsssao -$ds9 -dsssao m31 -$ds9 -dsssao name m31 -$ds9 -dsssao name clear -$ds9 -dsssao 00:42:44.404 +41:16:08.78 -$ds9 -dsssao size 60 60 arcmin -$ds9 -dsssao save yes -$ds9 -dsssao frame current -$ds9 -dsssao update frame -$ds9 -dsssao open -$ds9 -dsssao close -
dsseso
-
Support for Digital Sky Survey at ESO.
-Syntax: --dsseso [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # 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: -$ds9 -dsseso -$ds9 -dsseso m31 -$ds9 -dsseso name m31 -$ds9 -dsseso name clear -$ds9 -dsseso 00:42:44.404 +41:16:08.78 -$ds9 -dsseso size 60 60 arcmin -$ds9 -dsseso save yes -$ds9 -dsseso frame current -$ds9 -dsseso update frame -$ds9 -dsseso survey DSS2-red -$ds9 -dsseso open -$ds9 -dsseso close
-
dssstsci
-
Support for Digital Sky Survey at STSCI.
-Syntax: --dssstsci [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # 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: -$ds9 -dssstsci -$ds9 -dssstsci m31 -$ds9 -dssstsci name m31 -$ds9 -dssstsci name clear -$ds9 -dssstsci 00:42:44.404 +41:16:08.78 -$ds9 -dssstsci size 60 60 arcmin -$ds9 -dssstsci save yes -$ds9 -dssstsci frame current -$ds9 -dssstsci update frame -$ds9 -dssstsci survey all -$ds9 -dssstsci open -$ds9 -dssstsci close
-
envi
-
Load an ENVI header and file. Optional parameter: array endian.
-Syntax: --envi <header> [<filename>] - -Example: -$ds9 -envi foo.hdr -$ds9 -envi foo.hdr foo.bsq -
exit
-quit
-
Quits DS9.
-Syntax: --exit --quit - -Example: -$ds9 -exit -
export
-
Export loaded image data of current frame in specified image format, at native resolution, using current colormap and contrast/bias settings. NOTE: not scaling, rotation, or translation is applied. If no format specified, the file name extension is used to determine the output format. Optional parameters: jpeg quality (1-100) and tiff compression method.
-Syntax: --export [array|nrrd|envi|gif|tiff|jpeg|png] <filename> --export array <filename>[big|little|native] --export nrrd <filename>[big|little|native] --export envi <header> [<filename>][big|little|native] --export <filename>.jpeg [1-100] --export <filename>.tiff [none|jpeg|packbits|deflate] - -Example: -$ds9 -export array foo.arr little -$ds9 -export nrrd foo.nrrd little -$ds9 -export envi foo.hdr little -$ds9 -export envi foo.hdr foo.bsq little -$ds9 -export tiff foo.tiff jpeg -$ds9 -export jpeg foo.jpeg 75 -$ds9 -export png foo.png
-
fifo
-
Set the name of the IRAF input and output fifos. The default is /dev/imt1. These fifos are used by IRAF to communicate with DS9.
-Syntax: --fifo name - -Example: -$ds9 -fifo /dev/imt1 -
fifo_only
-
Only use IRAF input and output fifos. Same as -port 0 -unix none.
-Syntax: --fifo_only - -Example: -$ds9 -fifo_only -
fits
-
Load a FITS image into the current frame.
-Syntax: --fits<filename> - -Example: -$ds9 -fits foo.fits -$ds9 -fits bar.fits[bin=detx,dety] -$cat foo.fits | ds9 -fits - -$cat bar.fits | ds9 -fits -[bin=detx,dety] -
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 #] -    [#] -    [match <coordsys>] -    [lock <coordsys>|none] - -Example: -$ds9 -frame center # center current frame -$ds9 -frame center 1 # center 'Frame1' -$ds9 -frame center all # center all frames -$ds9 -frame clear # clear current frame -$ds9 -frame new # create new frame -$ds9 -frame new rgb # create new rgb frame -$ds9 -frame delete # delete current frame -$ds9 -frame reset # reset current frame -$ds9 -frame refresh # refresh current frame -$ds9 -frame hide # hide current frame -$ds9 -frame show 1 # show frame 'Frame1' -$ds9 -frame move first # move frame to first in order -$ds9 -frame move back # move frame back in order -$ds9 -frame move forward # move frame forward in order -$ds9 -frame move last # move frame to last in order -$ds9 -frame first # goto first frame -$ds9 -frame prev # goto prev frame -$ds9 -frame next # goto next frame -$ds9 -frame last # goto last frame -$ds9 -frame frameno 4 # goto frame 'Frame4', create if needed -$ds9 -frame 3 # goto frame 'Frame3', create if needed -$ds9 -frame lock wcs
-
gif
-
Load GIF image into current frame.
-Syntax: --gif <filename> - -Example: -$ds9 -gif foo.gif -$cat foo.gif | ds9 -gif - -
geometry
-
Define the initial window geometry. This includes all of the ds9 window, not just the image space. see X(1).
-Syntax: --geometry value - -Example: -$ds9 -geometry 640x480 -
green
-
For RGB frames, sets the current color channel to green.
-Syntax: --green - -Example: -$ds9 -green foo.fits -
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 dash yes|no] -    [grid gap1 <value>] -    [grid gap2 <value>] -    [grid gap3 <value>] -    [axes yes|no] -    [axes color <color>] -    [axes width <value>] -    [axes dash yes|no] -    [axes type interior|exterior] -    [axes origin lll|llu|lul|luu|ull|ulu|uul|uuu] -    [format1 <format>] -    [format2 <format>] -    [tickmarks yes|no] -    [tickmarks color <color>] -    [tickmarks width <value>] -    [tickmarks dash yes|no] -    [border yes|no] -    [border color <color>] -    [border width <value>] -    [border dash yes|no] -    [numerics yes|no] -    [numerics font times|helvetica|courier] -    [numerics fontsize <value>] -    [numerics fontweight normal|bold] -    [numerics fontslant roman|italic] -    [numerics color <color>] -    [numerics gap1 <value>] -    [numerics gap2 <value>] -    [numerics gap3 <value>] -    [numerics type interior|exterior] -    [numerics 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>] -    [labels yes|no] -    [labels text1 <text>] -    [labels text2 <text>] -    [labels def1 yes|no] -    [labels def2 yes|no] -    [labels gap1 <value>] -    [labels gap2 <value>] -    [labels font times|helvetica|courier] -    [labels fontsize <value>] -    [labels fontweight normal|bold] -    [labels fontslant roman|italic] -    [labels color <color>] -    [reset] -    [load <filename>] -    [save <filename>] -    [open|close] - -Example: -$ds9 -grid -$ds9 -grid yes -$ds9 -grid type analysis -$ds9 -grid system wcs -$ds9 -grid sky fk5 -$ds9 -grid skyformat degrees -$ds9 -grid grid yes -$ds9 -grid grid color red -$ds9 -grid grid width 2 -$ds9 -grid grid dash yes -$ds9 -grid grid gap1 10 -$ds9 -grid grid gap2 10 -$ds9 -grid grid gap3 10 -$ds9 -grid axes yes -$ds9 -grid axes color red -$ds9 -grid axes width 2 -$ds9 -grid axes dash yes -$ds9 -grid axes type exterior -$ds9 -grid axes origin lll -$ds9 -grid format1 d.2 -$ds9 -grid format2 d.2 -$ds9 -grid tickmarks yes -$ds9 -grid tickmarks color red -$ds9 -grid tickmarks width 2 -$ds9 -grid tickmarks dash yes -$ds9 -grid border yes -$ds9 -grid border color red -$ds9 -grid border width 2 -$ds9 -grid border dash yes -$ds9 -grid numerics yes -$ds9 -grid numerics font courier -$ds9 -grid numerics fontsize 12 -$ds9 -grid numerics fontweight bold -$ds9 -grid numerics fontslant italic -$ds9 -grid numerics color red -$ds9 -grid numerics gap1 10 -$ds9 -grid numerics gap2 10 -$ds9 -grid numerics gap3 10 -$ds9 -grid numerics type exterior -$ds9 -grid numerics vertical yes -$ds9 -grid title yes -$ds9 -grid title text {Hello World} -$ds9 -grid title def yes -$ds9 -grid title gap 10 -$ds9 -grid title font courier -$ds9 -grid title fontsize 12 -$ds9 -grid title fontweight bold -$ds9 -grid title fontslant italic -$ds9 -grid title color red -$ds9 -grid labels yes -$ds9 -grid labels text1 {Hello World} -$ds9 -grid labels text2 {Hello World} -$ds9 -grid labels def1 yes -$ds9 -grid labels def2 yes -$ds9 -grid labels gap1 10 -$ds9 -grid labels gap2 10 -$ds9 -grid labels font courier -$ds9 -grid labels fontsize 12 -$ds9 -grid labels fontweight bold -$ds9 -grid labels fontslant italic -$ds9 -grid labels color red -$ds9 -grid reset -$ds9 -grid load foo.grd -$ds9 -grid save foo.grd -$ds9 -grid open -$ds9 -grid close -
header
-
Display current fits header dialog. Optional extension number maybe specified.
-Syntax: --header [<ext>] -    [close [<ext>]] -    [save [<ext>] <filename>] - -Example: -$ds9 -header -$ds9 -header 2 -$ds9 -header close -$ds9 -header save 1 foo.txt -
height
-
Set the height of the image display window. Use the geometry command to set the overall width and height of the ds9 window.
-Syntax: --height [<value>] - -Example: -$ds9 -height 512 -
help
-
Display help information. To maintain backward compatibility, -help will display a brief help message and exit. --help will display all command line options within the built-in help facility.
-Syntax: --help # Display brief help message and exit. ---help # Display command line options within help facility. --? # Display command line options within help facility. - -Example: -$ds9 -help # Display brief help message and exit. -$ds9 --help # Display command line options within help facility -$ds9 -? # Display command line options within help facility. -
histequ
-
Select histogram equalization scale function for the current frame.
-Syntax: --histequ - -Example: -$ds9 -histequ -
iconify
-
Toggles iconification.
-Syntax: --iconify [] -    [yes|no] - -Example: -$ds9 -iconify -$ds9 -iconify yes
-
invert
-
Invert Colormap.
-Syntax: --invert - -Example: -$ds9 -invert -
iis
-
Set IIS Filename. Optional mosaic number maybe supplied.
-Syntax: --iis [filename <filename> [#]] - -Example: -$ds9 -iis filename foo.fits -$ds9 -iis filename bar.fits 4
-
jpeg
-
Load JPEG image into current frame.
-Syntax: --jpeg <filename> - -Example: -$ds9 -jpeg foo.jpeg -$cat foo.jpeg | ds9 -jpeg -
-
language
-
Select current language.
-Syntax: --language [locale|da|de|es|en|fr|ja|pt] - -Example: -$ds9 -language fr -
linear
-
Select linear scale function for the current frame.
-Syntax: --linear - -Example: -$ds9 -linear -
lock
-
Lock all other frames to the current frame.
-Syntax: --lock[frame <coordsys>|none] -    [crosshair <coordsys>|none] -    [crop <coordsys>|none] -    [slice <coordsys>|none] -    [bin [yes|no]] -    [axes [yes|no]] -    [scale [yes|no]] -    [scalelimits [yes|no]] -    [colorbar [yes|no]] -    [block [yes|no]] -    [smooth [yes|no]] -    [3d [yes|no]] - -Example: -$ds9 -lock frame wcs -$ds9 -lock crosshair wcs -$ds9 -lock crop wcs -$ds9 -lock slice wcs -$ds9 -lock bin yes -$ds9 -lock axes yes -$ds9 -lock scale yes -$ds9 -lock scalelimits yes -$ds9 -lock colorbar yes -$ds9 -lock block yes -$ds9 -lock smooth yes -$ds9 -lock 3d yes - log -
Select log scale function for the current frame.
-Syntax: --log - -Example: -$ds9 -log -
lower
-
Lower in the window stacking order.
-Syntax: --lower - -Example: -$ds9 -lower -
magnifier
-
Controls the magnifier settings.
-Syntax: -magnifier [color <color>] -    [zoom <value>] -    [cursor yes|no] -    [region yes|no] - -Example: -$ds9 -magnifier color yellow -$ds9 -magnifier zoom 2 -$ds9 -magnifier cursor no -$ds9 -magnifier region no -
mask
-nomask
-
Controls mask parameters.
-Syntax: --mask [color <color>] -    [mark zero|nonzero|nan|nonnan|range] -    [range <low> <high>] -    [transparency <value>] -    [system <coordsys>] -    [clear] -    [open|close] --nomask - -Example: -$ds9 -mask color red -$ds9 -mask mark zero -$ds9 -mask range 10 100 -$ds9 -mask transparency 50 -$ds9 -mask system wcs -$ds9 -mask clear -$ds9 -mask open -$ds9 -mask close -$ds9 -nomask -
match
-
Match all other frames to the current frame.
-Syntax: --match[frame <coordsys>] -    [crosshair <coordsys>] -    [crop <coordsys>] -    [slice <coordsys>] -    [bin] -    [axes] -    [scale] -    [scalelimits] -    [colorbar] -    [block] -    [smooth] -    [3d] - -Example: -$ds9 -match frame wcs -$ds9 -match crosshair wcs -$ds9 -match crop wcs -$ds9 -match slice wcs -$ds9 -match bin -$ds9 -match axes -$ds9 -match scale -$ds9 -match scalelimits -$ds9 -match colorbar -$ds9 -match block -$ds9 -match smooth -$ds9 -match 3d
- mecube -
Load FITS multiple extension file as data cube.
-Syntax: -mecube <filename> - -Example: -$ds9 -mecube foo.fits -$cat foo.fits | ds9 -mecube -
-
minmax
-
This is how DS9 determines the min and max data values from the data. SCAN will scan all data.
-Syntax: --minmax [scan|sample|datamin|irafmin] -    [mode scan|sample|datamin|irafmin] -    [interval #] - -Example: -$ds9 -minmax scan -$ds9 -minmax mode scan -$ds9 -minmax interval 100 -
mode
-
Select the current mode.
-Syntax: --mode [none|region|crosshair|colorbar|pan|zoom|rotate|catalog|examine|3d] - -Example: -$ds9 -mode crosshair
-
mosaic
-
Load FITS mosaic segment into current frame.
-Syntax: --mosaic [wcs|wcsa...wcsz|iraf] <filename> - -Example: -$ds9 -mosaic foo.fits -$ds9 -mosaic wcs foo.fits -$cat foo.fits | ds9 -mosaic - -$cat foo.fits | ds9 -mosaic wcs - -
mosaicimage
-
Load FITS mosaic image into current frame.
-Syntax: --mosaicimage [wcs|wcsa...wcsz|iraf|wfpc2] <filename> - -Example: -$ds9 -mosaicimage foo.fits -$ds9 -mosaicimage wcs foo.fits -$cat foo.fits | ds9 -mosaicimage -$cat foo.fits | ds9 -mosaiimage wcs -
movie
-
Create a movie from snap shots of the DS9 window. A slice movie cycles though all slices of a cube. A frame movie cycles through all active frames. A 3d movie cycles through specified viewing angles. The default action is slice. Movie types are either MPEG or Animated GIF, with default MPEG. Optional parameters for 3d: number of frames, azimuth from/to, elevation from/to, slice from/to, oscillate/repeat times.
-Syntax: --movie [slice|frame|3d] [mpeg|gif] <filename> --movie 3d [mpeg|gif] <filename> [number|azfrom|azto|elfrom|elto|slfrom|slto|oscillate|repeat <#>] - -Example: -$ds9 -movie slice mpeg ds9.mpg -$ds9 -movie frame gif ds9.gif -$ds9 -movie 3d mpeg ds9.mpg number 10 azfrom -60 azto 60 oscillate 1
-
msg
-
Specify a directory of translation tables to be loaded.
-Syntax: --msg <directory> - -Example: -$ds9 -msg $HOME/msgs
-
multiframe
-
Load FITS multiple extension file as multiple images.
-Syntax: -multiframe <filename> - -Example: -$ds9 -multiframe foo.fits -$cat foo.fits | ds9 -multiframe - -
nameserver
-
Support Name Server functions. Coordinates are in fk5.
-Syntax: --nameserver [<object>] -    [name <object>] -    [skyformat degrees|sexagesimal] -    [pan] -    [crosshair] -    [open|close] - -Example: -$ds9 -nameserver m31 -$ds9 -nameserver name m31 -$ds9 -nameserver server ned-sao -$ds9 -nameserver skyformat sexagesimal -$ds9 -nameserver pan -$ds9 -nameserver crosshair -$ds9 -nameserver open -$ds9 -nameserver close -
nan
-
Set image not-a-number color.
-Syntax: --nan <color> - -Example: -$ds9 -nan red
-
nrrd
-
Load an NRRD (Nearly Raw Raster Data) file.
-Syntax: --nrrd <filename> - -Example: -$ds9 -nrrd foo.nrrd -$cat foo.nrrd | xpaset ds9 -nrrd- -
nvss
-
Support for NRAO VLA Sky Survey.
-Syntax: --nvss [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [open|close] - -Example: -$ds9 -nvss -$ds9 -nvss m31 -$ds9 -nvss name m31 -$ds9 -nvss name clear -$ds9 -nvss 00:42:44.404 +41:16:08.78 -$ds9 -nvss size 60 60 arcmin -$ds9 -nvss save yes -$ds9 -nvss frame current -$ds9 -nvss update frame -$ds9 -nvss open -$ds9 -nvess close -
orient
-
Controls the orientation of the current frame.
-Syntax: --orient [none|x|y|xy] -    [open|close] - -Example: -$ds9 -orient xy -$ds9 -orient open -$ds9 -orient close -
pagesetup
-
Controls Page Setup options.
-Syntax: --pagesetup [orient portrait|landscape] -    [scale <numberic>] -    [size letter|legal|tabloid|poster|a4] - -Example: -$ds9 -pagesetup orient portrait -$ds9 -pagesetup scale 50 -$ds9 -pagesetup size poster
-
pan
-
Controls the current image cursor location for the current frame.
-Syntax: --pan [<x> <h> <coordsys> [<skyframe>]] # relative -    [to <x> <h> <coordsys> [<skyframe>]] # absolute -    [open|close] - -Example: -$ds9 -pan 200 200 image# pan relative -$ds9 -pan to 400 400 physical# pan to physical coords -$ds9 -pan to 13:29:55 47:11:50 wcs fk# pan to wcs coords -$ds9 -pan open -$ds9 -pan close
-
pixeltable
-
Display/Hide the pixel table.
-Syntax: --pixeltable [] -    [yes|open] -    [no|close] - -Example: -$ds9 -pixeltable -$ds9 -pixeltable yes -$ds9 -pixeltable open -$ds9 -pixeltable close -
plot
-
Display and configure data plots. All plot commands take an optional second command, the plot name. 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 x and y errors
-
To create a new plot, use the plot new command.
-Syntax: -# create new empty plot window --plot [line|bar|scatter] - -# existing plot --plot [[<plotname>] load <filename> xy|xyex|xyey|xyexey] -    [[<plotname>] save <filename>] -    [[<plotname>] layout grid|row|column|strip] -    [[<plotname>] layout strip scale <percent>] -    [[<plotname>] add graph line|bar|scatter] -    [[<plotname>] select graph <graph>] -    [[<plotname>] delete graph] -    [[<plotname>] select dataset <dataset>] -    [[<plotname>] delete dataset] -    [[<plotname>] duplicate] -    [[<plotname>] stats yes|no] -    [[<plotname>] list yes|no] -    [[<plotname>] loadconfig <filename>] -    [[<plotname>] saveconfig <filename>] -    [[<plotname>] pagesetup orient portrait|landscape] -    [[<plotname>] pagesetup size letter|legal|tabloid|poster|a4] -    [[<plotname>] print] -    [[<plotname>] print destination printer|file] -    [[<plotname>] print command <command>] -    [[<plotname>] print filename <filename>] -    [[<plotname>] print color rgb|gray] -    [[<plotname>] close] -    [[<plotname>] mode pointer|zoom] - -# export image -plot [[<plotname>] export <filename>] -    [[<plotname>] export gif|tiff|jpeg|png <filename>] -    [[<plotname>] export jpeg <filename> [1-100]] -    [[<plotname>] export tiff <filename> none|jpeg|packbits|deflate]] -# configure graph --plot [[<plotname>] axis x|y grid yes|no] -    [[<plotname>] axis x|y log yes|no] -    [[<plotname>] axis x|y flip yes|no] -    [[<plotname>] axis x|y auto yes|no] -    [[<plotname>] axis x|y min <value>] -    [[<plotname>] axis x|y max <value>] -    [[<plotname>] axis x|y format <string>] -    [[<plotname>] background <value>] -    [[<plotname>] legend yes|no] -    [[<plotname>] legend position right|left|top|bottom|plotarea] -    [[<plotname>] font title|labels|numbers font times|helvetica|courier] -    [[<plotname>] font title|labels|numbers size <value>] -    [[<plotname>] font title|labels|numbers weight normal|bold] -    [[<plotname>] font title|labels|numbers slant roman|italic] -    [[<plotname>] title <string>] -    [[<plotname>] title x|y <string>] -    [[<plotname>] barmode normal|stacked|aligned|overlap] - -# configure current dataset --plot [[<plotname>] show yes|no] -   [[<plotname>] shape none|circle|square|diamond|plus|splus|scross|triangle|arrow] -   [[<plotname>] shape fill yes|no] -   [[<plotname>] shape color <value>] -   [[<plotname>] smooth step|linear|cubic|quadratic|catrom] -   [[<plotname>] color <value>] -   [[<plotname>] width <value>] -   [[<plotname>] dash yes|no] -   [[<plotname>] error yes|no] -   [[<plotname>] error color <value>] -   [[<plotname>] error cap yes|no] -   [[<plotname>] error width <value>] -   [[<plotname>] name <string>] - -Example: -# create new empty plot window -$ds9 -plot bar - -# existing plot -$ds9 -plot load xy.dat -$ds9 -plot save foo.dat -$ds9 -plot layout strip -$ds9 -plot layout strip scale 30 -$ds9 -plot add graph scatter -$ds9 -plot select graph 1 -$ds9 -plot delete graph -$ds9 -plot select dataset 1 -$ds9 -plot delete dataset -$ds9 -plot duplicate -$ds9 -plot stats yes -$ds9 -plot list yes -$ds9 -plot loadconfig foo.plt -$ds9 -plot saveconfig foo.plt -$ds9 -plot pagesetup orient portrait -$ds9 -plot pagesetup size letter -$ds9 -plot print -$ds9 -plot print destination file -$ds9 -plot print command lp -$ds9 -plot print filename foo.ps -$ds9 -plot print color rgb -$ds9 -plot close - -# plot mode -$ds9 -plot mode pointer - -# export plot -$ds9 -plot export tiff foo.tiff jpeg -$ds9 -plot export jpeg foo.jpeg 75 -$ds9 -plot export png foo.png - -# configure plot -$ds9 -plot axis x grid yes -$ds9 -plot axis x log yes -$ds9 -plot axis x flip yes -$ds9 -plot axis x auto no -$ds9 -plot axis x min 1 -$ds9 -plot axis x max 100 -$ds9 -plot axis x format '%f' -$ds9 -plot background white -$ds9 -plot legend yes -$ds9 -plot legend position left -$ds9 -plot font numbers font times -$ds9 -plot font numbers size 12 -$ds9 -plot font numbers weight bold -$ds9 -plot font numbers slant italic -$ds9 -plot title 'This is a Title' -$ds9 -plot title x 'X Axis' -$ds9 -plot title y 'Y Axis' -$ds9 -plot title legend 'This is the Legend' - -# bar plot -$ds9 -plot barmode aligned - -# configure current dataset -$ds9 -plot show yes -$ds9 -plot shape circle -$ds9 -plot shape fill no -$ds9 -plot shape color cyan -$ds9 -plot smooth step -$ds9 -plot color red -$ds9 -plot width 2 -$ds9 -plot dash yes -$ds9 -plot error yes -$ds9 -plot error color red -$ds9 -plot error cap yes -$ds9 -plot error width 2 -$ds9 -plot name 'My Data' - png -
Load PNG image into current frame.
-Syntax: --png <filename> - -Example: -$ds9 png foo.png -$cat foo.png | ds9 -png - -
port
-
Set the IRAF port number, used by IRAF to communicate with DS9. The default is 5137, the standard IRAF port used by ximtool.
-Syntax: --port number - -Example: -$ds9 -port 5137 -
port_only
-inet_only
-
Only use the IRAF port number. This is the same as -fifo none -unix none.
-Syntax: --port_only - -Example: -$ds9 -port_only -
pow
-
Select power scale function for the current frame.
-Syntax: --pow - -Example: -$ds9 -pow -
precision
-
Set region and coordinate output format precision.
-Syntax: --precision <linear><degree><hms><dms><arcmin><arcsec> - -Example: -$ds9 -precision 8 10 4 3 5 3
-
prefs
-
Controls various preference settings.
-Syntax: --prefs [clear] -    [irafalign yes|no] - -Example: -$ds9 -prefs clear -$ds9 -prefs irafalign yes -
preserve
-
Preserve the follow attributes while loading a new image.
-Syntax: -preserve [pan yes|no] -    [regions yes|no] - -Example: -$ds9 -preserve pan yes -$ds9 -preserve regions yes -
psprint
-
Invokes postscript printing. Please see print for further details.
-
print
-
Controls printing. Use print option to set printing options.
-Syntax: --print [destination printer|file] -    [command <command>] -    [filename <filename>] -    [color rgb|cmyk|gray] -    [level 1|2|3] -    [resolution72|screen|96|144|150|225|300|600|1200] - -Example: -$ds9 -print -$ds9 -print destination file -$ds9 -print command lp -$ds9 -print filename foo.ps -$ds9 -print color cmyk -$ds9 -print level 2 -$ds9 -print resolution 96 -
raise
-
Raise in the window stacking order.
-Syntax: --raise - -Example: -$ds9 -raise -
regions
-
Controls regions in the current frame.
-Syntax: --regions [<filename>] -    [load [all] <filename>] -    [save <filename>] -    [list [close]] -    [epsilon <integer>] -    [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 invert] -    [delete all] -    [delete select] -    [format ds9|xml|ciao|saotng|saoimage|pros|xy] -    [system image|physical|wcs|wcsa...wcsz] -    [sky fk4|fk5|icrs|galactic|ecliptic] -    [skyformat degrees|sexagesimal] -    [strip yes|no] -    [shape <shape>] -    [color <color> -    [width <width>] -    [fixed|edit|rotate|delete yes|no] -    [include|exclude|source|background] -    [command <marker command>] -    [composite] -    [dissolve] -    [template <filename>] -    [template <filename> at <ra> <dec> <coordsys> <skyframe>] -    [savetemplate <filename>] -    [group new] -    [group <tag> new] -    [group <tag> update] -    [group <tag> select] -    [group <tag> color <color>] -    [group <tag> copy] -    [group <tag> delete] -    [group <tag> cut] -    [group <tag> font <font>] -    [group <tag> move <int> <int>] -    [group <tag> movefront] -    [group <tag> moveback] -    [group <tag> property <property> yes|no] -    [copy] -    [cut] -    [paste image|physical|wcs|wcsa...wcsz] -    [undo] - -Example: -$ds9 -regions foo.reg -$ds9 -regions -format ciao bar.reg # load as ciao format -$ds9 -regions foo.fits # FITS regions files do not need a format specification -$ds9 -regions load foo.reg # load foo.reg into current frame -$ds9 -regions load all foo.reg # load foo.reg into all frames -$ds9 -regions load '*.reg'# expand *.reg and load into current frame -$ds9 -regions load all '*.reg' # expand *.reg and load into all frames -$ds9 -regions save foo.reg -$ds9 -regions list -$ds9 -regions list close -$ds9 -regions epsilon 5 -$ds9 -regions show yes -$ds9 -regions showtext no -$ds9 -regions centroid -$ds9 -regions centroid auto yes -$ds9 -regions centroid radius 10 -$ds9 -regions centroid iteration 20 -$ds9 -regions getinfo -$ds9 -regions move back -$ds9 -regions move front -$ds9 -regions select all -$ds9 -regions select none -$ds9 -regions select invert -$ds9 -regions delete all -$ds9 -regions delete select -$ds9 -regions format ds9 -$ds9 -regions system wcs -$ds9 -regions sky fk5 -$ds9 -regions skyformat degrees -$ds9 -regions strip yes -$ds9 -regions shape ellipse -$ds9 -regions color red -$ds9 -regions width 3 -$ds9 -regions edit yes -$ds9 -regions include -$ds9 -regions command "circle 100 100 20 # color=red" -$ds9 -regions composite -$ds9 -regions dissolve -$ds9 -regions template foo.tpl -$ds9 -regions template foo.tpl at 13:29:55.92 +47:12:48.02 fk5 -$ds9 -regions savetemplate foo.tpl -$ds9 -regions group new -$ds9 -regions group foo new -$ds9 -regions group foo update -$ds9 -regions group foo select -$ds9 -regions group foo color red -$ds9 -regions group foo copy -$ds9 -regions group foo delete -$ds9 -regions group foo cut -$ds9 -regions group foo font {times 14 bold} -$ds9 -regions group foo move 100 100 -$ds9 -regions group foo movefront -$ds9 -regions group foo moveback -$ds9 -regions group foo property delete no -$ds9 -regions copy -$ds9 -regions cut -$ds9 -regions paste wcs -$ds9 -regions undo -
red
-
For RGB frames, sets the current color channel to red.
-Syntax: --red - -Example: -$ds9 -red foo.fits -
restore
-
Restore DS9 to a previous state from a backup save set.
-Syntax: --restore <filename> - -Example: -$ds9 -restore ds9.bck
-
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 wcs|crop|slice|bin|scale|scalelimits|colorbar|block|smooth [yes|no]] -    [open|close] - -Example: -$ds9 -rgb # create new rgb frame -$ds9 -rgb red # set current channel to red -$ds9 -rgb channel red # set current channel to red -$ds9 -rgb view blue no # turn off blue channel -$ds9 -rgb system wcs # set rgb coordinate system -$ds9 -rgb lock wcs yes -$ds9 -rgb lock crop yes -$ds9 -rgb lock slice yes -$ds9 -rgb lock bin yes -$ds9 -rgb lock scale yes -$ds9 -rgb lock scalelimits yes -$ds9 -rgb lock colorbar yes -$ds9 -rgb lock block yes -$ds9 -rgb lock smooth yes -$ds9 -rgb open -$ds9 -rgb close
-
rgbarray
-
Load raw data array cube into rgb frame.
-Syntax: --rgbarray <filename>[[xdim=<x>,ydim=<y>|dim=<dim>],[zdim=3],bitpix=<b>,skip=<s>,endian=[little|big]] - -Example: -$ds9 -rgbarray foo.arr[dim=512,zdim=3,bitpix=-32,endian=little] -$cat foo.arr | ds9 -rgbarray -[dim=512,zdim=3,bitpix=-32,endian=little]
-
rgbcube
-
Load FITS rgbcube into rgb frame.
-Syntax: --rgbcube <filename> - -Example: -$ds9 -rgbcube foo.fits -$cat foo.fits | ds9 -rgbcube -
-
rgbimage
-
Load FITS rgbimage into rgb frame.
-Syntax: --rgbimage <filename> - -Example: -$ds9 -rgbimage foo.fits -$cat foo.fits | ds9 -rgbimage -
-
rotate
-
Controls the rotation angle (in degrees) of the current frame.<
-Syntax: --rotate [<value>] -    [to <value>] -    [open|close] - -Example: -$ds9 -rotate 45 -$ds9 -rotate to 30 -$ds9 -rotate open -$ds9 -rotate close -
samp
-
Configure SAMP protocol.
-Syntax: --samp [yes|no|connect|disconnect] -    [broadcast [image|table]] -    [send [image|table] <application>] - -Example: -$ds9 -samp yes -$ds9 -samp connect -$ds9 -samp broadcast image -$ds9 -samp send image aladin
-
save
-
Save loaded image data of current frame as FITS.
-Syntax: --save[fits|rgbimage|rgbcube|mecube|mosaic|mosaicimage] <filename> [image|table|slice] - -Example: -$ds9 -save foo.fits -$ds9 -save fits foo.fits image -$ds9 -save fits foo.fits table -$ds9 -save fits foo.fits slice -$ds9 -save rgbimage foo.fits -$ds9 -save rgbcube foo.fits -$ds9 -save mecube foo.fits -$ds9 -save mosaic foo.fits -$ds9 -save mosaicimage foo.fits
-
saveimage
-
Create a snap shot of the current DS9 window and save in specified image format. If no format specified, the file name extension is used to determine the output format. Optional parameters: jpeg quality (1-100) and tiff compression method.
-Syntax: --saveimage[fits|eps|gif|tiff|jpeg|png]<filename> --saveimage <filename>.jpeg [1-100] --saveimage <filename>.tiff [none|jpeg|packbits|deflate] - -Example: -$ds9 -saveimage ds9.tiff -$ds9 -saveimage jpeg ds9.jpeg 75 -
scale
-
Controls the limits and color scale distribution.
-Syntax: --scale [linear|log|pow|sqrt|squared|asinh|sinh|histequ] -    [log exp <value>] -    [datasec yes|no] -    [limits <minvalue> <maxvalue>] -    [mode minmax|<value>|zscale|zmax] -    [scope local|global] -    [match] -    [match limits] -    [lock [yes|no]] -    [lock limits [yes|no]] -    [open|close] - -Example: -$ds9 -scale linear -$ds9 -scale log exp 100 -$ds9 -scale datasec yes -$ds9 -scale histequ -$ds9 -scale limits 1 100 -$ds9 -scale mode zscale -$ds9 -scale mode 99.5 -$ds9 -scale scope local -$ds9 -scale match -$ds9 -scale match limits -$ds9 -scale lock yes -$ds9 -scale lock limits yes -$ds9 -scale open -$ds9 -scale close -
shm
-
Load a shared memory segment into the current frame.
-Syntax: --shm [<key> [<filename>]] -    [key <id> [<filename>]] -    [shmid <id> [<filename>]] -    [fits [key|shmid] <id> [<filename>]] -    [mosaicimage [iraf|wcs|wcsa...wcsz|wfpc2] [key|shmid] <id> [<filename>]] -    [mosaic [iraf|wcs|wcsa...wcsz] [key|shmid] <id> [<filename>]] -    [rgbcube [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>]] - -Example: -$ds9 -shm 102 -$ds9 -shm key 102 -$ds9 -shm shmid 102 foo -$ds9 -shm fits 100 foo -$ds9 -shm mosaicimage iraf key 100 foo -$ds9 -shm mosaicimage wcs key 100 foo -$ds9 -shm mosaicimage wcsa key 100 foo -$ds9 -shm mosaicimage wfpc2 key 100 foo -$ds9 -shm mosaic iraf key 100 foo -$ds9 -shm mosaic wcs key 100 foo -$ds9 -shm rgbcube key 100 foo -$ds9 -shm rgbimage key 100 foo -$ds9 -shm rgbarray shmid 102 [dim=32,zdim=3,bitpix=-32] -$ds9 -shm array shmid 102 [dim=32,bitpix=-32] -
sia
-
Support for VO Simple Image Access protocol. The first command will create a new search. All other commands operated on the last search created, unless indicated otherwise.
-Syntax: + + + + + Command Line Options + + + Command Line Options + + DS9 will process each command line option, one at a time, as + the last step in the initialization process. Therefore, it is + possible to use command line options as a little script. For + example, the following command line option is used: + $ds9 -tile foo.fits -cmap Heat -zscale bar.fits -cmap I8 + First DS9 is put in tile mode, then foo.fits is + loaded. Then the colormap for foo.fits is changed to Heat + and the scale changed to zscale. Next, bar.fits + is loaded and the colormap for bar.fits is changed to + I8. + 2mass + 3d + about + align + analysis + array + asinh + background + backup + bin + blink + block + blue + catalog + cd + cmap + colorbar + console + contour + crop + crosshair + cube + cursor + dsssao + dsseso + dssstsci + envi + exit + export + fifo + fifo_only + fits + frame + geometry + gif + green + grid + header + height + help + histequ + iconify + inet_only + invert + iis + jpeg + language + linear + lock + log + lower + magnifier + mask + match + mecube + minmax + mode + mosaic + mosaicimage + movie + msg + multiframe + nameserver + nan + nrrd + nvss + orient + pagesetup + pan + pixeltable + plot + png + precision + prefs + preserve + psprint + print + port + port_only + pow + quit + raise + regions + red + restore + rgb + rgbarray + rgbcube + rgbimage + rotate + samp + save + saveimage + scale + shm + sia + single + sinh + skyview + sleep + slice + smooth + squared + sqrt + source + tcl + threads + tiff + tile + title + unix + unix_only + update + url + version + view + visual + vla + vlss + vo + wcs + web + width + xpa + zmax + zoom + zscale + 2mass + Support for 2MASS Digital Sky Survey. + Syntax: + -2mass [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # 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: + $ds9 -2mass + $ds9 -2mass m31 + $ds9 -2mass name m31 + $ds9 -2mass name clear + $ds9 -2mass 00:42:44.404 +41:16:08.78 + $ds9 -2mass size 60 60 arcmin + $ds9 -2mass save yes + $ds9 -2mass frame current + $ds9 -2mass update frame + $ds9 -2mass survey j + $ds9 -2mass open + $ds9 -2mass close + + 3d + Support for 3D frame. + Syntax: + -3d [] +     [view <az> <el>] +     [az <az>] +     [el <el>] +     [scale <scale>] +     [method mip|aip] +     [background none|azimuth|elevation] +     [border yes|no] +     [border color] +     [highlite yes|no] +     [highlite color] +     [compass yes|no] +     [compass color] +     [match] +     [lock [yes|no]] +     [open|close] + + Example: + $ds9 -3d # create new 3D frame + $ds9 -3d view 45 30 + $ds9 -3d az 45 + $ds9 -3d el 30 + $ds9 -3d scale 10 + $ds9 -3d method mip + $ds9 -3d background azimuth + $ds9 -3d border yes + $ds9 -3d border color red + $ds9 -3d highlite yes + $ds9 -3d highlite color red + $ds9 -3d compass yes + $ds9 -3d compass color red + $ds9 -3d match + $ds9 -3d lock yes + $ds9 -3d open + $ds9 -3d close + about + Get DS9 credits. + Syntax: + -about + + Example: + $ds9 -about + + align + Controls the World Coordinate System alignment for the current + frame. + Syntax: + -align [yes|no] + + Example: + $ds9 -align yes + + 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: + $ds9 -analysis 0 # invoke first analysis task + $ds9 -analysis task 0 + $ds9 -analysis task foobar + $ds9 -analysis task {foo bar} + $ds9 -analysis my.ans + $ds9 -analysis load my.ans + $ds9 -analysis clear + $ds9 -analysis clear load my.ans + $ds9 -analysis message {This is a message} + $ds9 -analysis text {This is text} + + array + Load raw data array into current frame. + + Syntax: + -array <filename> +[[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,endian=[little|big]] + + Example: + $ds9 -array foo.arr[dim=512,bitpix=-32,endian=little] + $cat foo.arr | ds9 -array -[dim=512,bitpix=-32,endian=little] + + asinh + Select ASINH scale function for the current frame. + Syntax: + -asinh + + Example: + $ds9 -asinh + bg + background + Set image background color. + Syntax: + -bg <color> + + Example: + $ds9 -background red + $ds9 -bg red + backup + Create a backup save set. + Syntax: + -backup <filename> + + Example: + $ds9 -backup ds9.bck + bin + Controls binning factor, binning buffer size, and binning + function for binning FITS bin tables. + Syntax: + -bin [about <x> <y>] +     [about center] +     [buffersize <value>] +     [cols <x> <y>] +     [colsz <x> <y> <z>] +     [factor <value> [<value>]] +     [depth <value>] +     [filter <string>] +     [filter clear] +     [function average|sum] +     [in] +     [out] +     [to fit] +     [match] +     [lock [yes|no]] +     [open|close] + + Example: + $ds9 -bin about 4096 4096 + $ds9 -bin about center + $ds9 -bin buffersize 512 + $ds9 -bin cols detx dety + $ds9 -bin colsz detx dety time + $ds9 -bin factor 4 + $ds9 -bin factor 4 2 + $ds9 -bin depth 10 + $ds9 -bin filter 'pha > 5' + $ds9 -bin filter clear + $ds9 -bin function sum + $ds9 -bin in + $ds9 -bin out + $ds9 -bin to fit + $ds9 -bin match + $ds9 -bin lock yes + $ds9 -bin open + $ds9 -bin close + + blink + Blink mode parameters. Interval is in seconds. + Syntax: + -blink [] +     [yes|no] +     [interval <value>] + + Example: + $ds9 -blink + $ds9 -blink yes + $ds9 -blink interval 1 + block + Controls blocking parameters. + Syntax: + -block[<value>] +     [<value> <value>] +     [to <value>] +     [to <value> <value>] +     [in] +     [out] +     [to fit] +     [match] +     [lock [yes|no]] +     [open|close] + + Example: + $ds9-block4 + $ds9-block4 2 + $ds9-blockto 4 + $ds9-blockto 4 2 + $ds9-blockin + $ds9-blockout + $ds9-blockto fit + $ds9-blockmatch + $ds9-blocklock yes + $ds9-blockopen + $ds9-blockclose + + blue + For RGB frames, sets the current color channel to blue. + Syntax: + -blue + + Example: + $ds9 -blue foo.fits + + 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 [new] +     [ned|simbad|denis|skybot] +     +[aavso|ac|ascss|cmc|gaia|gsc1|gsc2|gsc3|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|sdss9|tycho] +     [ua2|ub1|ucac2|ucac2sup|ucac3|ucac4|urat1] +     [2mass|iras] +     [csc|xmm|rosat] +     [first|nvss] +     [chandralog|cfhtlog|esolog|stlog|xmmlog] +     [cds <catalogname>] +     [cds <catalogid>] + +     [load <filename>] +     [import sb|tsv <filename>] + +     [<ref>] [<ra> <dec> + <coordsys>] +     [<ref>] [allcols] +     [<ref>] [allrows] +     [<ref>] [cancel] +     [<ref>] [clear] +     [<ref>] [close] +     [<ref>] [crosshair] +     [<ref>] [dec <col>] +     [<ref>] [edit yes|no] +     [<ref>] [export sb|tsv + <filename>] +     [<ref>] [filter <string>] +     [<ref>] [filter load <filename>] +     [<ref>] [header] +     [<ref>] [location <code>] +     [<ref>] [match <ref> <ref>] +     [<ref>] [match] +     [<ref>] [match error <value> + degrees|arcmin|arcsec] +     [<ref>] [match function + 1and2|1not2|2not1] +     [<ref>] [match return + 1and2|1only|2only] +     [<ref>] [match unique yes|no] +     [<ref>] [maxrows <number>] +     [<ref>] [name <object>] +     [<ref>] [panto yes|no] +     [<ref>] [plot <xcol> <ycol> + <xerrcol> <yerrcol>] +     [<ref>] [print] +     [<ref>] [psky <skyframe>] +     [<ref>] [psystem <coordsys>] +     [<ref>] [ra <col>] +     [<ref>] [regions] +     [<ref>] [retrieve] +     [<ref>] [samp] +     [<ref>] [samp broadcast] +     [<ref>] [samp send <application>] +     [<ref>] [save <filename>] +     [<ref>] + [servercds|adac|cadc|cambridge|sao|ukirt|iucaa|bejing|saao] +     [<ref>] [show yes|no] +     [<ref>] [radius <value> + degrees|arcmin|arcsec] +     [<ref>] [sky <skyframe>] +     [<ref>] [skyformat <skyformat>] +     [<ref>] [sort <col> incr|decr] +     [<ref>] [symbol [#] + condition|shape|color|text|font|fontsize|fontweight|fontslant + <value>] +     [<ref>] [symbol [#] + text|size|size2|units|angle <value>] +     [<ref>] [symbol shape + circle|ellipse|box|text|point] +     [<ref>] [symbol shapecircle point|box + point|diamond point|cross point|x point|arrow point|boxcircle + point] +     [<ref>] [symbol add| [#] remove] +     [<ref>] [symbol save|load + <filename>] +     [<ref>] [system <coordsys>] +     [<ref>] [update] +     [<ref>] [x <col>] +     [<ref>] [y <col>] + + Example: + $ds9 -catalog new + $ds9 -catalog 2mass + $ds9 -catalog cds 2mass + $ds9 -catalog cds "I/252" + + $ds9 -catalog load foo.xml + $ds9 -catalog import tsv foo.tsv + + $ds9 -catalog 202.48 47.21 fk5 + $ds9 -catalog allrows + $ds9 -catalog allcols + $ds9 -catalog cancel + $ds9 -catalog clear + $ds9 -catalog close + $ds9 -catalog crosshair + $ds9 -catalog dec DEC + $ds9 -catalog edit yes + $ds9 -catalog export tsv bar.tsv + $ds9 -catalog filter'\$Jmag>15' + $ds9 -catalog filter load foo.flt + $ds9 -catalog header + $ds9 -catalog location 500 + $ds9 -catalog match error 2 arcsec + $ds9 -catalog match function 1and2 + $ds9 -catalog match unique no + $ds9 -catalog match return 1only + $ds9 -catalog match # last two catalogs loaded + $ds9 -catalog match 2mass csc + $ds9 -catalog maxrows 2000 + $ds9 -catalog name m51 + $ds9 -catalog panto no + $ds9 -catalog plot'$Jmag' '$Hmag' '$e_Jmag' '$e_Hmag' + $ds9 -catalog print + $ds9 -catalog psky fk5 + $ds9 -catalog psystem wcs + $ds9 -catalog ra RA + $ds9 -catalog regions + $ds9 -catalog retrieve + $ds9 -catalog samp broadcast + $ds9 -catalog samp send aladin + $ds9 -catalog save foo.xml + $ds9 -catalog server sao + $ds9 -catalog show yes + $ds9 -catalog radius 1 degrees + $ds9 -catalog symbol condition '\$Jmag>15' + $ds9 -catalog symbol 2 shape "boxcircle point" + $ds9 -catalog symbol color red + $ds9 -catalog symbol font times + $ds9 -catalog symbol fontsize 14 + $ds9 -catalog symbol fontweight bold + $ds9 -catalog symbol fontslant italic + $ds9 -catalog symbol add + $ds9 -catalog symbol 2 remove + $ds9 -catalog symbol load foo.sym + $ds9 -catalog symbol save bar.sym + $ds9 -catalog sky fk5 + $ds9 -catalog skyformat degrees + $ds9 -catalog sort "Jmag" incr + $ds9 -catalog system wcs + $ds9 -catalog update + $ds9 -catalog x RA + $ds9 -catalog y DEC + cd + Sets the current working directory. + Syntax: + cd [<directory>] + + Example: + $ds9 -cd /home/mrbill + + cmap + Controls the colormap for the current frame. The colormap name + is not case sensitive. A valid contrast value is from 0 to + 10 and bias value from 0 to 1. + Syntax: + -cmap [<colormap>] +     [load <filename>] +     [save <filename>] +     [invert yes|no] +     [<contrast> <bias>] +     [tag [load|save] <filename>] +     [tag delete] +     [open|close] + + Example: + $ds9 -cmap Heat + $ds9 -cmap load foo.sao + $ds9 -cmap save bar.sao + $ds9 -cmap invert yes + $ds9 -cmap 5 .5 + $ds9 -cmap tag load foo.tag + $ds9 -cmap tag save foo.tag + $ds9 -cmap tag delete + $ds9 -cmap open + $ds9 -cmap close + + colorbar + Controls colorbar parameters. + Syntax: + -colorbar [] +     [yes|no] +     [horizontal|vertical] +     [numerics yes|no] +     [space value|distance] +     [font times|helvetica|courier] +     [fontsize <value>] +     [fontweight normal|bold] +     [fontslant roman|italic] +     [size] +     [ticks] +     [match] +     [lock [yes|no]] + + Example: + $ds9 -colorbar yes + $ds9 -colorbar vertical + $ds9 -colorbar numerics yes + $ds9 -colorbar space value + $ds9 -colorbar font times + $ds9 -colorbar fontsize 14 + $ds9 -colorbar fontweight bold + $ds9 -colorbar fontslant italic + $ds9 -colorbar size 20 + $ds9 -colorbar ticks 11 + $ds9 -colorbar match + $ds9 -colorbar lock yes + console + Display tcl console window. + Syntax: + -console + + Example: + $ds9 -console + + contour + + Controls contours in the current frame. + Syntax: + -contour [] +     [yes|no] +     [clear] +     [generate] +     [load <filename>] +     [save <filename> [<coordsys> + <skyframe>]] +     [convert] +     [load levels <filename>] +     [save levels <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|asinh|sinh|histequ] +     [log exp <value>] +     [mode minmax|<value>|zscale|zmax] +     [scope global|local] +     [limits <min> <max>] +     [levels <value value value...>] +     [open|close] + + Example: + $ds9 -contour + $ds9 -contour yes + $ds9 -contour generate + $ds9 -contour clear + $ds9 -contour load ds9.ctr + $ds9 -contour save ds9.ctr + $ds9 -contour save ds9.ctr wcs fk5 + $ds9 -contour convert + $ds9 -contour load levels ds9.ctr + $ds9 -contour save levels ds9.lev + $ds9 -contour copy + $ds9 -contour paste + $ds9 -contour paste wcs red 2 no + $ds9 -contour color yellow + $ds9 -contour width 2 + $ds9 -contour dash yes + $ds9 -contour smooth 5 + $ds9 -contour method smooth + $ds9 -contour nlevels 10 + $ds9 -contour scale sqrt + $ds9 -contour log exp 1000 + $ds9 -contour mode zscale + $ds9 -contour scope local + $ds9 -contour limits 1 100 + $ds9 -contour levels 1 10 100 1000 + $ds9 -contour open + $ds9 -contour close + + crop + Set current image display area. + Syntax: + -crop [<x> <y> <width> <height> + [<coordsys>][<skyframe>][degrees|arcmin|arcsec] +     [match <coordsys>] +     [lock <coordsys>|none] +     [reset] +     [3d zmin zmax <coordsys>] +     [open|close] + + Example: + $ds9 foo.fits -crop 40 30 10 20 # set crop in physical coords + $ds9 foo.fits -crop +104:51:06.915 +68:33:40.761 28.144405 + 22.000204 wcs galactic arcsec + $ds9 foo.fits -crop match wcs + $ds9 foo.fits -crop lock wcs + $ds9 foo.fits -crop reset + $ds9 foo.fits -crop 3d .25 .5 wcs + $ds9 foo.fits -crop open + $ds9 foo.fits -crop 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> <h> <coordsys> + [<skyframe>]] +    [match <coordsys>] +     [lock <coordsys>|none] + + Example: + $ds9 -crosshair 100 100 physical # set crosshair in physical + $ds9 -crosshair 345 58.8 wcs fk5 # set crosshair in wcs coords + $ds9 -crosshair 23:01:00 +58:52:51 wcs fk5 + $ds9 -crosshair match + $ds9 -crosshair lock wcs + + cube + + Controls FITS cube. + Syntax: + -cube [] +     [play|stop|next|prev|first|last] +     [<slice> [<coordsys>]] +     [interval <numeric>] +     [match <coordsys>] +     [lock <coordsys>|none] +     [order 123|132|213|231|312|321] +     [axes lock [yes|no]] +     [axis <axis>] +     [open|close] + + Example: + $ds9 -cube + $ds9 -cube play + $ds9 -cube last + $ds9 -cube 3 + $ds9 -cube 4.5 wcs + $ds9 -cube interval 2 + $ds9 -cube match wcs + $ds9 -cube lock wcs + $ds9 -cube order 123 + $ds9 -cube axes lock yes + $ds9 -cube axis 3 + $ds9 -cube open + $ds9 -cube close + cursor + Move mouse pointer or crosshair in image pixels in the current + frame. Note, this will move selected Regions also. + Syntax: + -cursor [<x> <h>] + + Example: + $ds9 -cursor 10 10 + + dsssao + dss + + Support for Digital Sky Survey at SAO. + Syntax: + -dsssao [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [open|close] + + Example: + $ds9 -dsssao + $ds9 -dsssao m31 + $ds9 -dsssao name m31 + $ds9 -dsssao name clear + $ds9 -dsssao 00:42:44.404 +41:16:08.78 + $ds9 -dsssao size 60 60 arcmin + $ds9 -dsssao save yes + $ds9 -dsssao frame current + $ds9 -dsssao update frame + $ds9 -dsssao open + $ds9 -dsssao close + + dsseso + Support for Digital Sky Survey at ESO. + Syntax: + -dsseso [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # 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: + $ds9 -dsseso + $ds9 -dsseso m31 + $ds9 -dsseso name m31 + $ds9 -dsseso name clear + $ds9 -dsseso 00:42:44.404 +41:16:08.78 + $ds9 -dsseso size 60 60 arcmin + $ds9 -dsseso save yes + $ds9 -dsseso frame current + $ds9 -dsseso update frame + $ds9 -dsseso survey DSS2-red + $ds9 -dsseso open + $ds9 -dsseso close + dssstsci + Support for Digital Sky Survey at STSCI. + Syntax: + -dssstsci [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # 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: + $ds9 -dssstsci + $ds9 -dssstsci m31 + $ds9 -dssstsci name m31 + $ds9 -dssstsci name clear + $ds9 -dssstsci 00:42:44.404 +41:16:08.78 + $ds9 -dssstsci size 60 60 arcmin + $ds9 -dssstsci save yes + $ds9 -dssstsci frame current + $ds9 -dssstsci update frame + $ds9 -dssstsci survey all + $ds9 -dssstsci open + $ds9 -dssstsci close + envi + Load an ENVI header and file. Optional parameter: array endian. + + Syntax: + -envi <header> [<filename>] + + Example: + $ds9 -envi foo.hdr + $ds9 -envi foo.hdr foo.bsq + + exit + quit + Quits DS9. + Syntax: + -exit + -quit + + Example: + $ds9 -exit + + export + + Export loaded image data of current frame in specified image + format, at native resolution, using current colormap and + contrast/bias settings. NOTE: not scaling, rotation, or + translation is applied. If no format specified, the file name + extension is used to determine the output format. Optional + parameters: jpeg quality (1-100) and tiff compression method. + + Syntax: + -export [array|nrrd|envi|gif|tiff|jpeg|png] <filename> + -export array <filename>[big|little|native] + -export nrrd <filename>[big|little|native] + -export envi <header> + [<filename>][big|little|native] + -export <filename>.jpeg [1-100] + -export <filename>.tiff [none|jpeg|packbits|deflate] + + Example: + $ds9 -export array foo.arr little + $ds9 -export nrrd foo.nrrd little + $ds9 -export envi foo.hdr little + $ds9 -export envi foo.hdr foo.bsq little + $ds9 -export tiff foo.tiff jpeg + $ds9 -export jpeg foo.jpeg 75 + $ds9 -export png foo.png + fifo + Set the name of the IRAF input and output fifos. The default is + /dev/imt1. These fifos are used by IRAF to communicate with DS9. + Syntax: + -fifo name + + Example: + $ds9 -fifo /dev/imt1 + fifo_only + Only use IRAF input and output fifos. Same as -port 0 -unix + none. + Syntax: + -fifo_only + + Example: + $ds9 -fifo_only + + fits + Load a FITS image into the current frame. + + Syntax: + -fits<filename> + + Example: + $ds9 -fits foo.fits + $ds9 -fits bar.fits[bin=detx,dety] + $cat foo.fits | ds9 -fits - + $cat bar.fits | ds9 -fits -[bin=detx,dety] + + 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 #] +     [#] +     [match <coordsys>] +     [lock <coordsys>|none] + + Example: + $ds9 -frame center # center current frame + $ds9 -frame center 1 # center 'Frame1' + $ds9 -frame center all # center all frames + $ds9 -frame clear # clear current frame + $ds9 -frame new # create new frame + $ds9 -frame new rgb # create new rgb frame + $ds9 -frame delete # delete current frame + $ds9 -frame reset # reset current frame + $ds9 -frame refresh # refresh current frame + $ds9 -frame hide # hide current frame + $ds9 -frame show 1 # show frame 'Frame1' + $ds9 -frame move first # move frame to first in order + $ds9 -frame move back # move frame back in order + $ds9 -frame move forward # move frame forward in order + $ds9 -frame move last # move frame to last in order + $ds9 -frame first # goto first frame + $ds9 -frame prev # goto prev frame + $ds9 -frame next # goto next frame + $ds9 -frame last # goto last frame + $ds9 -frame frameno 4 # goto frame 'Frame4', create if needed + $ds9 -frame 3 # goto frame 'Frame3', create if needed + $ds9 -frame lock wcs + gif + Load GIF image into current frame. + Syntax: + -gif <filename> + + Example: + $ds9 -gif foo.gif + $cat foo.gif | ds9 -gif - + + geometry + Define the initial window geometry. This includes all of the + ds9 window, not just the image space. see X(1). + Syntax: + -geometry value + + Example: + $ds9 -geometry 640x480 + green + For RGB frames, sets the current color channel to green. + Syntax: + -green + + Example: + $ds9 -green foo.fits + 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 dash yes|no] +     [grid gap1 <value>] +     [grid gap2 <value>] +     [grid gap3 <value>] +     [axes yes|no] +     [axes color <color>] +     [axes width <value>] +     [axes dash yes|no] +     [axes type interior|exterior] +     [axes origin lll|llu|lul|luu|ull|ulu|uul|uuu] +     [format1 <format>] +     [format2 <format>] +     [tickmarks yes|no] +     [tickmarks color <color>] +     [tickmarks width <value>] +     [tickmarks dash yes|no] +     [border yes|no] +     [border color <color>] +     [border width <value>] +     [border dash yes|no] +     [numerics yes|no] +     [numerics font times|helvetica|courier] +     [numerics fontsize <value>] +     [numerics fontweight normal|bold] +     [numerics fontslant roman|italic] +     [numerics color <color>] +     [numerics gap1 <value>] +     [numerics gap2 <value>] +     [numerics gap3 <value>] +     [numerics type interior|exterior] +     [numerics 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>] +     [labels yes|no] +     [labels text1 <text>] +     [labels text2 <text>] +     [labels def1 yes|no] +     [labels def2 yes|no] +     [labels gap1 <value>] +     [labels gap2 <value>] +     [labels font times|helvetica|courier] +     [labels fontsize <value>] +     [labels fontweight normal|bold] +     [labels fontslant roman|italic] +     [labels color <color>] +     [reset] +     [load <filename>] +     [save <filename>] +     [open|close] + + Example: + $ds9 -grid + $ds9 -grid yes + $ds9 -grid type analysis + $ds9 -grid system wcs + $ds9 -grid sky fk5 + $ds9 -grid skyformat degrees + $ds9 -grid grid yes + $ds9 -grid grid color red + $ds9 -grid grid width 2 + $ds9 -grid grid dash yes + $ds9 -grid grid gap1 10 + $ds9 -grid grid gap2 10 + $ds9 -grid grid gap3 10 + $ds9 -grid axes yes + $ds9 -grid axes color red + $ds9 -grid axes width 2 + $ds9 -grid axes dash yes + $ds9 -grid axes type exterior + $ds9 -grid axes origin lll + $ds9 -grid format1 d.2 + $ds9 -grid format2 d.2 + $ds9 -grid tickmarks yes + $ds9 -grid tickmarks color red + $ds9 -grid tickmarks width 2 + $ds9 -grid tickmarks dash yes + $ds9 -grid border yes + $ds9 -grid border color red + $ds9 -grid border width 2 + $ds9 -grid border dash yes + $ds9 -grid numerics yes + $ds9 -grid numerics font courier + $ds9 -grid numerics fontsize 12 + $ds9 -grid numerics fontweight bold + $ds9 -grid numerics fontslant italic + $ds9 -grid numerics color red + $ds9 -grid numerics gap1 10 + $ds9 -grid numerics gap2 10 + $ds9 -grid numerics gap3 10 + $ds9 -grid numerics type exterior + $ds9 -grid numerics vertical yes + $ds9 -grid title yes + $ds9 -grid title text {Hello World} + $ds9 -grid title def yes + $ds9 -grid title gap 10 + $ds9 -grid title font courier + $ds9 -grid title fontsize 12 + $ds9 -grid title fontweight bold + $ds9 -grid title fontslant italic + $ds9 -grid title color red + $ds9 -grid labels yes + $ds9 -grid labels text1 {Hello World} + $ds9 -grid labels text2 {Hello World} + $ds9 -grid labels def1 yes + $ds9 -grid labels def2 yes + $ds9 -grid labels gap1 10 + $ds9 -grid labels gap2 10 + $ds9 -grid labels font courier + $ds9 -grid labels fontsize 12 + $ds9 -grid labels fontweight bold + $ds9 -grid labels fontslant italic + $ds9 -grid labels color red + $ds9 -grid reset + $ds9 -grid load foo.grd + $ds9 -grid save foo.grd + $ds9 -grid open + $ds9 -grid close + + header + Display current fits header dialog. Optional extension number + maybe specified. + Syntax: + -header [<ext>] +     [close [<ext>]] +     [save [<ext>] <filename>] + + Example: + $ds9 -header + $ds9 -header 2 + $ds9 -header close + $ds9 -header save 1 foo.txt + + height + Set the height of the image display window. Use the geometry command to set the + overall width and height of the ds9 window. + Syntax: + -height [<value>] + + Example: + $ds9 -height 512 + + help + Display help information. To maintain backward compatibility, + -help will display a brief help message and exit. --help will + display all command line options within the built-in help + facility. + Syntax: + -help # Display brief help message and exit. + --help # Display command line options within help facility. + -? # Display command line options within help facility. + + Example: + $ds9 -help # Display brief help message and exit. + $ds9 --help # Display command line options within help facility + $ds9 -? # Display command line options within help facility. + + histequ + Select histogram equalization scale function for the current + frame. + Syntax: + -histequ + + Example: + $ds9 -histequ + + iconify + Toggles iconification. + Syntax: + -iconify [] +     [yes|no] + + Example: + $ds9 -iconify + $ds9 -iconify yes + invert + Invert Colormap. + Syntax: + -invert + + Example: + $ds9 -invert + + iis + Set IIS Filename. Optional mosaic number maybe supplied. + Syntax: + -iis [filename <filename> [#]] + + Example: + $ds9 -iis filename foo.fits + $ds9 -iis filename bar.fits 4 + jpeg + Load JPEG image into current frame. + Syntax: + -jpeg <filename> + + Example: + $ds9 -jpeg foo.jpeg + $cat foo.jpeg | ds9 -jpeg - + language + Select current language. + Syntax: + -language [locale|da|de|es|en|fr|ja|pt] + + Example: + $ds9 -language fr + + linear + Select linear scale function for the current frame. + Syntax: + -linear + + Example: + $ds9 -linear + lock + Lock all other frames to the current frame. + Syntax: + -lock[frame <coordsys>|none] +     [crosshair <coordsys>|none] +     [crop <coordsys>|none] +     [slice <coordsys>|none] +     [bin [yes|no]] +     [axes [yes|no]] +     [scale [yes|no]] +     [scalelimits [yes|no]] +     [colorbar [yes|no]] +     [block [yes|no]] +     [smooth [yes|no]] +     [3d [yes|no]] + + Example: + $ds9 -lock frame wcs + $ds9 -lock crosshair wcs + $ds9 -lock crop wcs + $ds9 -lock slice wcs + $ds9 -lock bin yes + $ds9 -lock axes yes + $ds9 -lock scale yes + $ds9 -lock scalelimits yes + $ds9 -lock colorbar yes + $ds9 -lock block yes + $ds9 -lock smooth yes + $ds9 -lock 3d yes + + log + Select log scale function for the current frame. + + Syntax: + -log + + Example: + $ds9 -log + lower + Lower in the window stacking order. + Syntax: + -lower + + Example: + $ds9 -lower + + magnifier + Controls the magnifier settings. + Syntax: + magnifier [color <color>] +     [zoom <value>] +     [cursor yes|no] +     [region yes|no] + + Example: + $ds9 -magnifier color yellow + $ds9 -magnifier zoom 2 + $ds9 -magnifier cursor no + $ds9 -magnifier region no + + mask + nomask + + Controls mask parameters. + Syntax: + -mask [color <color>] +     [mark zero|nonzero|nan|nonnan|range] +     [range <low> <high>] +     [transparency <value>] +     [system <coordsys>] +     [clear] +     [open|close] + -nomask + + Example: + $ds9 -mask color red + $ds9 -mask mark zero + $ds9 -mask range 10 100 + $ds9 -mask transparency 50 + $ds9 -mask system wcs + $ds9 -mask clear + $ds9 -mask open + $ds9 -mask close + $ds9 -nomask + + match + Match all other frames to the current frame. + Syntax: + -match[frame <coordsys>] +     [crosshair <coordsys>] +     [crop <coordsys>] +     [slice <coordsys>] +     [bin] +     [axes] +     [scale] +     [scalelimits] +     [colorbar] +     [block] +     [smooth] +     [3d] + + Example: + $ds9 -match frame wcs + $ds9 -match crosshair wcs + $ds9 -match crop wcs + $ds9 -match slice wcs + $ds9 -match bin + $ds9 -match axes + $ds9 -match scale + $ds9 -match scalelimits + $ds9 -match colorbar + $ds9 -match block + $ds9 -match smooth + $ds9 -match 3d + + mecube + Load FITS multiple extension file as data cube. + + Syntax: + mecube <filename> + + Example: + $ds9 -mecube foo.fits + $cat foo.fits | ds9 -mecube - + minmax + This is how DS9 determines the min and max data values + from the data. SCAN will scan all data. + Syntax: + -minmax [scan|sample|datamin|irafmin] +     [mode scan|sample|datamin|irafmin] +     [interval #] + + Example: + $ds9 -minmax scan + $ds9 -minmax mode scan + $ds9 -minmax interval 100 + + mode + Select the current mode. + Syntax: + -mode + [none|region|crosshair|colorbar|pan|zoom|rotate|catalog|examine|3d] + + Example: + $ds9 -mode crosshair + mosaic + Load FITS mosaic segment into current frame. + Syntax: + -mosaic [wcs|wcsa...wcsz|iraf] <filename> + + Example: + $ds9 -mosaic foo.fits + $ds9 -mosaic wcs foo.fits + $cat foo.fits | ds9 -mosaic - + $cat foo.fits | ds9 -mosaic wcs - + + mosaicimage + Load FITS mosaic image into current frame. + Syntax: + -mosaicimage [wcs|wcsa...wcsz|iraf|wfpc2] <filename> + + Example: + $ds9 -mosaicimage foo.fits + $ds9 -mosaicimage wcs foo.fits + $cat foo.fits | ds9 -mosaicimage + $cat foo.fits | ds9 -mosaiimage wcs + + movie + + Create a movie from snap shots of the DS9 window. A slice + movie cycles though all slices of a cube. A frame + movie cycles through all active frames. A 3d movie + cycles through specified viewing angles. The default action is slice. + Movie types are either MPEG or Animated GIF, + with default MPEG. Optional parameters for 3d: + number of frames, azimuth from/to, elevation from/to, slice + from/to, oscillate/repeat times. + Syntax: + -movie [slice|frame|3d] [mpeg|gif] <filename> + -movie 3d [mpeg|gif] <filename> + [number|azfrom|azto|elfrom|elto|slfrom|slto|oscillate|repeat + <#>] + + Example: + $ds9 -movie slice mpeg ds9.mpg + $ds9 -movie frame gif ds9.gif + $ds9 -movie 3d mpeg ds9.mpg number 10 azfrom -60 azto 60 + oscillate 1 + msg + Specify a directory of translation tables to be loaded. + Syntax: + -msg <directory> + + Example: + $ds9 -msg $HOME/msgs + multiframe + Load FITS multiple extension file as multiple images. + + Syntax: + multiframe <filename> + + Example: + $ds9 -multiframe foo.fits + $cat foo.fits | ds9 -multiframe - + + nameserver + Support Name Server functions. Coordinates are in fk5. + Syntax: + -nameserver [<object>] +     [name <object>] +     [skyformat degrees|sexagesimal] +     [pan] +     [crosshair] +     [open|close] + + Example: + $ds9 -nameserver m31 + $ds9 -nameserver name m31 + $ds9 -nameserver server ned-sao + $ds9 -nameserver skyformat sexagesimal + $ds9 -nameserver pan + $ds9 -nameserver crosshair + $ds9 -nameserver open + $ds9 -nameserver close + + nan + Set image not-a-number color. + Syntax: + -nan <color> + + Example: + $ds9 -nan red + nrrd + Load an NRRD (Nearly Raw Raster Data) file. + + Syntax: + -nrrd <filename> + + Example: + $ds9 -nrrd foo.nrrd + $cat foo.nrrd | xpaset ds9 -nrrd- + + nvss + Support for NRAO VLA Sky Survey. + Syntax: + -nvss [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [open|close] + + Example: + $ds9 -nvss + $ds9 -nvss m31 + $ds9 -nvss name m31 + $ds9 -nvss name clear + $ds9 -nvss 00:42:44.404 +41:16:08.78 + $ds9 -nvss size 60 60 arcmin + $ds9 -nvss save yes + $ds9 -nvss frame current + $ds9 -nvss update frame + $ds9 -nvss open + $ds9 -nvess close + + orient + Controls the orientation of the current frame. + Syntax: + -orient [none|x|y|xy] +     [open|close] + + Example: + $ds9 -orient xy + $ds9 -orient open + $ds9 -orient close + + pagesetup + Controls Page Setup options. + + Syntax: + -pagesetup [orient portrait|landscape] +     [scale <numberic>] +     [size letter|legal|tabloid|poster|a4] + + Example: + $ds9 -pagesetup orient portrait + $ds9 -pagesetup scale 50 + $ds9 -pagesetup size poster + pan + Controls the current image cursor location for the current + frame. + Syntax: + -pan [<x> <h> <coordsys> [<skyframe>]] # + relative +     [to <x> <h> <coordsys> + [<skyframe>]] # absolute +     [open|close] + + Example: + $ds9 -pan 200 200 image# pan relative + $ds9 -pan to 400 400 physical# pan to physical coords + $ds9 -pan to 13:29:55 47:11:50 wcs fk# pan to wcs coords + $ds9 -pan open + $ds9 -pan close + pixeltable + Display/Hide the pixel table. + Syntax: + -pixeltable [] +     [yes|open] +     [no|close] + + Example: + $ds9 -pixeltable + $ds9 -pixeltable yes + $ds9 -pixeltable open + $ds9 -pixeltable close + + plot + Display and configure data plots. All plot commands take an + optional second command, the plot name. 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 x and y + errors + + To create a new plot, use the plot new command. + Syntax: + # create new empty plot window + -plot [line|bar|scatter] + + # existing plot + -plot [[<plotname>] load <filename> + xy|xyex|xyey|xyexey] +     [[<plotname>] save <filename>] +     [[<plotname>] layout + grid|row|column|strip] +     [[<plotname>] layout strip scale + <percent>] +     [[<plotname>] add graph + line|bar|scatter] +     [[<plotname>] select graph + <graph>] +     [[<plotname>] delete graph] +     [[<plotname>] select dataset + <dataset>] +     [[<plotname>] delete dataset] +     [[<plotname>] duplicate] +     [[<plotname>] stats yes|no] +     [[<plotname>] list yes|no] +     [[<plotname>] loadconfig + <filename>] +     [[<plotname>] saveconfig + <filename>] +     [[<plotname>] pagesetup orient + portrait|landscape] +     [[<plotname>] pagesetup size + letter|legal|tabloid|poster|a4] +     [[<plotname>] print] +     [[<plotname>] print destination + printer|file] +     [[<plotname>] print command + <command>] +     [[<plotname>] print filename + <filename>] +     [[<plotname>] print color rgb|gray] +     [[<plotname>] close] +     [[<plotname>] mode pointer|zoom] + + # export image + plot [[<plotname>] export <filename>] +     [[<plotname>] export gif|tiff|jpeg|png + <filename>] +     [[<plotname>] export jpeg + <filename> [1-100]] +     [[<plotname>] export tiff + <filename> none|jpeg|packbits|deflate]] + # configure graph + -plot [[<plotname>] axis x|y grid yes|no] +     [[<plotname>] axis x|y log yes|no] +     [[<plotname>] axis x|y flip yes|no] +     [[<plotname>] axis x|y auto yes|no] +     [[<plotname>] axis x|y min + <value>] +     [[<plotname>] axis x|y max + <value>] +     [[<plotname>] axis x|y format + <string>] +     [[<plotname>] background <value>] +     [[<plotname>] legend yes|no] +     [[<plotname>] legend position + right|left|top|bottom|plotarea] +     [[<plotname>] font title|labels|numbers + font times|helvetica|courier] +     [[<plotname>] font title|labels|numbers + size <value>] +     [[<plotname>] font title|labels|numbers + weight normal|bold] +     [[<plotname>] font title|labels|numbers + slant roman|italic] +     [[<plotname>] title <string>] +     [[<plotname>] title x|y <string>] +     [[<plotname>] barmode + normal|stacked|aligned|overlap] + + # configure current dataset + -plot [[<plotname>] show yes|no] +    [[<plotname>] shape + none|circle|square|diamond|plus|splus|scross|triangle|arrow] +    [[<plotname>] shape fill yes|no] +    [[<plotname>] shape color <value>] +    [[<plotname>] smooth + step|linear|cubic|quadratic|catrom] +    [[<plotname>] color <value>] +    [[<plotname>] width <value>] +    [[<plotname>] dash yes|no] +    [[<plotname>] error yes|no] +    [[<plotname>] error color <value>] +    [[<plotname>] error cap yes|no] +    [[<plotname>] error width <value>] +    [[<plotname>] name <string>] + + Example: + # create new empty plot window + $ds9 -plot bar + + # existing plot + $ds9 -plot load xy.dat + $ds9 -plot save foo.dat + $ds9 -plot layout strip + $ds9 -plot layout strip scale 30 + $ds9 -plot add graph scatter + $ds9 -plot select graph 1 + $ds9 -plot delete graph + $ds9 -plot select dataset 1 + $ds9 -plot delete dataset + $ds9 -plot duplicate + $ds9 -plot stats yes + $ds9 -plot list yes + $ds9 -plot loadconfig foo.plt + $ds9 -plot saveconfig foo.plt + $ds9 -plot pagesetup orient portrait + $ds9 -plot pagesetup size letter + $ds9 -plot print + $ds9 -plot print destination file + $ds9 -plot print command lp + $ds9 -plot print filename foo.ps + $ds9 -plot print color rgb + $ds9 -plot close + + # plot mode + $ds9 -plot mode pointer + + # export plot + $ds9 -plot export tiff foo.tiff jpeg + $ds9 -plot export jpeg foo.jpeg 75 + $ds9 -plot export png foo.png + + # configure plot + $ds9 -plot axis x grid yes + $ds9 -plot axis x log yes + $ds9 -plot axis x flip yes + $ds9 -plot axis x auto no + $ds9 -plot axis x min 1 + $ds9 -plot axis x max 100 + $ds9 -plot axis x format '%f' + $ds9 -plot background white + $ds9 -plot legend yes + $ds9 -plot legend position left + $ds9 -plot font numbers font times + $ds9 -plot font numbers size 12 + $ds9 -plot font numbers weight bold + $ds9 -plot font numbers slant italic + $ds9 -plot title 'This is a Title' + $ds9 -plot title x 'X Axis' + $ds9 -plot title y 'Y Axis' + $ds9 -plot title legend 'This is the Legend' + + # bar plot + $ds9 -plot barmode aligned + + # configure current dataset + $ds9 -plot show yes + $ds9 -plot shape circle + $ds9 -plot shape fill no + $ds9 -plot shape color cyan + $ds9 -plot smooth step + $ds9 -plot color red + $ds9 -plot width 2 + $ds9 -plot dash yes + $ds9 -plot error yes + $ds9 -plot error color red + $ds9 -plot error cap yes + $ds9 -plot error width 2 + $ds9 -plot name 'My Data' + + png + Load PNG image into current frame. + + Syntax: + -png <filename> + + Example: + $ds9 png foo.png + $cat foo.png | ds9 -png - + + port + Set the IRAF port number, used by IRAF to communicate with DS9. + The default is 5137, the standard IRAF port used by ximtool. + Syntax: + -port number + + Example: + $ds9 -port 5137 + port_only + inet_only + Only use the IRAF port number. This is the same as -fifo none + -unix none. + Syntax: + -port_only + + Example: + $ds9 -port_only + + pow + Select power scale function for the current frame. + Syntax: + -pow + + Example: + $ds9 -pow + + precision + Set region and coordinate output format precision. + Syntax: + -precision +<linear><degree><hms><dms><arcmin><arcsec> + + Example: + $ds9 -precision 8 10 4 3 5 3 + prefs + Controls various preference settings. + Syntax: + -prefs [clear] +     [irafalign yes|no] + + Example: + $ds9 -prefs clear + $ds9 -prefs irafalign yes + + preserve + Preserve the follow attributes while loading a new image. + Syntax: + preserve [pan yes|no] +     [regions yes|no] + + Example: + $ds9 -preserve pan yes + $ds9 -preserve regions yes + + psprint + Invokes postscript printing. Please see print + for further details. + print + Controls printing. Use print option to set printing options. + + Syntax: + -print [destination printer|file] +     [command <command>] +     [filename <filename>] +     [color rgb|cmyk|gray] +     [level 1|2|3] +     + [resolution72|screen|96|144|150|225|300|600|1200] + + Example: + $ds9 -print + $ds9 -print destination file + $ds9 -print command lp + $ds9 -print filename foo.ps + $ds9 -print color cmyk + $ds9 -print level 2 + $ds9 -print resolution 96 + raise + Raise in the window stacking order. + Syntax: + -raise + + Example: + $ds9 -raise + + regions + Controls regions in the current frame. + Syntax: + -regions [<filename>] +     [load [all] <filename>] +     [save <filename>] +     [list [close]] +     [epsilon <integer>] +     [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 invert] +     [delete all] +     [delete select] +     [format ds9|xml|ciao|saotng|saoimage|pros|xy] +     [system image|physical|wcs|wcsa...wcsz] +     [sky fk4|fk5|icrs|galactic|ecliptic] +     [skyformat degrees|sexagesimal] +     [strip yes|no] +     [shape <shape>] +     [color <color> +     [width <width>] +     [fixed|edit|rotate|delete yes|no] +     [include|exclude|source|background] +     [command <marker command>] +     [composite] +     [dissolve] +     [template <filename>] +     [template <filename> at <ra> + <dec> <coordsys> <skyframe>] +     [savetemplate <filename>] +     [group new] +     [group <tag> new] +     [group <tag> update] +     [group <tag> select] +     [group <tag> color <color>] +     [group <tag> copy] +     [group <tag> delete] +     [group <tag> cut] +     [group <tag> font <font>] +     [group <tag> move <int> + <int>] +     [group <tag> movefront] +     [group <tag> moveback] +     [group <tag> property <property> + yes|no] +     [copy] +     [cut] +     [paste image|physical|wcs|wcsa...wcsz] +     [undo] + + Example: + $ds9 -regions foo.reg + $ds9 -regions -format ciao bar.reg # load as ciao format + $ds9 -regions foo.fits # FITS regions files do not need a format + specification + $ds9 -regions load foo.reg # load foo.reg into current frame + $ds9 -regions load all foo.reg # load foo.reg into all frames + $ds9 -regions load '*.reg'# expand *.reg and load into current + frame + $ds9 -regions load all '*.reg' # expand *.reg and load into all + frames + $ds9 -regions save foo.reg + $ds9 -regions list + $ds9 -regions list close + $ds9 -regions epsilon 5 + $ds9 -regions show yes + $ds9 -regions showtext no + $ds9 -regions centroid + $ds9 -regions centroid auto yes + $ds9 -regions centroid radius 10 + $ds9 -regions centroid iteration 20 + $ds9 -regions getinfo + $ds9 -regions move back + $ds9 -regions move front + $ds9 -regions select all + $ds9 -regions select none + $ds9 -regions select invert + $ds9 -regions delete all + $ds9 -regions delete select + $ds9 -regions format ds9 + $ds9 -regions system wcs + $ds9 -regions sky fk5 + $ds9 -regions skyformat degrees + $ds9 -regions strip yes + $ds9 -regions shape ellipse + $ds9 -regions color red + $ds9 -regions width 3 + $ds9 -regions edit yes + $ds9 -regions include + $ds9 -regions command "circle 100 100 20 # color=red" + $ds9 -regions composite + $ds9 -regions dissolve + $ds9 -regions template foo.tpl + $ds9 -regions template foo.tpl at 13:29:55.92 +47:12:48.02 fk5 + $ds9 -regions savetemplate foo.tpl + $ds9 -regions group new + $ds9 -regions group foo new + $ds9 -regions group foo update + $ds9 -regions group foo select + $ds9 -regions group foo color red + $ds9 -regions group foo copy + $ds9 -regions group foo delete + $ds9 -regions group foo cut + $ds9 -regions group foo font {times 14 bold} + $ds9 -regions group foo move 100 100 + $ds9 -regions group foo movefront + $ds9 -regions group foo moveback + $ds9 -regions group foo property delete no + $ds9 -regions copy + $ds9 -regions cut + $ds9 -regions paste wcs + $ds9 -regions undo + + red + For RGB frames, sets the current color channel to red. + Syntax: + -red + + Example: + $ds9 -red foo.fits + + restore + Restore DS9 to a previous state from a backup save set. + Syntax: + -restore <filename> + + Example: + $ds9 -restore ds9.bck + 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 + wcs|crop|slice|bin|scale|scalelimits|colorbar|block|smooth + [yes|no]] +     [open|close] + + Example: + $ds9 -rgb # create new rgb frame + $ds9 -rgb red # set current channel to red + $ds9 -rgb channel red # set current channel to red + $ds9 -rgb view blue no # turn off blue channel + $ds9 -rgb system wcs # set rgb coordinate system + $ds9 -rgb lock wcs yes + $ds9 -rgb lock crop yes + $ds9 -rgb lock slice yes + $ds9 -rgb lock bin yes + $ds9 -rgb lock scale yes + $ds9 -rgb lock scalelimits yes + $ds9 -rgb lock colorbar yes + $ds9 -rgb lock block yes + $ds9 -rgb lock smooth yes + $ds9 -rgb open + $ds9 -rgb close + rgbarray + Load raw data array cube into rgb frame. + + Syntax: + -rgbarray +<filename>[[xdim=<x>,ydim=<y>|dim=<dim>],[zdim=3],bitpix=<b>,skip=<s>,endian=[little|big]] + + Example: + $ds9 -rgbarray foo.arr[dim=512,zdim=3,bitpix=-32,endian=little] + $cat foo.arr | ds9 -rgbarray + -[dim=512,zdim=3,bitpix=-32,endian=little] + rgbcube + Load FITS rgbcube into rgb frame. + + Syntax: + -rgbcube <filename> + + Example: + $ds9 -rgbcube foo.fits + $cat foo.fits | ds9 -rgbcube - + rgbimage + Load FITS rgbimage into rgb frame. + + Syntax: + -rgbimage <filename> + + Example: + $ds9 -rgbimage foo.fits + $cat foo.fits | ds9 -rgbimage - + rotate + Controls the rotation angle (in degrees) of the current + frame.< + Syntax: + -rotate [<value>] +     [to <value>] +     [open|close] + + Example: + $ds9 -rotate 45 + $ds9 -rotate to 30 + $ds9 -rotate open + $ds9 -rotate close + + samp + Configure SAMP protocol. + Syntax: + -samp [yes|no|connect|disconnect] +     [broadcast [image|table]] +     [send [image|table] <application>] + + Example: + $ds9 -samp yes + $ds9 -samp connect + $ds9 -samp broadcast image + $ds9 -samp send image aladin + save + + Save loaded image data of current frame as FITS. + Syntax: + -save[fits|rgbimage|rgbcube|mecube|mosaic|mosaicimage] + <filename> [image|table|slice] + + Example: + $ds9 -save foo.fits + $ds9 -save fits foo.fits image + $ds9 -save fits foo.fits table + $ds9 -save fits foo.fits slice + $ds9 -save rgbimage foo.fits + $ds9 -save rgbcube foo.fits + $ds9 -save mecube foo.fits + $ds9 -save mosaic foo.fits + $ds9 -save mosaicimage foo.fits + saveimage + Create a snap shot of the current DS9 window and save in + specified image format. If no format specified, the file name + extension is used to determine the output format. Optional + parameters: jpeg quality (1-100) and tiff + compression method. + Syntax: + -saveimage[fits|eps|gif|tiff|jpeg|png]<filename> + -saveimage <filename>.jpeg [1-100] + -saveimage <filename>.tiff [none|jpeg|packbits|deflate] + + Example: + $ds9 -saveimage ds9.tiff + $ds9 -saveimage jpeg ds9.jpeg 75 + + scale + Controls the limits and color scale distribution. + Syntax: + -scale [linear|log|pow|sqrt|squared|asinh|sinh|histequ] +     [log exp <value>] +     [datasec yes|no] +     [limits <minvalue> <maxvalue>] +     [mode minmax|<value>|zscale|zmax] +     [scope local|global] +     [match] +     [match limits] +     [lock [yes|no]] +     [lock limits [yes|no]] +     [open|close] + + Example: + $ds9 -scale linear + $ds9 -scale log exp 100 + $ds9 -scale datasec yes + $ds9 -scale histequ + $ds9 -scale limits 1 100 + $ds9 -scale mode zscale + $ds9 -scale mode 99.5 + $ds9 -scale scope local + $ds9 -scale match + $ds9 -scale match limits + $ds9 -scale lock yes + $ds9 -scale lock limits yes + $ds9 -scale open + $ds9 -scale close + + shm + Load a shared memory segment into the current frame. + Syntax: + -shm [<key> [<filename>]] +     [key <id> [<filename>]] +     [shmid <id> [<filename>]] +     [fits [key|shmid] <id> + [<filename>]] +     [mosaicimage [iraf|wcs|wcsa...wcsz|wfpc2] + [key|shmid] <id> [<filename>]] +     [mosaic [iraf|wcs|wcsa...wcsz] [key|shmid] + <id> [<filename>]] +     [rgbcube [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>]] + + Example: + $ds9 -shm 102 + $ds9 -shm key 102 + $ds9 -shm shmid 102 foo + $ds9 -shm fits 100 foo + $ds9 -shm mosaicimage iraf key 100 foo + $ds9 -shm mosaicimage wcs key 100 foo + $ds9 -shm mosaicimage wcsa key 100 foo + $ds9 -shm mosaicimage wfpc2 key 100 foo + $ds9 -shm mosaic iraf key 100 foo + $ds9 -shm mosaic wcs key 100 foo + $ds9 -shm rgbcube key 100 foo + $ds9 -shm rgbimage key 100 foo + $ds9 -shm rgbarray shmid 102 [dim=32,zdim=3,bitpix=-32] + $ds9 -shm array shmid 102 [dim=32,bitpix=-32] + + sia + + Support for VO Simple Image Access protocol. The first command + will create a new search. All other commands operated on the + last search created, unless indicated otherwise. + Syntax: -sia[2mass|akari|astrowise|cadc|cxc|hla|mast|sdss|skyview|tgssadr] -    [<ref>] [cancel] -    [<ref>] [clear] -    [<ref>] [close] -    [<ref>] [coordinate <ra> <dec> <coordsys>] -    [<ref>] [crosshair] -    [<ref>] [export sb|tsv <filename>] -    [<ref>] [name <object>] -    [<ref>] [print] -    [<ref>] [retrieve] -    [<ref>] [save <filename>] -    [<ref>] [radius <value> degrees|arcmin|arcsec] -    [<ref>] [sky <skyframe>] -    [<ref>] [skyformat <skyformat>] -    [<ref>] [system <coordsys>] -    [<ref>] [update] - -Example: -$ds9 -sia 2mass -$ds9 -sia cancel -$ds9 -sia clear -$ds9 -sia close -$ds9 -sia coordinate 202.48 47.21 fk5 -$ds9 -sia crosshair -$ds9 -sia export tsv bar.tsv -$ds9 -sia name m51 -$ds9 -sia print -$ds9 -sia retrieve -$ds9 -sia save foo.xml -$ds9 -sia radius 1 degrees -$ds9 -sia sky fk5 -$ds9 -sia skyformat degrees -$ds9 -sia system wcs -$ds9 -sia update - single -Set display mode to single. -Syntax: --single - -Example: -$ds9 -single -skyview -Support for SkyView image server at HEASARC. -Syntax: --skyview [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [pixels <width> <height>] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [survey <survey>] -    [open|close] - -Example: -$ds9 -skyview -$ds9 -skyview m31 -$ds9 -skyview name m31 -$ds9 -skyview name clear -$ds9 -skyview 00:42:44.404 +41:16:08.78 -$ds9 -skyview size 60 60 arcmin -$ds9 -skyview pixels 600 600 -$ds9 -skyview save yes -$ds9 -skyview frame current -$ds9 -skyview update frame -$ds9 -skyview survey sdssi -$ds9 -skyview open -$ds9 -skyview close -sleep -Delays execution for specified number of seconds. Default is 1 second. -Syntax: --sleep [#] - -Example: -$ds9 -sleep -$ds9 -sleep 2 -slice -noslice -Indicates next files loaded are to treated as slices of a cube. Can be disabled with noslice command. -Syntax: --slice <filename> --noslice - -Example: -$ds9 -slice *.fits -$ds9 -noslice -smooth -Smooth current image or set smooth parameters. -Boxcar width =2*radius+1 -Tophat diameter =2*radius+1 -Gaussian diameter =2*radius+1,mean=0 -Elliptical Gaussian diameter =2*radius+1,mean=0 -Syntax: --smooth [] -    [yes|no] -    [function boxcar|tophat|gaussian|elliptic] -    [radius <value>] -    [radiusminor <value>] -    [sigma <value>] -    [sigmaminor <value>] -    [angle <value>] -    [match] -    [lock [yes|no]] -    [open|close] - -Example: -$ds9 -smooth -$ds9 -smooth yes -$ds9 -smooth function tophat -$ds9 -smooth radius 4 -$ds9 -smooth radiusminor 4 -$ds9 -smooth sigma 2.0 -$ds9 -smooth sigmaminor 2.0 -$ds9 -smooth angle 45 -$ds9 -smooth match -$ds9 -smooth lock yes -$ds9 -smooth open -$ds9 -smooth close -squared -Select squared scale function for the current frame. -Syntax: --squared - -Example: -$ds9 -squared -sqrt -Select square soot scale function for the current frame. -Syntax: --sqrt - -Example: -$ds9 -sqrt -source -Source TCL code from a file. -Syntax: --source <filename> - -Example: -$ds9 -source extensions.tcl -tcl -Execute one TCL command. Note: this a different behavior from previous versions of DS9. -Syntax: --tcl <tcl command> - -Example: -$ds9 -tcl 'puts "Hello, World"' -threads -Set number of process threads for functions which are multi-threaded. -Syntax: --threads # - -Example: -$ds9 -threads 8 - -tiff -Load TIFF image into current frame. -Syntax: --tiff <filename> - -Example: -$ds9 -tiff foo.tiff -$cat foo.fits | ds9 -tiff - -tile -Controls the tile display mode. -Syntax: --tile [] -    [yes|no] -    [mode grid|column|row] -    [grid] -    [grid mode automatic|manual] -    [grid direction x|y] -    [grid layout <col> <row>] -    [grid gap <pixels>] -    [row] -    [column] - -Example: -$ds9 -tile -$ds9 -tile yes -$ds9 -tile mode row -$ds9 -tile grid -$ds9 -tile grid mode manual -$ds9 -tile grid direction x -$ds9 -tile grid layout 5 5 -$ds9 -tile grid gap 10 -$ds9 -tile row -$ds9 -tile column -title -Changes the display window title to the specified name. -Syntax: --title name - -Example: -$ds9 -title Voyager -unix -Set the IRAF unix socket name, used by IRAF to communicate with DS9. The default is /tmp/.IMT%d, so that the standard IRAF unix socket is defined. -Syntax: --unix name - -Example: -$ds9 -unix "/tmp/.IMT%d" -unix_only -Only use the IRAF unix socket name. This is the same as -fifo none -port 0. -Syntax: --unix_only - -Example: -$ds9 -unix_only -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] - -Example: -$ds9 -update -$ds9 -update 1 100 100 300 400 -$ds9 -update now -$ds9 -update now 1 100 100 300 400 -url -Load FITS from URL into the current frame -Syntax: --url <url> - -Example: -$ds9 -url http://foo.bar.edu/foo.fits -version -Returns the current version of DS9 and exits. -Syntax: --version - -Example: -$ds9 -version -view -Controls the GUI and visible RGB frame color channels. -Syntax: --view [layout horizontal|vertical] -    [keyvalue <string>] -    [info yes|no] -    [panner yes|no] -    [magnifier yes|no] -    [buttons yes|no] -    [colorbar yes|no] -    [graph horizontal|vertical yes|no] -    [filename yes|no] -    [object yes|no] -    [keyword yes|no] -    [minmax yes|no] -    [lowhigh yes|no] -    [units yes|no] -    [image|physical|wcs|wcsa...wcsz yes|no] -    [frame yes|no] -    [red yes|no] -    [green yes|no] -    [blue yes|no] - -Example: -$ds9 -view layout vertical -$ds9 -view keyvalue BITPIX -$ds9 -view info yes -$ds9 -view panner yes -$ds9 -view magnifier yes -$ds9 -view buttons yes -$ds9 -view colorbar yes -$ds9 -view graph horizontal yes -$ds9 -view filename yes -$ds9 -view object yes -$ds9 -view keyword yes -$ds9 -view minmax yes -$ds9 -view lowhigh yes -$ds9 -view wcsa yes -$ds9 -view frame yes -$ds9 -view red yes -$ds9 -view green yes -$ds9 -view blue yes -visual -Force DS9 to use the specified color visual. This argument MUST be the first argument listed. Requires the visual be available. -Syntax: --visual [truecolor|truecolor8|truecolor16|truecolor24] -Example: -$ds9 -visual truecolor24 -vla -Support for VLA Sky Survey. -Syntax: --vla [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [survey first|stripe82] -    [open|close] - -Example: -$ds9 -vla -$ds9 -vla m31 -$ds9 -vla name m31 -$ds9 -vla name clear -$ds9 -vla 00:42:44.404 +41:16:08.78 -$ds9 -vla size 60 60 arcmin -$ds9 -vla save yes -$ds9 -vla frame current -$ds9 -vla update frame -$ds9 -vla survey stripe82 -$ds9 -vla open -$ds9 -vla close -vlss -Support for NRAO VLSS Sky Survey. -Syntax: --vlss [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [open|close] - -Example: -$ds9 -vlss -$ds9 -vlss m31 -$ds9 -vlss name m31 -$ds9 -vlss name clear -$ds9 -vlss 00:42:44.404 +41:16:08.78 -$ds9 -vlss size 60 60 arcmin -$ds9 -vlss save yes -$ds9 -vlss frame current -$ds9 -vlss update frame -$ds9 -vlss open -$ds9 -nvess close -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: -$ds9 -vo method xpa -$ds9 -vo server "http://foo.bar.edu/list.txt" -$ds9 -vo internal yes -$ds9 -vo delay 15 # keep-alive delay -$ds9 -vo chandra-ed -$ds9 -vo connect chandra-ed -$ds9 -vo disconnect chandra-ed -$ds9 -vo open -$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, a new WCS specification can be loaded and used by the current image regardless of the WCS that was contained in the image file. Please see WCS for more information. -Syntax: --wcs [[system] wcs|wcsa...wcsz] -    [[sky] fk4|fk5|icrs|galactic|ecliptic] -    [[skyformat] degrees|sexagesimal] -    [align yes|no] -    [reset [#]] -    [replace [#] <filename>] -    [append [#] <filename>] -    [open|close] - -Example: -$ds9 -wcs wcs -$ds9 -wcs system wcs -$ds9 -wcs fk5 -$ds9 -wcs sky fk5 -$ds9 -wcs sexagesimal -$ds9 -wcs skyformat sexagesimal -$ds9 -wcs align yes -$ds9 -wcs reset -$ds9 -wcs reset 3 -$ds9 -wcs replace foo.wcs -$ds9 -wcs replace 3 foo.wcs -$ds9 -wcs append foo.wcs -$ds9 -wcs append 3 foo.wcs -$ds9 -wcs open -$ds9 -wcs close -web -Display specified URL in the web display. -Syntax: --web [] -    [<url>] -    [new <webname> <url>] -    [<webname>] [click back|forward|stop|reload|#] -    [<webname>] [clear] -    [<webname>] [close] - -Example: -$ds9 -web www.cnn.com -$ds9 -web new www.cnn.com -$ds9 -web hvweb www.apple.com -$ds9 -web click back -$ds9 -web click 2 -$ds9 -web clear -$ds9 -web close -width -Set the width of the image display window. Use the geometry command to set the overall width and height of the ds9 window. -Syntax: --width [<value>] - -Example: -$ds9 -width 512 -xpa -Configure XPA. -Syntax: --xpa [yes|no] -    [inet|local|unix|localhost] -    [noxpans] -    [connect] -    [disconnect] -    [info] - -Example: -$ds9 -xpa no -$ds9 -xpa local -$ds9 -xpa noxpans -$ds9 -xpa connect -$ds9 -xpa disconnect -$ds9 -xpa info -zmax -Set Scale Limits based on the IRAF algorithm and maximum data value. -Syntax: --zmax - -Example: -$ds9 -zmax -zscale -Set Scale Limits based on the IRAF algorithm. -Syntax: --zscale [] -    [contrast] -    [sample] -    [line] - -Example: -$ds9 -zscale -$ds9 -zscale contrast .25 -$ds9 -zscale sample 600 -$ds9 -zscale line 120 -zoom -Controls the current zoom value for the current frame. -Syntax: --zoom [<value>] -    [<value> <value>] -    [to <value>] -    [to <value> <value>] -    [in] -    [out] -    [to fit] -    [open|close] - -Example: -$ds9 -zoom 2 -$ds9 -zoom 2 4 -$ds9 -zoom to 4 -$ds9 -zoom to 2 4 -$ds9 -zoom in -$ds9 -zoom out -$ds9 -zoom to fit -$ds9 -zoom open -$ds9 -zoom close - - +     [<ref>] [cancel] +     [<ref>] [clear] +     [<ref>] [close] +     [<ref>] [coordinate <ra> + <dec> <coordsys>] +     [<ref>] [crosshair] +     [<ref>] [export sb|tsv + <filename>] +     [<ref>] [name <object>] +     [<ref>] [print] +     [<ref>] [retrieve] +     [<ref>] [save <filename>] +     [<ref>] [radius <value> + degrees|arcmin|arcsec] +     [<ref>] [sky <skyframe>] +     [<ref>] [skyformat <skyformat>] +     [<ref>] [system <coordsys>] +     [<ref>] [update] + + Example: + $ds9 -sia 2mass + $ds9 -sia cancel + $ds9 -sia clear + $ds9 -sia close + $ds9 -sia coordinate 202.48 47.21 fk5 + $ds9 -sia crosshair + $ds9 -sia export tsv bar.tsv + $ds9 -sia name m51 + $ds9 -sia print + $ds9 -sia retrieve + $ds9 -sia save foo.xml + $ds9 -sia radius 1 degrees + $ds9 -sia sky fk5 + $ds9 -sia skyformat degrees + $ds9 -sia system wcs + $ds9 -sia update + + single +
Set display mode to single.
+ Syntax: + -single + + Example: + $ds9 -single + +
skyview
+
Support for SkyView image server at HEASARC.
+ Syntax: + -skyview [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [pixels <width> <height>] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [survey <survey>] +     [open|close] + + Example: + $ds9 -skyview + $ds9 -skyview m31 + $ds9 -skyview name m31 + $ds9 -skyview name clear + $ds9 -skyview 00:42:44.404 +41:16:08.78 + $ds9 -skyview size 60 60 arcmin + $ds9 -skyview pixels 600 600 + $ds9 -skyview save yes + $ds9 -skyview frame current + $ds9 -skyview update frame + $ds9 -skyview survey sdssi + $ds9 -skyview open + $ds9 -skyview close + +
sleep
+
Delays execution for specified number of seconds. Default is 1 + second.
+ Syntax: + -sleep [#] + + Example: + $ds9 -sleep + $ds9 -sleep 2 + +
slice
+ noslice
+
+
Indicates next files loaded are to treated as slices of a cube. + Can be disabled with noslice command.
+
+ Syntax: + -slice <filename> + -noslice + + Example: + $ds9 -slice *.fits + $ds9 -noslice + +
smooth
+
Smooth current image or set smooth parameters.
+
Boxcar width =2*radius+1 + Tophat diameter =2*radius+1 + Gaussian diameter =2*radius+1,mean=0 + Elliptical Gaussian diameter =2*radius+1,mean=0 +
+ Syntax: + -smooth [] +     [yes|no] +     [function boxcar|tophat|gaussian|elliptic] +     [radius <value>] +     [radiusminor <value>] +     [sigma <value>] +     [sigmaminor <value>] +     [angle <value>] +     [match] +     [lock [yes|no]] +     [open|close] + + Example: + $ds9 -smooth + $ds9 -smooth yes + $ds9 -smooth function tophat + $ds9 -smooth radius 4 + $ds9 -smooth radiusminor 4 + $ds9 -smooth sigma 2.0 + $ds9 -smooth sigmaminor 2.0 + $ds9 -smooth angle 45 + $ds9 -smooth match + $ds9 -smooth lock yes + $ds9 -smooth open + $ds9 -smooth close + +
squared
+
Select squared scale function for the current frame.
+ Syntax: + -squared + + Example: + $ds9 -squared +
sqrt
+
Select square soot scale function for the current frame.
+ Syntax: + -sqrt + + Example: + $ds9 -sqrt +
source
+
Source TCL code from a file.
+ Syntax: + -source <filename> + + Example: + $ds9 -source extensions.tcl + +
tcl
+
Execute one TCL command. Note: this a different behavior from + previous versions of DS9.
+
+ Syntax: + -tcl <tcl command> + + Example: + $ds9 -tcl 'puts "Hello, World"'
+
threads
+
Set number of process threads for functions which are + multi-threaded.
+ Syntax: + -threads # + + Example: + $ds9 -threads 8
+
+ tiff
+
Load TIFF image into current frame.
+
+ Syntax: + -tiff <filename> + + Example: + $ds9 -tiff foo.tiff + $cat foo.fits | ds9 -tiff - +
tile
+
Controls the tile display mode.
+ Syntax: + -tile [] +     [yes|no] +     [mode grid|column|row] +     [grid] +     [grid mode automatic|manual] +     [grid direction x|y] +     [grid layout <col> <row>] +     [grid gap <pixels>] +     [row] +     [column] + + Example: + $ds9 -tile + $ds9 -tile yes + $ds9 -tile mode row + $ds9 -tile grid + $ds9 -tile grid mode manual + $ds9 -tile grid direction x + $ds9 -tile grid layout 5 5 + $ds9 -tile grid gap 10 + $ds9 -tile row + $ds9 -tile column +
title
+
Changes the display window title to the specified name.
+ Syntax: + -title name + + Example: + $ds9 -title Voyager +
unix
+
Set the IRAF unix socket name, used by IRAF to communicate with + DS9. The default is /tmp/.IMT%d, so that the standard IRAF unix + socket is defined.
+ Syntax: + -unix name + + Example: + $ds9 -unix "/tmp/.IMT%d" +
unix_only
+
Only use the IRAF unix socket name. This is the same as -fifo + none -port 0.
+ Syntax: + -unix_only + + Example: + $ds9 -unix_only + +
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] + + Example: + $ds9 -update + $ds9 -update 1 100 100 300 400 + $ds9 -update now + $ds9 -update now 1 100 100 300 400
+
url
+
Load FITS from URL into the current frame
+ Syntax: + -url <url> + + Example: + $ds9 -url http://foo.bar.edu/foo.fits +
version
+
Returns the current version of DS9 and exits.
+ Syntax: + -version + + Example: + $ds9 -version +
view
+
Controls the GUI and visible RGB frame color channels.
+ Syntax: + -view [layout horizontal|vertical] +     [keyvalue <string>] +     [info yes|no] +     [panner yes|no] +     [magnifier yes|no] +     [buttons yes|no] +     [colorbar yes|no] +     [graph horizontal|vertical yes|no] +     [filename yes|no] +     [object yes|no] +     [keyword yes|no] +     [minmax yes|no] +     [lowhigh yes|no] +     [units yes|no] +     [image|physical|wcs|wcsa...wcsz yes|no] +     [frame yes|no] +     [red yes|no] +     [green yes|no] +     [blue yes|no] + + Example: + $ds9 -view layout vertical + $ds9 -view keyvalue BITPIX + $ds9 -view info yes + $ds9 -view panner yes + $ds9 -view magnifier yes + $ds9 -view buttons yes + $ds9 -view colorbar yes + $ds9 -view graph horizontal yes + $ds9 -view filename yes + $ds9 -view object yes + $ds9 -view keyword yes + $ds9 -view minmax yes + $ds9 -view lowhigh yes + $ds9 -view wcsa yes + $ds9 -view frame yes + $ds9 -view red yes + $ds9 -view green yes + $ds9 -view blue yes + +
visual
+
Force DS9 to use the specified color visual. This argument MUST + be the first argument listed. Requires the visual be available.
+ Syntax: + -visual [truecolor|truecolor8|truecolor16|truecolor24] + Example: + $ds9 -visual truecolor24 + +
vla
+
Support for VLA Sky Survey.
+ Syntax: + -vla [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [survey first|stripe82] +     [open|close] + + Example: + $ds9 -vla + $ds9 -vla m31 + $ds9 -vla name m31 + $ds9 -vla name clear + $ds9 -vla 00:42:44.404 +41:16:08.78 + $ds9 -vla size 60 60 arcmin + $ds9 -vla save yes + $ds9 -vla frame current + $ds9 -vla update frame + $ds9 -vla survey stripe82 + $ds9 -vla open + $ds9 -vla close
+
vlss
+
Support for NRAO VLSS Sky Survey.
+ Syntax: + -vlss [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [open|close] + + Example: + $ds9 -vlss + $ds9 -vlss m31 + $ds9 -vlss name m31 + $ds9 -vlss name clear + $ds9 -vlss 00:42:44.404 +41:16:08.78 + $ds9 -vlss size 60 60 arcmin + $ds9 -vlss save yes + $ds9 -vlss frame current + $ds9 -vlss update frame + $ds9 -vlss open + $ds9 -nvess close +
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: + $ds9 -vo method xpa + $ds9 -vo server "http://foo.bar.edu/list.txt" + $ds9 -vo internal yes + $ds9 -vo delay 15 # keep-alive delay + $ds9 -vo chandra-ed + $ds9 -vo connect chandra-ed + $ds9 -vo disconnect chandra-ed + $ds9 -vo open + $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, a new WCS specification can be loaded and + used by the current image regardless of the WCS that was + contained in the image file. Please see WCS + for more information.
+ Syntax: + -wcs [[system] wcs|wcsa...wcsz] +     [[sky] fk4|fk5|icrs|galactic|ecliptic] +     [[skyformat] degrees|sexagesimal] +     [align yes|no] +     [reset [#]] +     [replace [#] <filename>] +     [append [#] <filename>] +     [open|close] + + Example: + $ds9 -wcs wcs + $ds9 -wcs system wcs + $ds9 -wcs fk5 + $ds9 -wcs sky fk5 + $ds9 -wcs sexagesimal + $ds9 -wcs skyformat sexagesimal + $ds9 -wcs align yes + $ds9 -wcs reset + $ds9 -wcs reset 3 + $ds9 -wcs replace foo.wcs + $ds9 -wcs replace 3 foo.wcs + $ds9 -wcs append foo.wcs + $ds9 -wcs append 3 foo.wcs + $ds9 -wcs open + $ds9 -wcs close + +
web
+
Display specified URL in the web display.
+ Syntax: + -web [] +     [<url>] +     [new <webname> <url>] +     [<webname>] [click + back|forward|stop|reload|#] +     [<webname>] [clear] +     [<webname>] [close] + + Example: + $ds9 -web www.cnn.com + $ds9 -web new www.cnn.com + $ds9 -web hvweb www.apple.com + $ds9 -web click back + $ds9 -web click 2 + $ds9 -web clear + $ds9 -web close + +
width
+
Set the width of the image display window. Use the geometry command to set the + overall width and height of the ds9 window.
+ Syntax: + -width [<value>] + + Example: + $ds9 -width 512 + +
xpa
+
Configure XPA.
+ Syntax: + -xpa [yes|no] +     [inet|local|unix|localhost] +     [noxpans] +     [connect] +     [disconnect] +     [info] + + Example: + $ds9 -xpa no + $ds9 -xpa local + $ds9 -xpa noxpans + $ds9 -xpa connect + $ds9 -xpa disconnect + $ds9 -xpa info + +
zmax
+
Set Scale Limits based on the IRAF algorithm and + maximum data value.
+ Syntax: + -zmax + + Example: + $ds9 -zmax +
zscale
+
Set Scale Limits based on the IRAF algorithm.
+ Syntax: + -zscale [] +     [contrast] +     [sample] +     [line] + + Example: + $ds9 -zscale + $ds9 -zscale contrast .25 + $ds9 -zscale sample 600 + $ds9 -zscale line 120 + +
zoom
+
Controls the current zoom value for the current frame.
+ Syntax: + -zoom [<value>] +     [<value> <value>] +     [to <value>] +     [to <value> <value>] +     [in] +     [out] +     [to fit] +     [open|close] + + Example: + $ds9 -zoom 2 + $ds9 -zoom 2 4 + $ds9 -zoom to 4 + $ds9 -zoom to 2 4 + $ds9 -zoom in + $ds9 -zoom out + $ds9 -zoom to fit + $ds9 -zoom open + $ds9 -zoom close + +

+ diff --git a/ds9/doc/ref/samp.html b/ds9/doc/ref/samp.html index 4ef98a8..df5da61 100644 --- a/ds9/doc/ref/samp.html +++ b/ds9/doc/ref/samp.html @@ -1,2960 +1,3251 @@ - - - - -SAMP - - -

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 -3d -about -analysis -array -background -backup -bin -blink -block -catalog -cd -cmap -colorbar -console -contour -crop -crosshair -cube -cursor -data -dsssao -dsseso -dssstsci -envi -exit -export -file -fits -frame -gif -grid -header -height -iconify -iexam -iis -jpeg -lock -lower -magnifier -mask -match -mecube -minmax -mode -mosaic -mosaicimage -movie -multiframe -nameserver -nan -nrrd -nvss -orient -pagesetup -pan -pixeltable -plot -png -precision -prefs -preserve -psprint -print -quit -raise -regions -restore -rgb -rgbarray -rgbcube -rgbimage -rotate -samp -save -saveimage -scale -shm -sia -single -skyview -sleep -smooth -source -tcl -threads -tiff -tile -update -url -version -view -vla -vlss -vo -wcs -web -width -zscale -zoom -
2mass
-
Support for 2MASS Digital Sky Survey.
-Syntax: -2mass [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # 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: -string value = ds9.get(string cmd) -2mass name -2mass coord -2mass size -2mass save -2mass frame -2mass survey - -ds9.set(string cmd) -2mass -2mass m31 -2mass name m31 -2mass name clear -2mass 00:42:44.404 +41:16:08.78 -2mass size 60 60 arcmin -2mass save yes -2mass frame current -2mass update frame -2mass survey j -2mass open -2mass close -
3d
-
Support for 3D frame.
-Syntax: -3d [] -   [view <az> <el>] -   [az <az>] -   [el <el>] -   [scale <scale>] -   [method mip|aip] -   [background none|azimuth|elevation] -   [border yes|no] -   [border color <color>] -   [highlite yes|no] -   [hightlite color <color>] -   [compass yes|no] -   [compass color <color>] -   [match] -   [lock [yes|no]] -   [open|close] - -Example: -string value = ds9.get(string cmd) -3d view -3d az -3d el -3d scale -3d method -3d background -3d border -3d border color -3d highlite -3d highlite color -3d compass -3d compass color -3d lock - -ds9.set(string cmd) -3d # create new 3D frame -3d view 45 30 -3d az 45 -3d el 30 -3d scale 10 -3d method mip -3d background azimuth -3d border yes -3d border color red -3d highlite yes -3d highlite color red -3d compass yes -3d compass color red -3d match -3d lock yes -3d open -3d close -
about
-
Get DS9 credits.
-Syntax: -about - -Example: -string value = ds9.get(string cmd) -about -
align
-
Controls the World Coordinate System alignment for the current frame.
-Syntax: -align [] -    [yes|no] - -Example: -string value = ds9.get(string cmd) -align - -ds9.set(string cmd) -align yes
-
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: -string value = ds9.get(string cmd) -analysis -analysis task -analysis entry {Please enter something} -analysis entry okcancel {Hello World} - -ds9.set(string cmd) -analysis 0 # invoke first analysis task -analysis task 0 -analysis task foobar -analysis task {foo bar} -analysis my.ans -analysis load my.ans -analysis clear -analysis clear load my.ans -analysis message {This is a message} -analysis text {this is text} - -ds9.set(string cmd, string url) -analysis load -analysis text
-
array
-
Load raw data array into current frame.
-Syntax: -array [native|little|big] -array [new|mask] [[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,endian=[little|big]] - -Example: -string url = ds9.get(string cmd) -array -array little - -ds9.set(string command, string url) -array foo.arr[dim=512,bitpix=-32,endian=little] -array new foo.arr[dim=512,bitpix=-32,endian=little] -array mask foo.arr[dim=512,bitpix=-32,endian=little] -
bg
-background
-
Set image background color.
-Syntax: -bg <color> - -Example: -string url = ds9.get(string cmd) -bg - -ds9.set(string cmd) -bg red
-
backup
-
Create a backup save set.
-Syntax: -backup <filename> - -Example: -ds9.set(string cmd) -backup ds9.bck
-
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>] -    [filter clear] -    [function average|sum] -    [in] -    [out] -    [to fit] -    [match] -    [lock [yes|no]] -    [open|close] - -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 -bin lock - -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 clear -bin function sum -bin in -bin out -bin to fit -bin match -bin lock yes -bin open -bin close -
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
-
block
-
Controls blocking parameters.
-Syntax: -block[<value>] -    [<value> <value>] -    [to <value>] -    [to <value> <value>] -    [in] -    [out] -    [to fit] -    [match] -    [lock [yes|no]] -    [open|close] - -Example: -string value = ds9.get(string cmd) -block -block lock - -ds9.set(string cmd) -block4 -block4 2 -blockto 4 -blockto 4 2 -blockin -blockout -blockto fit -blockmatch -blocklock yes -blockopen -blockclose -
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 [new] -    [ned|simbad|denis|skybot] -    [aavso|ac|ascss|cmc|gaia|gsc1|gsc2|gsc3|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|sdss9|tycho] -    [ua2|ub1|ucac2|ucac2sup|ucac3|ucac4|urat1] -    [2mass|iras] -    [csc|xmm|rosat] -    [first|nvss] -    [chandralog|cfhtlog|esolog|stlog|xmmlog] -    [cds <catalogname>] -    [cds <catalogid>] - -    [load <filename>] -    [import sb|tsv <filename>] - -    [<ref>] [<ra> <dec> <coordsys>] -    [<ref>] [allcols] -    [<ref>] [allrows] -    [<ref>] [cancel] -    [<ref>] [clear] -    [<ref>] [close] -    [<ref>] [crosshair] -    [<ref>] [dec <col>] -    [<ref>] [edit yes|no] -    [<ref>] [export sb|tsv <filename>] -    [<ref>] [filter <string>] -    [<ref>] [filter load <filename>] -    [<ref>] [header] -    [<ref>] [location <code>] -    [<ref>] [match] -    [<ref>] [match <ref> <ref>] -    [<ref>] [match error <value> degrees|arcmin|arcsec] -    [<ref>] [match function 1and2|1not2|2not1] -    [<ref>] [match return 1and2|1only|2only] -    [<ref>] [match unique yes|no] -    [<ref>] [maxrows <number>] -    [<ref>] [name <object>] -    [<ref>] [panto yes|no] -    [<ref>] [plot <xcol> <ycol> <xerrcol> <yerrcol>] -    [<ref>] [print] -    [<ref>] [psky <skyframe>] -    [<ref>] [psystem <coordsys>] -    [<ref>] [ra <col>] -    [<ref>] [regions] -    [<ref>] [retrieve] -    [<ref>] [samp] -    [<ref>] [samp broadcast] -    [<ref>] [samp send <application>] -    [<ref>] [save <filename>] -    [<ref>] [servercds|adac|cadc|cambridge|sao|ukirt|iucaa|bejing|saao] -    [<ref>] [show yes|no] -    [<ref>] [radius <value> degrees|arcmin|arcsec] -    [<ref>] [sky <skyframe>] -    [<ref>] [skyformat <skyformat>] -    [<ref>] [sort <col> incr|decr] -    [<ref>] [symbol [#] condition|shape|color|text|font|fontsize|fontweight|fontslant <value>] -    [<ref>] [symbol [#] text|size|size2|units|angle <value>] -    [<ref>] [symbol shape circle|ellipse|box|text|point] -    [<ref>] [symbol shapecircle point|box point|diamond point|cross point|x point|arrow point|boxcircle point] -    [<ref>] [symbol add| [#] remove] -    [<ref>] [symbol save|load <filename>] -    [<ref>] [system <coordsys>] -    [<ref>] [update] -    [<ref>] [x <col>] -    [<ref>] [y <col>] - -Example: -string value = ds9.get(string cmd) -catalog -catalog header - -ds9.set(string cmd) -catalog new -catalog 2mass -catalog cds 2mass -catalog cds{I/252} - -catalog load foo.xml -catalog import tsv foo.tsv - -catalog coordinate 202.48 47.21 fk5 -catalog allrows -catalog allcols -catalog cancel -catalog clear -catalog close -catalog crosshair -catalog dec DEC -catalog edit yes -catalog export tsv bar.tsv -catalog filter {$Jmag>10} -catalog filter load foo.flt -catalog header -catalog location 500 -catalog match error 2 arcsec -catalog match function 1and2 -catalog match unique no -catalog match return 1only -catalog match # last two catalogs loaded -catalog match 2mass csc -catalog maxrows 2000 -catalog name m51 -catalog panto no -catalog plot{$Jmag} {$Hmag} {$e_Jmag} {$e_Hmag} -catalog print -catalog psky fk5 -catalog psystem wcs -catalog ra RA -catalog regions -catalog retrieve -catalog samp broadcast -catalog samp send aladin -catalog save foo.xml -catalog server sao -catalog show yes -catalog radius 1 degrees -catalog symbol condition{$Jmag>15} -catalog symbol 2 shape{boxcircle point} -catalog symbol color red -catalog symbol font times -catalog symbol fontsize 14 -catalog symbol fontweight bold -catalog symbol fontslant italic -catalog symbol add -catalog symbol 2 remove -catalog symbol load foo.sym -catalog symbol save bar.sym -catalog sky fk5 -catalog skyformat degrees -catalog sort {Jmag} incr -catalog system wcs -catalog update -catalog x RA -catalog y DEC -
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] -    [load <filename>] -    [save <filename>] -    [invert yes|no] -    [<constrast> <bias>] -    [tag [load|save] <filename>] -    [tag delete] -    [open|close] - -Example: -string value = ds9.get(string cmd) -cmap -cmap file -cmap invert -cmap value - -ds9.set(string cmd) -cmap Heat -cmap load foo.sao -cmap save bar.sao -cmap invert yes -cmap 5 .5 -cmap tag load foo.tag -cmap tag save foo.tag -cmap tag delete -cmap open -cmap close -
colorbar
-
Controls colorbar parameters.
-Syntax: -colorbar [] -    [yes|no] -    [orientation] -    [horizontal|vertical] -    [numerics yes|no] -    [space value|distance] -    [font times|helvetica|courier] -    [fontsize <value>] -    [fontweight normal|bold] -    [fontslant roman|italic] -    [size] -    [ticks] -    [match] -    [lock [yes|no]] - -Example: -string value = ds9.get(string cmd) -colorbar -colorbar orientation -colorbar numerics -colorbar space -colorbar font -colorbar fontsize -colorbar fontweight -colorbar fontslant -colorbar size -colorbar ticks -colorbar lock - -ds9.set(string cmd) -colorbar yes -colorbar vertical -colorbar numerics yes -colorbar space value -colorbar font times -colorbar fontsize 14 -colorbar fontwieght bold -colorbar fontslant italic -colorbar size 20 -colorbar ticks 11 -colorbar match -colorbar lock yes
-
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>] -    [save <filename> [<coordsys> <skyframe>]] -    [convert] -    [load levels <filename>] -    [save levels <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|asinh|sinh|histequ] -    [scale log exp <value>] -    [mode minmax|<value>|zscale|zmax] -    [scope global|local] -    [limits <min> <max>] -    [levels <value value value...>] -    [open|close] - -Example: -string value = ds9.get(string cmd) -contour -contour wcs fk5 -contour color -contour width -contour dash -contour smooth -contour method -contour nlevels -contour scale -contour log exp -contour mode -contour scope -contour limits -contour levels - -ds9.set(string cmd) -contour -contour yes -contour clear -contour generate -contour load ds9.ctr -contour save ds9.con -contour save ds9.con wcs fk5 -contour convert -contour load levels ds9.ctr -contour save levels ds9.lev -contour copy -contour paste -contour paste wcs 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 log exp 1000 -contour mode zscale -contour scope local -contour limits 1 100 -contour levels 1 10 100 1000 -contour open -contour close -
crop
-
Set current image display area.
-Syntax: -crop [<x> <y> <width> <height> [<coordsys>][<skyframe>][degrees|arcmin|arcsec] -    [match <coordsys>] -    [lock <coordsys>|none] -    [reset] -    [3dzmin zmax <coordsys>] -    [open|close] - -Example: -string value = ds9.get(string cmd) -crop # get crop in physical coords -crop wcs galactic sexagesimal arcsec -crop lock - -ds9.set(string cmd) -crop 40 30 10 20 # set crop in physical coords -crop +104:51:06.915 +68:33:40.761 28.144405 22.000204 wcs galactic arcsec -crop match wcs -crop lock wcs -crop reset -crop 3d .25 .5 wcs -crop open -crop 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>]] -    [match <coordsys>] -    [lock <coordsys>|none] - -Example: -string value = ds9.get(string cmd) -crosshair # get crosshair in physical coords -crosshair wcs fk4 sexagesimal # get crosshair in wcs coords -crosshair lock - -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 -crosshair match wcs -crosshair lock wcs -
cube
-
Controls FITS cube.
-Syntax: -cube [] -    [play|stop|next|prev|first|last] -    [<slice> [<coordsys>]] -    [interval <numeric>] -    [match <coordsys>] -    [lock <coordsys>|none] -    [order 123|132|213|231|312|321] -    [axes lock [yes|no]] -    [open|close] - -Example: -string value = ds9.get(string cmd) -cube -cube wcs -cube interval -cube lock -cube order -cube axes lock - -ds9.set(string cmd) -cube -cube play -cube last -cube 3 -cube 4.4 wcs -cube interval 2 -cube match wcs -cube lock wcs -cube order 123 -cube axes lock yes -cube open -cube close
-
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 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> <width> <height> [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 -
dsssao
-dss
-
Support for Digital Sky Survey at SAO.
-Syntax: -dsssao [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [open|close] - -Example: -string value = ds9.get(string cmd) -dsssao name -dsssao coord -dsssao size -dsssao save -dsssao frame - -ds9.set(string cmd) -dsssao -dsssao m31 -dsssao name m31 -dsssao name clear -dsssao 00:42:44.404 +41:16:08.78 -dsssao size 60 60 arcmin -dsssao save yes -dsssao frame current -dsssao update frame -dsssao open -dsssao close -
dsseso
-
Support for Digital Sky Survey at ESO.
-Syntax: -dsseso [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # 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: -string value = ds9.get(string cmd) -dsseso name -dsseso coord -dsseso size -dsseso save -dsseso frame -dsseso survey - -ds9.set(string cmd) -dsseso -dsseso m31 -dsseso name m31 -dsseso name clear -dsseso 00:42:44.404 +41:16:08.78 -dsseso size 60 60 arcmin -dsseso save yes -dsseso frame current -dsseso update frame -dsseso survey DSS2-red -dsseso open -dsseso close -
dssstsci
-
Support for Digital Sky Survey at STSCI.
-Syntax: -dssstsci [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # 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: -string value = ds9.get(string cmd) -dssstsci name -dssstsci coord -dssstsci size -dssstsci save -dssstsci frame -dssstsci survey - -ds9.set(string cmd) -dssstsci -dssstsci m31 -dssstsci name m31 -dssstsci name clear -dssstsci 00:42:44.404 +41:16:08.78 -dssstsci size 60 60 arcmin -dssstsci save yes -dssstsci frame current -dssstsci update frame -dssstsci survey all -dssstsci open -dssstsci close
-
envi
-
Load an ENVI header and file. Optional parameter: array endian.
-Syntax: envi [new] <header> [<filename>] Example: ds9.set(string cmd) envi foo.hdr envi new foo.hdr envi foo.hdr foo.bsq
-
-exit
-
quit
-
Quits DS9.
-Syntax: -exit -quit - -Example: -ds9.set(string cmd) -exit
-
export
-
Export loaded image data of current frame in specified image format. Optional parameters: array endian, nrrd endian, jpeg quality (1-100) and tiff compression method.
-Syntax: -export[array|nrrd|envi|gif|tiff|jpeg|png]<filename> -export array <filename>[big|little|native] -export nrrd <filename>[big|little|native] -export envi <header> [<filename>][big|little|native] -export jpeg <filename>[1-100] -export tiff <filename>[none|jpeg|packbits|deflate] - -Example: - -ds9.set (string cmd) -export array foo.arr little -export nrrd foo.nrrd little -export envi foo.hdr little -export envi foo.hdr foo.bsq little -export tiff foo.tiff jpeg -export jpeg foo.jpeg 75 -export png foo.png
-
file
-
Query currently loaded file information.
-Syntax: -file - -Example: -string value = ds9.get(string cmd) -file -
fits
-
Load a FITS image into the current frame or query the currently loaded image.
-Syntax: -fits[new|mask|slice] [<filename>] -    [width|height|depth|bitpix|type] -    [size [wcs|wcsa...wcsz] [fk4|fk5|icrs|galactic|ecliptic] [degrees|arcmin|arcsecs]] -    [header [<ext>] [keyword <string>]] -    [image|table|slice] - -Example: -string value = ds9.get(string cmd) -fits -fits width -fits height -fits depth -fits bitpix -fits size -fits size wcs fk5 arcmin -fits header # primary -fits header 2 # hdu 2 -fits header -2 # hdu 2 with inherit -fits header keyword BITPIX -fits header 1 keyword BITPIX -fits image -fits table -fits slice - -ds9.set(string cmd, string url) -fits foo.fits -fits new foo.fits -fits bar.fits[bin=detx,dety] -fits slice foo.fits -fits mask foo.fits - 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|3d]] -    [delete [#|all]] -    [reset [#|all]] -    [refresh [#|all]] -    [hide [#|all]] -    [show [#|all]] -    [move first] -    [move back] -    [move forward] -    [move last] -    [first] -    [prev] -    [next] -    [last] -    [frameno #] -    [#] -    [match <coordsys>] -    [lock <coordsys>|none] -    [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>]] -    [has wcs celestial [<wcssys>]] -    [has wcs linear [<wcssys>]] - -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 -frame lock -frame has amplifier -frame has datamin -frame has datasec -frame has detector -frame has grid -frame has iis -frame has irafmin -frame has physical -frame has smooth -frame has contour -frame has contour aux -frame has fits -frame has fits bin -frame has fits cube -frame has fits mosaic -frame has marker highlite -frame has marker paste -frame has marker select -frame has marker undo -frame has system physical -frame has wcs wcsa -frame has wcs celestial wcsa -frame has wcs linear wcsa - -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 -frame match wcs -frame lock wcs
-
gif
-
Load GIF image into current frame.
-Syntax: -gif [new|slice] [<filename>] - -Example: -string value = ds9.get(string cmd) -gif - -ds9.set(string cmd) -gif foo.gif -gif new foo.gif -gif slice foo.gif -
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 dash yes|no] -    [grid gap1 <value>] -    [grid gap2 <value>] -    [grid gap3 <value>] -    [axes yes|no] -    [axes color <color>] -    [axes width <value>] -    [axes dash yes|no] -    [axes type interior|exterior] -    [axes origin lll|llu|lul|luu|ull|ulu|uul|uuu] -    [format1 <format>] -    [format2 <format>] -    [tickmarks yes|no] -    [tickmarks color <color>] -    [tickmarks width <value>] -    [tickmarks dash yes|no] -    [border yes|no] -    [border color <color>] -    [border width <value>] -    [border dash yes|no] -    [numerics yes|no] -    [numerics font times|helvetica|courier] -    [numerics fontsize <value>] -    [numerics fontweight normal|bold] -    [numerics fontslant roman|italic] -    [numerics color <color>] -    [numerics gap1 <value>] -    [numerics gap2 <value>] -    [numerics gap3 <value>] -    [numerics type interior|exterior] -    [numerics 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>] -    [labels yes|no] -    [labels text1 <text>] -    [labels text2 <text>] -    [labels def1 yes|no] -    [labels def2 yes|no] -    [labels gap1 <value>] -    [labels gap2 <value>] -    [labels font times|helvetica|courier] -    [labels fontsize <value>] -    [labels fontweight normal|bold] -    [labels fontslant roman|italic] -    [labels color <color>] -    [reset] -    [load <filename>] -    [save <filename>] -    [open|close] - -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 dash -grid grid gap1 -grid grid gap2 -grid grid gap3 -grid axes -grid axes color -grid axes width -grid axes dash -grid axes type -grid axes origin -grid format1 -grid format2 -grid tickmarks -grid tickmarks color -grid tickmarks width -grid tickmarks dash -grid border -grid border color -grid border width -grid border dash -grid numerics -grid numerics font -grid numerics fontsize -grid numerics fontweight -grid numerics fontslant -grid numerics color -grid numerics gap1 -grid numerics gap2 -grid numerics gap3 -grid numerics type -grid numerics vertical -grid title -grid title text -grid title def -grid title gap -grid title font -grid title fontsize -grid title fontweight -grid title fontslant -grid title color -grid labels -grid labels text1 -grid labels text2 -grid labels def1 -grid labels def2 -grid labels gap1 -grid labels gap2 -grid labels font -grid labels fontsize -grid labels fontweight -grid labels fontslant -grid labels 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 dash yes -grid grid gap1 10 -grid grid gap2 10 -grid grid gap3 10 -grid axes yes -grid axes color red -grid axes width 2 -grid axes dash yes -grid axes type exterior -grid axes origin lll -grid format1 d.2 -grid format2 d.2 -grid tickmarks yes -grid tickmarks color red -grid tickmarks width 2 -grid tickmarks dash yes -grid border yes -grid border color red -grid border width 2 -grid border dash yes -grid numerics yes -grid numerics font courier -grid numerics fontsize 12 -grid numerics fontweight bold -grid numerics fontslant italic -grid numerics color red -grid numerics gap1 10 -grid numerics gap2 10 -grid numerics gap3 10 -grid numerics type exterior -grid numerics vertical yes -grid title yes -grid title text {Hello World} -grid title def yes -grid title gap 10 -grid title fontsize 12 -grid title font courier -grid title fontweight bold -grid title fontslant italic -grid title color red -grid labels yes -grid labels text1 {Hello World} -grid labels text2 {Hello World} -grid labels def1 yes -grid labels def2 yes -grid labels gap1 10 -grid labels gap2 10 -grid labels font courier -grid labels fontsize 12 -grid labels fontweight bold -grid labels fontslant italic -grid labels color red -grid reset -grid load foo.grd -grid save foo.grd -grid open -grid close -
header
-
Display current fits header dialog. Optional extension number maybe specified. Please note, this differs from samp fits header.
-Syntax: -header [<ext>] -    [close [<ext>]] -    [save [<ext>] <filename>] - -Example: -string value = ds9.get(string cmd) -header -header 2 -header close -
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
-
iexam
-
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. The default event is button. In the last form, the following macros will be expanded if present: $width, $height, $depth, $bitpix, $filename, $regions, $filename[$regions], $env, $pan, $value, $x, $y, $z. See Analysis Macros for more information.
-Syntax: -iexam [] -    [[]|button|key|any] coordinate <coordsys> [<skyframe>] [<skyformat>] -    [[]|button|key|any] data [width][height] -    [[]|button|key|any] <macro string>] - -Example: -string value = ds9.get(string cmd) -iexam -iexam coordinate image -iexam key coordinate image # return coordinate and key event -iexam coordinate wcs fk5 degrees -iexam coordinate wcs galactic sexagesimal -iexam coordinate fk5 -iexam data # return data value -iexam key data # return data value and key event -iexam data 3 3 # return all data in 3x3 box about selected point -iexam {'Click at $x,$y in file $filename'} -
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
-
jpeg
-
Load JPEG image into current frame. Optional parameters: jpeg quality (1-100)
-Syntax: -jpeg [new|slice] [<filename>] [1-100] - -Example: -string value = ds9.get(string cmd) -jpeg - -ds9.set(string cmd) -jpeg foo.jpeg -jpeg new foo.jpeg -jpeg slice foo.jpeg -
lock
-
Lock all other frames to the current frame.
-Syntax: -lock[frame <coordsys>|none] -    [crosshair <coordsys>|none] -    [crop <coordsys>|none] -    [slice <coordsys>|none] -    [bin [yes|no]] -    [axes [yes|no]] -    [scale [yes|no]] -    [scalelimits [yes|no]] -    [colorbar [yes|no]] -    [block [yes|no]] -    [smooth [yes|no]] -    [3d [yes|no]] - -Example: -string value = ds9.get(string cmd) -lock frame -lock crosshair -lock crop -lock slice -lock bin -lock axes -lock scale -lock scalelimits -lock colorbar -lock block -lock smooth -lock 3d - -ds9.set(string cmd) -lock frame wcs -lock crosshair wcs -lock crop wcs -lock slice wcs -lock bin yes -lock axes yes -lock scale yes -lock scalelimits yes -lock colorbar yes -lock block yes -lock smooth yes -lock 3d yes - lower -
Lower in the window stacking order.
-Syntax: -lower - -Example: -ds9.set(string cmd) -lower -
magnifier
-
Controls the magnifier settings.
-Syntax: -magnifier [color <color>] -    [zoom <value>] -    [cursor yes|no] -    [region yes|no] - -Example: -string value = ds9.get(string cmd) -magnifier color -magnifier zoom -magnifier cursor -magnifier region - -ds9.set(string cmd) -magnifier color yellow -magnifier zoom 2 -magnifier cursor no -magnifier region no -
mask
-
Controls mask parameters.
-Syntax: -mask [color <color>] -    [mark zero|nonzero|nan|nonnan|range] -    [range <low> <high>] -    [transparency <value>] -    [system <coordsys>] -    [clear] -    [open|close] - -Example: -string value = ds9.get(string cmd) -mask color -mask mark -mask range -mask system -mask transparency - -ds9.set(string cmd) -mask color red -mask mark zero -mask range 10 100 -mask transparency 50 -mask system wcs -mask clear -mask open -mask close -
match
-
Match all other frames to the current frame.
-Syntax: -match[frame <coordsys>] -    [crosshair <coordsys>] -    [crop <coordsys>] -    [slice <coordsys>] -    [bin] -    [axes] -    [scale] -    [scalelimits] -    [colorbar] -    [block] -    [smooth] -    [3d] - -Example: -ds9.set(string cmd) -match frame wcs -match crosshair wcs -match crop wcs -match slice wcs -match bin -match axes -match scale -match scalelimits -match colorbar -match block -match smooth -match 3d -
mecube
-
Load FITS multiple extension file as data cube.
-Syntax: -mecube [new] [<filename>] - -Example: -string value = ds9.get(string cmd) -mecube - -ds9.set(string cmd) -mecube foo.fits -mecube new foo.fits -
minmax
-
This is how DS9 determines the min and max data values from the data. SCAN will scan all data.
-Syntax: -minmax [scan|sample|datamin|irafmin] -    [mode scan|sample|datamin|irafmin] -    [interval #] - -Example: -string value = ds9.get(string cmd) -minmax mode -minmax sample - -ds9.set(string cmd) -minmax scan -minmax mode scan -minmax interval 100 -
mode
-
Controls the first mouse button mode.
-Syntax: -mode [none|region|crosshair|colorbar|pan|zoom|rotate|catalog|examine|3d] - -Example: -string value = ds9.get(string cmd) -mode - -ds9.set(string cmd) -mode crosshair
-
mosaic
-
Load FITS mosaic segment into current frame.
-Syntax: -mosaic [wcs|wcsa...wcsz|iraf] [new|mask] [<filename>] - -Example: -string value = ds9.get(string cmd) -mosaic - -ds9.set(string cmd) -mosaic foo.fits -mosaic wcs foo.fits -mosaic wcs new foo.fits -mosaic wcs mask foo.fits -
mosaicimage
-
Load FITS mosaic image into current frame.
-Syntax: -mosaicimage [wcs|wcsa...wcsz|iraf|wfpc2] [new|mask] [<filename>] - -Example: -string value = ds9.get(string cmd) -mosaicimage -ds9.set(string cmd) -mosaicimage foo.fits -mosaicimage wcs foo.fits -mosaicimage wcs new foo.fits -mosaicimage wcs mask foo.fits -
movie
-
Create a movie from snap shots of the DS9 window. A slice movie cycles though all slices of a cube. A frame movie cycles through all active frames. A 3d movie cycles through specified viewing angles. The default action is slice. Movie types are either MPEG or Animated GIF, with default MPEG. Optional parameters for 3d: number of frames, azimuth from/to, elevation from/to, slice from/to, oscillate/repeat times.
-Syntax: -movie[slice|frame|3d][mpeg|gif] <filename> -movie 3d [mpeg|gif] <filename> [number|azfrom|azto|elfrom|elto|slfrom|slto|oscillate|repeat <#>] - -Example: -ds9.set(string cmd) -movie slice mpeg ds9.mpg -movie frame gif ds9.gif -movie 3d mpeg ds9.mpg number 10 azfrom -60 azto 60 oscillate 1 -
multiframe
-
Load FITS multiple extension file as multiple images.
-Syntax: -multiframe [<filename>] - -Example: -ds9.set(string cmd) -multiframe foo.fits
-
nameserver
-
Support Name Server functions. Coordinates are in fk5.
-Syntax: -nameserver [<object>] -    [name <object>] -    [server ned-sao|ned-cds|simbad-sao|simbad-cds|vizier-sao|vizier-cds] -    [skyformat degrees|sexagesimal] -    [pan] -    [crosshair] -    [close] - -Example: -string value = ds9.get(string cmd) -nameserver -nameserver server -nameserver skyformat -nameserver m31 - -ds9.set(string cmd) -nameserver m31 -nameserver name m31 -nameserver server ned-sao -nameserver skyformat sexagesimal -nameserver pan -nameserver crosshair -nameserver open -nameserver close -
nan
-
Set image not-a-number color.
-Syntax: -nan <color> - -Example: -string value = ds9.get(string cmd) -nan - -ds9.set(string cmd) -nan red
-
nrrd
-
Load an NRRD (Nearly Raw Raster Data) file. Optional parameter: array endian.
-Syntax: -nrrd [native|little|big] -nrrd [new|mask] [<filename>] - -Example: -string value = ds9.get(string cmd) -nrrd -nrrd big - -ds9.set(string cmd, string url) -nrrd foo.nrrd -nrrd new foo.nrrd -nrrd mask foo.nrrd
-
nvss
-
Support for NRAO VLA Sky Survey.
-Syntax: -nvss [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [open|close] - -Example: -string value = ds9.get(string cmd) -nvss name -nvss coord -nvss size -nvss save -nvss frame - -ds9.set(string cmd) -nvss -nvss m31 -nvss name m31 -nvss name clear -nvss 00:42:44.404 +41:16:08.78 -nvss size 60 60 arcmin -nvss save yes -nvss frame current -nvss update frame -nvss open -nvss close -
orient
-
Controls the orientation of the current frame.
-Syntax: -orient [none|x|y|xy] -    [open|close] - -Example: -string value = ds9.get(string cmd) -orient - -ds9.set(string cmd) -orient xy -orient open -orient close -
pagesetup
-
Controls Page Setup options.
-Syntax: -pagesetup [orient portrait|landscape] -    [scale <numeric>] -    [size letter|legal|tabloid|poster|a4] - -Example: -string value = ds9.get(string cmd) -pagesetup orient -pagesetup scale -pagesetup size - -ds9.set(string cmd) -pagesetup orient portrait -pagesetup scale 50 -pagesetup size poster -
pan
-
Controls the current image cursor location for the current frame.
-Syntax: -pan [<coordsys> [<skyframe>] [<skyformat>]] # get current coords - -pan [<x> <y> <coordsys> [<skyframe>]] # relative -    [to <x> <y> <coordsys> [<skyframe>]] # absolute -    [open|close] -    [close] - -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 -pan open -pan close -
pixeltable
-
Display/Hide the pixel table.
-Syntax: -pixeltable [] -    [yes|open] -    [no|close] - -Example: -string url = ds9.get(string cmd) -pixeltable - -ds9.set(string cmd) -pixeltable -pixeltable yes -pixeltable open -pixeltable close -
plot
-
Display and configure data plots. All plot commands take an optional second command, the plot name. 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 x and y errors
-
To create a new plot, use the plot new command.
-Syntax: -# create new empty plot window -plot [] -    [line|bar|scatter] -    [new] -    [new line|bar|scatter] -    [new name <plotname>] -    [new name <plotname> line|bar|scatter] - -#load data into existing plot from stdin -plot [[<plotname>] data xy|xyex|xyey|xyexey] - -# existing plot -plot [[<plotname>] load <filename> xy|xyex|xyey|xyexey] -    [[<plotname>] save <filename>] -    [[<plotname>] layout grid|row|column|strip] -    [[<plotname>] layout strip scale <percent>] -    [[<plotname>] add graph line|bar|scatter] -    [[<plotname>] select graph <graph>] -    [[<plotname>] delete graph] -    [[<plotname>] select dataset <dataset>] -    [[<plotname>] delete dataset] -    [[<plotname>] duplicate] -    [[<plotname>] stats yes|no] -    [[<plotname>] list yes|no] -    [[<plotname>] loadconfig <filename>] -    [[<plotname>] saveconfig <filename>] -    [[<plotname>] pagesetup orient portrait|landscape] -    [[<plotname>] pagesetup size letter|legal|tabloid|poster|a4] -    [[<plotname>] print] -    [[<plotname>] print destination printer|file] -    [[<plotname>] print command <command>] -    [[<plotname>] print filename <filename>] -    [[<plotname>] print color rgb|gray] -    [[<plotname>] close] -    [[<plotname>] mode pointer|zoom] - -# export image -plot [[<plotname>] export <filename>] -    [[<plotname>] export gif|tiff|jpeg|png <filename>] -    [[<plotname>] export jpeg <filename> [1-100]] -    [[<plotname>] export tiff <filename> none|jpeg|packbits|deflate]] - -# configure graph -plot [[<plotname>] axis x|y grid yes|no] -    [[<plotname>] axis x|y log yes|no] -    [[<plotname>] axis x|y flip yes|no] -    [[<plotname>] axis x|y auto yes|no] -    [[<plotname>] axis x|y min <value>] -    [[<plotname>] axis x|y max <value>] -    [[<plotname>] axis x|y format <string>] -    [[<plotname>] background <value>] -    [[<plotname>] legend yes|no] -    [[<plotname>] legend position right|left|top|bottom|plotarea] -    [[<plotname>] font title|labels|numbers font times|helvetica|courier] -    [[<plotname>] font title|labels|numbers size <value>] -    [[<plotname>] font title|labels|numbers weight normal|bold] -    [[<plotname>] font title|labels|numbers slant roman|italic] -    [[<plotname>] title <string>] -    [[<plotname>] title x|y <string>] -    [[<plotname>] barmode normal|stacked|aligned|overlap] - -# configure current dataset -plot [[<plotname>] show yes|no] -    [[<plotname>] shape none|circle|square|diamond|plus|splus|scross|triangle|arrow] -    [[<plotname>] shape fill yes|no] -    [[<plotname>] shape color <value>] -    [[<plotname>] smooth step|linear|cubic|quadratic|catrom] -    [[<plotname>] color <value>] -    [[<plotname>] width <value>] -    [[<plotname>] dash yes|no] -    [[<plotname>] error yes|no] -    [[<plotname>] error color <value>] -    [[<plotname>] error cap yes|no] -    [[<plotname>] error width <value>] -    [[<plotname>] name <string>] - -Example: -# return all plotnames -string value = ds9.get(string cmd) -plot - -# create new empty plot window -ds9.set(string cmd) -plot -plot bar -plot new -plot new bar -plot new name foo -plot new name foo bar - -# existing plot -string value = ds9.get(string cmd) -plot select layout -plot select layout strip scale -plot select graph -plot select dataset -plot stats -plot list - -ds9.set(string cmd) -plot load foo.dat xy -plot save foo.dat -plot layout strip -plot layout strip scale 30 -plot add graph scatter -plot select graph 1 -plot delete graph -plot select dataset 1 -plot delete dataset -plot duplicate -plot stats yes -plot list yes -plot loadconfig foo.plt -plot saveconfig foo.plt -plot pagesetup orient portrait -plot pagesetup size letter -plot print -plot print destination file -plot print command lp -plot print filename foo.ps -plot print color rgb -plot close - -# plot mode -string value = ds9.get(string cmd) -plot mode - -ds9.set(string cmd) -plot mode pointer - -# export plot -ds9.set(string cmd) -plot export tiff foo.tiff jpeg -plot export jpeg foo.jpeg 75 -plot export png foo.png - -# configure plot -string value = ds9.get(string cmd) -plot axis x grid -plot axis x log -plot axis x flip -plot axis x auto -plot axis x min -plot axis x max -plot axis x format -plot background -plot legend -plot legend position -plot font numbers font -plot font numbers size -plot font numbers weight -plot font numbers slant -plot title -plot title x - -ds9.set(string cmd) -plot axis x grid yes -plot axis x log yes -plot axis x flip yes -plot axis x auto no -plot axis x min 0 -plot axis x max 100 -plot axis x format "%f" -plot background white -plot legend yes -plot legend position left -plot font numbers font times -plot font numbers size 12 -plot font numbers weight bold -plot font numbers slant italic -plot title "This is a Title" -plot title x "X Axis" -plot title y "Y Axis" -plot title legend "This is the Legend" - -# bar plot -string value = ds9.get(string cmd) -plot barmode - -ds9.set(string cmd) -plot barmode aligned - -# configure current dataset -string value = ds9.get(string cmd) -plot show -plot shape -plot shape fill -plot shape color -plot smooth -plot color -plot width -plot dash -plot error -plot error color -plot error cap -plot error width -plot name - -ds9.set(string cmd) -plot show yes -plot shape circle -plot shape fill no -plot shape color cyan -plot smooth step -plot color red -plot width 2 -plot dash yes -plot error yes -plot error color red -plot error cap yes -plot error width 2 -plot name "My Data" - png -
Load PNG image into current frame.
-Syntax: -png [new|slice] [<filename>] - -Example: -string value = ds9.get(string cmd) -png - -ds9.set(string cmd) -png foo.png -png new foo.png -png slice foo.png
-
precision
-
Set region and coordinate output format precision.
-Syntax: -precision <linear><degree><hms><dms><arcmin><arcsec> - -Example: -string value = ds9.get(string cmd) -precision - -ds9.set(string cmd) -precision 8 10 4 3 5 3 -
prefs
-
Controls various preference settings.
-Syntax: -prefs [clear] -    [irafalign yes|no] - -Example: -string value = ds9.get(string cmd) -prefs irafalign - -ds9.set(string cmd) -prefs clear -prefs irafalign - preserve -
Preserve the follow attributes while loading a new image.
-Syntax: -preserve [pan yes|no] -    [regions yes|no] - -Example: -string value = ds9.get(string cmd) -preserve pan -preserve regions - -ds9.set(string cmd) -preserve pan yes -preserve regions yes -
psprint
-
Invokes postscript printing. Please see print for further details.
-
print
-
Controls printing. Use print option to set printing options.
-Syntax: -print [destination printer|file] -    [command <command>] -    [filename <filename>] -    [color rgb|cmyk|gray] -    [level 1|2|3] -    [resolution72|screen|96|144|150|225|300|600|1200] - -Example: -string value = ds9.get(string cmd) -print destination -print command -print filename -print color -print level -print resolution - -ds9.set(string cmd) -print -print destination file -print command lp -print filename foo.ps -print color cmyk -print level 2 -print resolution 96 -
raise
-
Raise 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 [close]] -    [epsilon <integer>] -    [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 invert] -    [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>] -    [fixed|edit|rotate|delete yes|no] -    [include|exclude|source|background] -    [command <marker command>] -    [composite] -    [dissolve] -    [template <filename>] -    [template <filename> at <ra> <dec> <coordsys> <skyframe>] -    [savetemplate <filename>] -    [groups] -    [group new] -    [group <tag> new] -    [group <tag> update] -    [group <tag> select] -    [group <tag> color <color>] -    [group <tag> copy] -    [group <tag> delete] -    [group <tag> cut] -    [group <tag> font <font>] -    [group <tag> move <int> <int>] -    [group <tag> movefront] -    [group <tag> moveback] -    [group <tag> property <property> yes|no] -    [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] -    [-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 epsilon -regions show -regions showtext -regions centroid -regions centroid auto -regions centroid radius -regions centroid iteration -regions selected -regions format -regions system -regions sky -regions skyformat -regions strip -regions shape -regions color -regions width -regions source -regions background -regions include -regions exclude -regions selected -regions groups - -ds9.set(string cmd) -regions foo.reg -regions -format ciao bar.reg # load as ciao format -regions foo.fits # FITS regions files do not need a format specification -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 list close -regions epsilon 5 -regions show yes -regions showtext no -regions centroid -regions centroid auto yes -regions centroid radius 10 -regions centroid iteration 20 -regions getinfo -regions move back -regions move front -regions select all -regions select none -regions select invert -regions delete all -regions delete select -regions format ds9 -regions system wcs -regions sky fk5 -regions skyformat degrees -regions strip yes -regions shape ellipse -regions color red -regions width 3 -regions edit yes -regions include -regions command "circle 100 100 20 # color=red" -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 new -regions group foo new -regions group foo update -regions group foo select -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 copy -regions cut -regions paste wcs -regions undo -
restore
-
Restore DS9 to a previous state from a backup save set.
-Syntax: -restore <filename> - -Example: -restore ds9.bck
-
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 wcs|crop|slice|bin|scale|scalelimits|colorbar|block|smooth [yes|no]] -    [open|close] - -Example: -string value = ds9.get(string cmd) -rgb channel -rgb lock wcs -rgb lock crop -rgb lock slice -rgb lock bin -rgb lock scale -rgb lock scalelimits -rgb lock colorbar -rgb lock block -rgb lock smooth -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 wcs yes -rgb lock crop yes -rgb lock slice yes -rgb lock bin yes -rgb lock scale yes -rgb lock scalelimits yes -rgb lock colorbar yes -rgb lock block yes -rgb lock smooth yes -rgb open -rgb close
-
rgbarray
-
Load raw data array cube into rgb frame.
-Syntax: -rgbarray [native|big|little] -rgbarray [new] [[xdim=<x>,ydim=<y>|dim=<dim>],[zdim=3],bitpix=<b>,skip=<s>,endian=[little|big]] - -Example: -string value = ds9.get(string cmd) -rgbarray - -ds9.set(string cmd) -rgbarray foo.arr[dim=512,zdim=3,bitpix=-32,endian=little] -rgbarray new foo.arr[dim=512,zdim=3,bitpix=-32,endian=little]
-
rgbcube
-
Load FITS rgbcube into rgb frame.
-Syntax: -rgbcube [new] [<filename>] - -Example: -string value = ds9.get(string cmd) -rgbcube - -ds9.set(string cmd) -rgbcube foo.fits -rgbcube new foo.fits
-
rgbimage
-
Load FITS rgbimage into rgb frame.
-Syntax: -rgbimage [new] [<filename>] - -Example: -string value = ds9.get(string cmd) -rgbimage - -ds9.set(string cmd) -rgbimage foo.fits -rgbimage new foo.fits -
rotate
-
Controls the rotation angle (in degrees) of the current frame.
-Syntax: -rotate [<value>] -    [to <value>] -    [open|close] - -Example: -string value = ds9.get(string cmd) -rotate - -ds9.set(string cmd) -rotate 45 -rotate to 30 -rotate open -rotate close
-
samp
-
Configure SAMP protocol.
-Syntax: -samp [no|disconnect] -    [broadcast [image|table]] -    [send [image|table] <application>] - -Example: - -ds9.set(string cmd) -samp no -samp disconnect -samp broadcast image -samp send image aladin -
save
-
Save loaded image data of current frame as FITS.
-Syntax: -save[fits|rgbimage|rgbcube|mecube|mosaic|mosaicimage] <filename> [image|table|slice] - -Example: -ds9.set(string cmd) -save foo.fits -save fits foo.fits image -save fits foo.fits table -save fits foo.fits slice -save rgbimage foo.fits -save rgbcube foo.fits -save mecube foo.fits -save mosaic foo.fits -save mosaicimage foo.fits
-
saveimage
-
Create a snap shot of the current DS9 window and save in specified image format. If no format specified, the file name extension is used to determine the output format. Optional parameters: jpeg quality (1-100) and tiff compression method.
-Syntax: -saveimage[fits|eps|gif|tiff|jpeg|png]<filename> -saveimage <filename>.jpeg [1-100] -saveimage <filename>.tiff [none|jpeg|packbits|deflate] - -Example: -ds9.set(string cmd) -saveimage ds9.tiff -saveimage jpeg ds9.jpeg 75
-
scale
-
Controls the limits and color scale distribution.
-Syntax: -scale [linear|log|pow|sqrt|squared|asinh|sinh|histequ] -    [log exp <value>] -    [datasec yes|no] -    [limits <minvalue> <maxvalue>] -    [mode minmax|<value>|zscale|zmax] -    [scope local|global] -    [match] -    [match limits] -    [lock [yes|no]] -    [lock limits [yes|no]] -    [open|close] - -Example: -string value = ds9.get(string cmd) -scale -scale log exp -scale datasec -scale limits -scale mode -scale scope -scale lock -scale lock limits - -ds9.set(string cmd) -scale linear -scale log exp 100 -scale datasec yes -scale histequ -scale limits 1 100 -scale mode zscale -scale mode 99.5 -scale scope local -scale match -scale match limits -scale lock yes -scale lock limits yes -scale open -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>]] -    [mosaicimage [iraf|wcs|wcsa...wcsz|wfpc2] [key|shmid] <id> [<filename>]] -    [mosaic [iraf|wcs|wcsa...wcsz] [key|shmid] <id> [<filename>]] -    [rgbcube [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>]] - -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 mosaicimage iraf key 100 foo -shm mosaicimage wcs key 100 foo -shm mosaicimage wcsa key 100 foo -shm mosaicimage wfpc2 key 100 foo -shm mosaic iraf key 100 foo -shm mosaic wcs key 100 foo -shm rgbcube key 100 foo -shm rgbimage key 100 foo -shm rgbarray key 100 [dim=200,zdim=3,bitpix=-32] -shm array shmid 102 [dim=32,bitpix=-32] - sia
-
Support for VO Simple Image Access protocol. The first command will create a new search. All other commands operated on the last search created, unless indicated otherwise.
-Syntax: + + + + + SAMP + + + 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 + 3d + about + analysis + array + background + backup + bin + blink + block + catalog + cd + cmap + colorbar + console + contour + crop + crosshair + cube + cursor + data + dsssao + dsseso + dssstsci + envi + exit + export + file + fits + frame + gif + grid + header + height + iconify + iexam + iis + jpeg + lock + lower + magnifier + mask + match + mecube + minmax + mode + mosaic + mosaicimage + movie + multiframe + nameserver + nan + nrrd + nvss + orient + pagesetup + pan + pixeltable + plot + png + precision + prefs + preserve + psprint + print + quit + raise + regions + restore + rgb + rgbarray + rgbcube + rgbimage + rotate + samp + save + saveimage + scale + shm + sia + single + skyview + sleep + smooth + source + tcl + threads + tiff + tile + update + url + version + view + vla + vlss + vo + wcs + web + width + zscale + zoom + + 2mass + Support for 2MASS Digital Sky Survey. + Syntax: + 2mass [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # 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: + string value = ds9.get(string cmd) + 2mass name + 2mass coord + 2mass size + 2mass save + 2mass frame + 2mass survey + + ds9.set(string cmd) + 2mass + 2mass m31 + 2mass name m31 + 2mass name clear + 2mass 00:42:44.404 +41:16:08.78 + 2mass size 60 60 arcmin + 2mass save yes + 2mass frame current + 2mass update frame + 2mass survey j + 2mass open + 2mass close + + 3d + Support for 3D frame. + Syntax: + 3d [] +    [view <az> <el>] +    [az <az>] +    [el <el>] +    [scale <scale>] +    [method mip|aip] +    [background none|azimuth|elevation] +    [border yes|no] +    [border color <color>] +    [highlite yes|no] +    [hightlite color <color>] +    [compass yes|no] +    [compass color <color>] +    [match] +    [lock [yes|no]] +    [open|close] + + Example: + string value = ds9.get(string cmd) + 3d view + 3d az + 3d el + 3d scale + 3d method + 3d background + 3d border + 3d border color + 3d highlite + 3d highlite color + 3d compass + 3d compass color + 3d lock + + ds9.set(string cmd) + 3d # create new 3D frame + 3d view 45 30 + 3d az 45 + 3d el 30 + 3d scale 10 + 3d method mip + 3d background azimuth + 3d border yes + 3d border color red + 3d highlite yes + 3d highlite color red + 3d compass yes + 3d compass color red + 3d match + 3d lock yes + 3d open + 3d close + + about + Get DS9 credits. + Syntax: + about + + Example: + string value = ds9.get(string cmd) + about + + align + Controls the World Coordinate System alignment for the current + frame. + Syntax: + align [] +     [yes|no] + + Example: + string value = ds9.get(string cmd) + align + + ds9.set(string cmd) + align yes + 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: + string value = ds9.get(string cmd) + analysis + analysis task + analysis entry {Please enter something} + analysis entry okcancel {Hello World} + + ds9.set(string cmd) + analysis 0 # invoke first analysis task + analysis task 0 + analysis task foobar + analysis task {foo bar} + analysis my.ans + analysis load my.ans + analysis clear + analysis clear load my.ans + analysis message {This is a message} + analysis text {this is text} + + ds9.set(string cmd, string url) + analysis load + analysis text + + array + Load raw data array into current frame. + + Syntax: + array [native|little|big] + array [new|mask] +[[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,endian=[little|big]] + + Example: + string url = ds9.get(string cmd) + array + array little + + ds9.set(string command, string url) + array foo.arr[dim=512,bitpix=-32,endian=little] + array new foo.arr[dim=512,bitpix=-32,endian=little] + array mask foo.arr[dim=512,bitpix=-32,endian=little] + + bg + background + Set image background color. + Syntax: + bg <color> + + Example: + string url = ds9.get(string cmd) + bg + + ds9.set(string cmd) + bg red + backup + Create a backup save set. + Syntax: + backup <filename> + + Example: + ds9.set(string cmd) + backup ds9.bck + 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>] +     [filter clear] +     [function average|sum] +     [in] +     [out] +     [to fit] +     [match] +     [lock [yes|no]] +     [open|close] + + 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 + bin lock + + 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 clear + bin function sum + bin in + bin out + bin to fit + bin match + bin lock yes + bin open + bin close + + 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 + block + Controls blocking parameters. + Syntax: + block[<value>] +     [<value> <value>] +     [to <value>] +     [to <value> <value>] +     [in] +     [out] +     [to fit] +     [match] +     [lock [yes|no]] +     [open|close] + + Example: + string value = ds9.get(string cmd) + block + block lock + + ds9.set(string cmd) + block4 + block4 2 + blockto 4 + blockto 4 2 + blockin + blockout + blockto fit + blockmatch + blocklock yes + blockopen + blockclose + + 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 [new] +     [ned|simbad|denis|skybot] +     +[aavso|ac|ascss|cmc|gaia|gsc1|gsc2|gsc3|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|sdss9|tycho] +     [ua2|ub1|ucac2|ucac2sup|ucac3|ucac4|urat1] +     [2mass|iras] +     [csc|xmm|rosat] +     [first|nvss] +     [chandralog|cfhtlog|esolog|stlog|xmmlog] +     [cds <catalogname>] +     [cds <catalogid>] + +     [load <filename>] +     [import sb|tsv <filename>] + +     [<ref>] [<ra> <dec> + <coordsys>] +     [<ref>] [allcols] +     [<ref>] [allrows] +     [<ref>] [cancel] +     [<ref>] [clear] +     [<ref>] [close] +     [<ref>] [crosshair] +     [<ref>] [dec <col>] +     [<ref>] [edit yes|no] +     [<ref>] [export sb|tsv + <filename>] +     [<ref>] [filter <string>] +     [<ref>] [filter load <filename>] +     [<ref>] [header] +     [<ref>] [location <code>] +     [<ref>] [match] +     [<ref>] [match <ref> <ref>] +     [<ref>] [match error <value> + degrees|arcmin|arcsec] +     [<ref>] [match function + 1and2|1not2|2not1] +     [<ref>] [match return + 1and2|1only|2only] +     [<ref>] [match unique yes|no] +     [<ref>] [maxrows <number>] +     [<ref>] [name <object>] +     [<ref>] [panto yes|no] +     [<ref>] [plot <xcol> <ycol> + <xerrcol> <yerrcol>] +     [<ref>] [print] +     [<ref>] [psky <skyframe>] +     [<ref>] [psystem <coordsys>] +     [<ref>] [ra <col>] +     [<ref>] [regions] +     [<ref>] [retrieve] +     [<ref>] [samp] +     [<ref>] [samp broadcast] +     [<ref>] [samp send <application>] +     [<ref>] [save <filename>] +     [<ref>] + [servercds|adac|cadc|cambridge|sao|ukirt|iucaa|bejing|saao] +     [<ref>] [show yes|no] +     [<ref>] [radius <value> + degrees|arcmin|arcsec] +     [<ref>] [sky <skyframe>] +     [<ref>] [skyformat <skyformat>] +     [<ref>] [sort <col> incr|decr] +     [<ref>] [symbol [#] + condition|shape|color|text|font|fontsize|fontweight|fontslant + <value>] +     [<ref>] [symbol [#] + text|size|size2|units|angle <value>] +     [<ref>] [symbol shape + circle|ellipse|box|text|point] +     [<ref>] [symbol shapecircle point|box + point|diamond point|cross point|x point|arrow point|boxcircle + point] +     [<ref>] [symbol add| [#] remove] +     [<ref>] [symbol save|load + <filename>] +     [<ref>] [system <coordsys>] +     [<ref>] [update] +     [<ref>] [x <col>] +     [<ref>] [y <col>] + + Example: + string value = ds9.get(string cmd) + catalog + catalog header + + ds9.set(string cmd) + catalog new + catalog 2mass + catalog cds 2mass + catalog cds{I/252} + + catalog load foo.xml + catalog import tsv foo.tsv + + catalog coordinate 202.48 47.21 fk5 + catalog allrows + catalog allcols + catalog cancel + catalog clear + catalog close + catalog crosshair + catalog dec DEC + catalog edit yes + catalog export tsv bar.tsv + catalog filter {$Jmag>10} + catalog filter load foo.flt + catalog header + catalog location 500 + catalog match error 2 arcsec + catalog match function 1and2 + catalog match unique no + catalog match return 1only + catalog match # last two catalogs loaded + catalog match 2mass csc + catalog maxrows 2000 + catalog name m51 + catalog panto no + catalog plot{$Jmag} {$Hmag} {$e_Jmag} {$e_Hmag} + catalog print + catalog psky fk5 + catalog psystem wcs + catalog ra RA + catalog regions + catalog retrieve + catalog samp broadcast + catalog samp send aladin + catalog save foo.xml + catalog server sao + catalog show yes + catalog radius 1 degrees + catalog symbol condition{$Jmag>15} + catalog symbol 2 shape{boxcircle point} + catalog symbol color red + catalog symbol font times + catalog symbol fontsize 14 + catalog symbol fontweight bold + catalog symbol fontslant italic + catalog symbol add + catalog symbol 2 remove + catalog symbol load foo.sym + catalog symbol save bar.sym + catalog sky fk5 + catalog skyformat degrees + catalog sort {Jmag} incr + catalog system wcs + catalog update + catalog x RA + catalog y DEC + + 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] +     [load <filename>] +     [save <filename>] +     [invert yes|no] +     [<constrast> <bias>] +     [tag [load|save] <filename>] +     [tag delete] +     [open|close] + + Example: + string value = ds9.get(string cmd) + cmap + cmap file + cmap invert + cmap value + + ds9.set(string cmd) + cmap Heat + cmap load foo.sao + cmap save bar.sao + cmap invert yes + cmap 5 .5 + cmap tag load foo.tag + cmap tag save foo.tag + cmap tag delete + cmap open + cmap close + + colorbar + Controls colorbar parameters. + Syntax: + colorbar [] +     [yes|no] +     [orientation] +     [horizontal|vertical] +     [numerics yes|no] +     [space value|distance] +     [font times|helvetica|courier] +     [fontsize <value>] +     [fontweight normal|bold] +     [fontslant roman|italic] +     [size] +     [ticks] +     [match] +     [lock [yes|no]] + + Example: + string value = ds9.get(string cmd) + colorbar + colorbar orientation + colorbar numerics + colorbar space + colorbar font + colorbar fontsize + colorbar fontweight + colorbar fontslant + colorbar size + colorbar ticks + colorbar lock + + ds9.set(string cmd) + colorbar yes + colorbar vertical + colorbar numerics yes + colorbar space value + colorbar font times + colorbar fontsize 14 + colorbar fontwieght bold + colorbar fontslant italic + colorbar size 20 + colorbar ticks 11 + colorbar match + colorbar lock yes + 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>] +     [save <filename> [<coordsys> + <skyframe>]] +     [convert] +     [load levels <filename>] +     [save levels <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|asinh|sinh|histequ] +     [scale log exp <value>] +     [mode minmax|<value>|zscale|zmax] +     [scope global|local] +     [limits <min> <max>] +     [levels <value value value...>] +     [open|close] + + Example: + string value = ds9.get(string cmd) + contour + contour wcs fk5 + contour color + contour width + contour dash + contour smooth + contour method + contour nlevels + contour scale + contour log exp + contour mode + contour scope + contour limits + contour levels + + ds9.set(string cmd) + contour + contour yes + contour clear + contour generate + contour load ds9.ctr + contour save ds9.con + contour save ds9.con wcs fk5 + contour convert + contour load levels ds9.ctr + contour save levels ds9.lev + contour copy + contour paste + contour paste wcs 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 log exp 1000 + contour mode zscale + contour scope local + contour limits 1 100 + contour levels 1 10 100 1000 + contour open + contour close + + crop + Set current image display area. + Syntax: + crop [<x> <y> <width> <height> + [<coordsys>][<skyframe>][degrees|arcmin|arcsec] +     [match <coordsys>] +     [lock <coordsys>|none] +     [reset] +     [3dzmin zmax <coordsys>] +     [open|close] + + Example: + string value = ds9.get(string cmd) + crop # get crop in physical coords + crop wcs galactic sexagesimal arcsec + crop lock + + ds9.set(string cmd) + crop 40 30 10 20 # set crop in physical coords + crop +104:51:06.915 +68:33:40.761 28.144405 22.000204 wcs + galactic arcsec + crop match wcs + crop lock wcs + crop reset + crop 3d .25 .5 wcs + crop open + crop 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>]] +     [match <coordsys>] +     [lock <coordsys>|none] + + Example: + string value = ds9.get(string cmd) + crosshair # get crosshair in physical coords + crosshair wcs fk4 sexagesimal # get crosshair in wcs coords + crosshair lock + + 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 + crosshair match wcs + crosshair lock wcs + + cube + + Controls FITS cube. + Syntax: + cube [] +     [play|stop|next|prev|first|last] +     [<slice> [<coordsys>]] +     [interval <numeric>] +     [match <coordsys>] +     [lock <coordsys>|none] +     [order 123|132|213|231|312|321] +     [axes lock [yes|no]] +     [axis <axis>] +     [open|close] + + Example: + string value = ds9.get(string cmd) + cube + cube wcs + cube interval + cube lock + cube order + cube axes lock + cube axis + + ds9.set(string cmd) + cube + cube play + cube last + cube 3 + cube 4.4 wcs + cube interval 2 + cube match wcs + cube lock wcs + cube order 123 + cube axes lock yes + cube axis 3 + cube open + cube close + 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 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> + <width> <height> [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 + + dsssao + dss + + Support for Digital Sky Survey at SAO. + Syntax: + dsssao [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [open|close] + + Example: + string value = ds9.get(string cmd) + dsssao name + dsssao coord + dsssao size + dsssao save + dsssao frame + + ds9.set(string cmd) + dsssao + dsssao m31 + dsssao name m31 + dsssao name clear + dsssao 00:42:44.404 +41:16:08.78 + dsssao size 60 60 arcmin + dsssao save yes + dsssao frame current + dsssao update frame + dsssao open + dsssao close + + dsseso + Support for Digital Sky Survey at ESO. + Syntax: + dsseso [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # 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: + string value = ds9.get(string cmd) + dsseso name + dsseso coord + dsseso size + dsseso save + dsseso frame + dsseso survey + + ds9.set(string cmd) + dsseso + dsseso m31 + dsseso name m31 + dsseso name clear + dsseso 00:42:44.404 +41:16:08.78 + dsseso size 60 60 arcmin + dsseso save yes + dsseso frame current + dsseso update frame + dsseso survey DSS2-red + dsseso open + dsseso close + + dssstsci + Support for Digital Sky Survey at STSCI. + Syntax: + dssstsci [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # 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: + string value = ds9.get(string cmd) + dssstsci name + dssstsci coord + dssstsci size + dssstsci save + dssstsci frame + dssstsci survey + + ds9.set(string cmd) + dssstsci + dssstsci m31 + dssstsci name m31 + dssstsci name clear + dssstsci 00:42:44.404 +41:16:08.78 + dssstsci size 60 60 arcmin + dssstsci save yes + dssstsci frame current + dssstsci update frame + dssstsci survey all + dssstsci open + dssstsci close + envi + Load an ENVI header and file. Optional parameter: array endian. + + Syntax: + envi [new] <header> [<filename>] + + Example: + ds9.set(string cmd) + envi foo.hdr + envi new foo.hdr + envi foo.hdr foo.bsq + + exit + quit + + Quits DS9. + Syntax: + exit + quit + + Example: + ds9.set(string cmd) + exit + export + + Export loaded image data of current frame in specified image + format. Optional parameters: array endian, nrrd endian, jpeg + quality (1-100) and tiff compression method. + Syntax: + export[array|nrrd|envi|gif|tiff|jpeg|png]<filename> + export array <filename>[big|little|native] + export nrrd <filename>[big|little|native] + export envi <header> [<filename>][big|little|native] + export jpeg <filename>[1-100] + export tiff <filename>[none|jpeg|packbits|deflate] + + Example: + + ds9.set (string cmd) + export array foo.arr little + export nrrd foo.nrrd little + export envi foo.hdr little + export envi foo.hdr foo.bsq little + export tiff foo.tiff jpeg + export jpeg foo.jpeg 75 + export png foo.png + file + Query currently loaded file information. + Syntax: + file + + Example: + string value = ds9.get(string cmd) + file + + fits + Load a FITS image into the current frame or query the currently + loaded image. + + Syntax: + fits[new|mask|slice] [<filename>] +     [width|height|depth|bitpix|type] +     [size [wcs|wcsa...wcsz] + [fk4|fk5|icrs|galactic|ecliptic] [degrees|arcmin|arcsecs]] +     [header [<ext>] [keyword + <string>]] +     [image|table|slice] + + Example: + string value = ds9.get(string cmd) + fits + fits width + fits height + fits depth + fits bitpix + fits size + fits size wcs fk5 arcmin + fits header # primary + fits header 2 # hdu 2 + fits header -2 # hdu 2 with inherit + fits header keyword BITPIX + fits header 1 keyword BITPIX + fits image + fits table + fits slice + + ds9.set(string cmd, string url) + fits foo.fits + fits new foo.fits + fits bar.fits[bin=detx,dety] + fits slice foo.fits + fits mask foo.fits + + 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|3d]] +     [delete [#|all]] +     [reset [#|all]] +     [refresh [#|all]] +     [hide [#|all]] +     [show [#|all]] +     [move first] +     [move back] +     [move forward] +     [move last] +     [first] +     [prev] +     [next] +     [last] +     [frameno #] +     [#] +     [match <coordsys>] +     [lock <coordsys>|none] +     [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>]] +     [has wcs celestial [<wcssys>]] +     [has wcs linear [<wcssys>]] + + 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 + frame lock + frame has amplifier + frame has datamin + frame has datasec + frame has detector + frame has grid + frame has iis + frame has irafmin + frame has physical + frame has smooth + frame has contour + frame has contour aux + frame has fits + frame has fits bin + frame has fits cube + frame has fits mosaic + frame has marker highlite + frame has marker paste + frame has marker select + frame has marker undo + frame has system physical + frame has wcs wcsa + frame has wcs celestial wcsa + frame has wcs linear wcsa + + 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 + frame match wcs + frame lock wcs + gif + Load GIF image into current frame. + + Syntax: + gif [new|slice] [<filename>] + + Example: + string value = ds9.get(string cmd) + gif + + ds9.set(string cmd) + gif foo.gif + gif new foo.gif + gif slice foo.gif + + 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 dash yes|no] +     [grid gap1 <value>] +     [grid gap2 <value>] +     [grid gap3 <value>] +     [axes yes|no] +     [axes color <color>] +     [axes width <value>] +     [axes dash yes|no] +     [axes type interior|exterior] +     [axes origin lll|llu|lul|luu|ull|ulu|uul|uuu] +     [format1 <format>] +     [format2 <format>] +     [tickmarks yes|no] +     [tickmarks color <color>] +     [tickmarks width <value>] +     [tickmarks dash yes|no] +     [border yes|no] +     [border color <color>] +     [border width <value>] +     [border dash yes|no] +     [numerics yes|no] +     [numerics font times|helvetica|courier] +     [numerics fontsize <value>] +     [numerics fontweight normal|bold] +     [numerics fontslant roman|italic] +     [numerics color <color>] +     [numerics gap1 <value>] +     [numerics gap2 <value>] +     [numerics gap3 <value>] +     [numerics type interior|exterior] +     [numerics 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>] +     [labels yes|no] +     [labels text1 <text>] +     [labels text2 <text>] +     [labels def1 yes|no] +     [labels def2 yes|no] +     [labels gap1 <value>] +     [labels gap2 <value>] +     [labels font times|helvetica|courier] +     [labels fontsize <value>] +     [labels fontweight normal|bold] +     [labels fontslant roman|italic] +     [labels color <color>] +     [reset] +     [load <filename>] +     [save <filename>] +     [open|close] + + 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 dash + grid grid gap1 + grid grid gap2 + grid grid gap3 + grid axes + grid axes color + grid axes width + grid axes dash + grid axes type + grid axes origin + grid format1 + grid format2 + grid tickmarks + grid tickmarks color + grid tickmarks width + grid tickmarks dash + grid border + grid border color + grid border width + grid border dash + grid numerics + grid numerics font + grid numerics fontsize + grid numerics fontweight + grid numerics fontslant + grid numerics color + grid numerics gap1 + grid numerics gap2 + grid numerics gap3 + grid numerics type + grid numerics vertical + grid title + grid title text + grid title def + grid title gap + grid title font + grid title fontsize + grid title fontweight + grid title fontslant + grid title color + grid labels + grid labels text1 + grid labels text2 + grid labels def1 + grid labels def2 + grid labels gap1 + grid labels gap2 + grid labels font + grid labels fontsize + grid labels fontweight + grid labels fontslant + grid labels 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 dash yes + grid grid gap1 10 + grid grid gap2 10 + grid grid gap3 10 + grid axes yes + grid axes color red + grid axes width 2 + grid axes dash yes + grid axes type exterior + grid axes origin lll + grid format1 d.2 + grid format2 d.2 + grid tickmarks yes + grid tickmarks color red + grid tickmarks width 2 + grid tickmarks dash yes + grid border yes + grid border color red + grid border width 2 + grid border dash yes + grid numerics yes + grid numerics font courier + grid numerics fontsize 12 + grid numerics fontweight bold + grid numerics fontslant italic + grid numerics color red + grid numerics gap1 10 + grid numerics gap2 10 + grid numerics gap3 10 + grid numerics type exterior + grid numerics vertical yes + grid title yes + grid title text {Hello World} + grid title def yes + grid title gap 10 + grid title fontsize 12 + grid title font courier + grid title fontweight bold + grid title fontslant italic + grid title color red + grid labels yes + grid labels text1 {Hello World} + grid labels text2 {Hello World} + grid labels def1 yes + grid labels def2 yes + grid labels gap1 10 + grid labels gap2 10 + grid labels font courier + grid labels fontsize 12 + grid labels fontweight bold + grid labels fontslant italic + grid labels color red + grid reset + grid load foo.grd + grid save foo.grd + grid open + grid close + + header + Display current fits header dialog. Optional extension number + maybe specified. Please note, this differs from samp fits + header. + Syntax: + header [<ext>] +     [close [<ext>]] +     [save [<ext>] <filename>] + + Example: + string value = ds9.get(string cmd) + header + header 2 + header close + + 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 + iexam + 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. The default event is + button. In the last form, the following macros will be + expanded if present: $width, $height, $depth, $bitpix, + $filename, $regions, $filename[$regions], $env, $pan, $value, + $x, $y, $z. See Analysis + Macros for more information. + Syntax: + iexam [] +     [[]|button|key|any] coordinate + <coordsys> [<skyframe>] [<skyformat>] +     [[]|button|key|any] data [width][height] +     [[]|button|key|any] <macro string>] + + Example: + string value = ds9.get(string cmd) + iexam + iexam coordinate image + iexam key coordinate image # return coordinate and key event + iexam coordinate wcs fk5 degrees + iexam coordinate wcs galactic sexagesimal + iexam coordinate fk5 + iexam data # return data value + iexam key data # return data value and key event + iexam data 3 3 # return all data in 3x3 box about selected point + iexam {'Click at $x,$y in file $filename'} + + 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 + jpeg + Load JPEG image into current frame. Optional parameters: jpeg + quality (1-100) + Syntax: + jpeg [new|slice] [<filename>] [1-100] + + Example: + string value = ds9.get(string cmd) + jpeg + + ds9.set(string cmd) + jpeg foo.jpeg + jpeg new foo.jpeg + jpeg slice foo.jpeg + + lock + Lock all other frames to the current frame. + Syntax: + lock[frame <coordsys>|none] +     [crosshair <coordsys>|none] +     [crop <coordsys>|none] +     [slice <coordsys>|none] +     [bin [yes|no]] +     [axes [yes|no]] +     [scale [yes|no]] +     [scalelimits [yes|no]] +     [colorbar [yes|no]] +     [block [yes|no]] +     [smooth [yes|no]] +     [3d [yes|no]] + + Example: + string value = ds9.get(string cmd) + lock frame + lock crosshair + lock crop + lock slice + lock bin + lock axes + lock scale + lock scalelimits + lock colorbar + lock block + lock smooth + lock 3d + + ds9.set(string cmd) + lock frame wcs + lock crosshair wcs + lock crop wcs + lock slice wcs + lock bin yes + lock axes yes + lock scale yes + lock scalelimits yes + lock colorbar yes + lock block yes + lock smooth yes + lock 3d yes + + lower + Lower in the window stacking order. + Syntax: + lower + + Example: + ds9.set(string cmd) + lower + + magnifier + Controls the magnifier settings. + Syntax: + magnifier [color <color>] +     [zoom <value>] +     [cursor yes|no] +     [region yes|no] + + Example: + string value = ds9.get(string cmd) + magnifier color + magnifier zoom + magnifier cursor + magnifier region + + ds9.set(string cmd) + magnifier color yellow + magnifier zoom 2 + magnifier cursor no + magnifier region no + + mask + + Controls mask parameters. + Syntax: + mask [color <color>] +     [mark zero|nonzero|nan|nonnan|range] +     [range <low> <high>] +     [transparency <value>] +     [system <coordsys>] +     [clear] +     [open|close] + + Example: + string value = ds9.get(string cmd) + mask color + mask mark + mask range + mask system + mask transparency + + ds9.set(string cmd) + mask color red + mask mark zero + mask range 10 100 + mask transparency 50 + mask system wcs + mask clear + mask open + mask close + + match + Match all other frames to the current frame. + Syntax: + match[frame <coordsys>] +     [crosshair <coordsys>] +     [crop <coordsys>] +     [slice <coordsys>] +     [bin] +     [axes] +     [scale] +     [scalelimits] +     [colorbar] +     [block] +     [smooth] +     [3d] + + Example: + ds9.set(string cmd) + match frame wcs + match crosshair wcs + match crop wcs + match slice wcs + match bin + match axes + match scale + match scalelimits + match colorbar + match block + match smooth + match 3d + + mecube + Load FITS multiple extension file as data cube. + + Syntax: + mecube [new] [<filename>] + + Example: + string value = ds9.get(string cmd) + mecube + + ds9.set(string cmd) + mecube foo.fits + mecube new foo.fits + + minmax + This is how DS9 determines the min and max data values + from the data. SCAN will scan all data. + Syntax: + minmax [scan|sample|datamin|irafmin] +     [mode scan|sample|datamin|irafmin] +     [interval #] + + Example: + string value = ds9.get(string cmd) + minmax mode + minmax sample + + ds9.set(string cmd) + minmax scan + minmax mode scan + minmax interval 100 + + mode + Controls the first mouse button mode. + Syntax: + mode + [none|region|crosshair|colorbar|pan|zoom|rotate|catalog|examine|3d] + + Example: + string value = ds9.get(string cmd) + mode + + ds9.set(string cmd) + mode crosshair + mosaic + Load FITS mosaic segment into current frame. + Syntax: + mosaic [wcs|wcsa...wcsz|iraf] [new|mask] [<filename>] + + Example: + string value = ds9.get(string cmd) + mosaic + + ds9.set(string cmd) + mosaic foo.fits + mosaic wcs foo.fits + mosaic wcs new foo.fits + mosaic wcs mask foo.fits + + mosaicimage + Load FITS mosaic image into current frame. + Syntax: + mosaicimage [wcs|wcsa...wcsz|iraf|wfpc2] [new|mask] + [<filename>] + + Example: + string value = ds9.get(string cmd) + mosaicimage + ds9.set(string cmd) + mosaicimage foo.fits + mosaicimage wcs foo.fits + mosaicimage wcs new foo.fits + mosaicimage wcs mask foo.fits + + movie + Create a movie from snap shots of the DS9 window. A slice + movie cycles though all slices of a cube. A frame + movie cycles through all active frames. A 3d movie + cycles through specified viewing angles. The default action is slice. + Movie types are either MPEG or Animated GIF, + with default MPEG. Optional parameters for 3d: + number of frames, azimuth from/to, elevation from/to, slice + from/to, oscillate/repeat times. + Syntax: + movie[slice|frame|3d][mpeg|gif] <filename> + movie 3d [mpeg|gif] <filename> + [number|azfrom|azto|elfrom|elto|slfrom|slto|oscillate|repeat + <#>] + + Example: + ds9.set(string cmd) + movie slice mpeg ds9.mpg + movie frame gif ds9.gif + movie 3d mpeg ds9.mpg number 10 azfrom -60 azto 60 oscillate 1 + + multiframe + Load FITS multiple extension file as multiple images. + + Syntax: + multiframe [<filename>] + + Example: + ds9.set(string cmd) + multiframe foo.fits + nameserver + Support Name Server functions. Coordinates are in fk5. + Syntax: + nameserver [<object>] +     [name <object>] +     [server + ned-sao|ned-cds|simbad-sao|simbad-cds|vizier-sao|vizier-cds] +     [skyformat degrees|sexagesimal] +     [pan] +     [crosshair] +     [close] + + Example: + string value = ds9.get(string cmd) + nameserver + nameserver server + nameserver skyformat + nameserver m31 + + ds9.set(string cmd) + nameserver m31 + nameserver name m31 + nameserver server ned-sao + nameserver skyformat sexagesimal + nameserver pan + nameserver crosshair + nameserver open + nameserver close + + nan + Set image not-a-number color. + Syntax: + nan <color> + + Example: + string value = ds9.get(string cmd) + nan + + ds9.set(string cmd) + nan red + nrrd + Load an NRRD (Nearly Raw Raster Data) file. Optional parameter: + array endian. + + Syntax: + nrrd [native|little|big] + nrrd [new|mask] [<filename>] + + Example: + string value = ds9.get(string cmd) + nrrd + nrrd big + + ds9.set(string cmd, string url) + nrrd foo.nrrd + nrrd new foo.nrrd + nrrd mask foo.nrrd + nvss + Support for NRAO VLA Sky Survey. + Syntax: + nvss [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [open|close] + + Example: + string value = ds9.get(string cmd) + nvss name + nvss coord + nvss size + nvss save + nvss frame + + ds9.set(string cmd) + nvss + nvss m31 + nvss name m31 + nvss name clear + nvss 00:42:44.404 +41:16:08.78 + nvss size 60 60 arcmin + nvss save yes + nvss frame current + nvss update frame + nvss open + nvss close + + orient + Controls the orientation of the current frame. + Syntax: + orient [none|x|y|xy] +     [open|close] + + Example: + string value = ds9.get(string cmd) + orient + + ds9.set(string cmd) + orient xy + orient open + orient close + + pagesetup + Controls Page Setup options. + Syntax: + pagesetup [orient portrait|landscape] +     [scale <numeric>] +     [size letter|legal|tabloid|poster|a4] + + Example: + string value = ds9.get(string cmd) + pagesetup orient + pagesetup scale + pagesetup size + + ds9.set(string cmd) + pagesetup orient portrait + pagesetup scale 50 + pagesetup size poster + + pan + Controls the current image cursor location for the current + frame. + Syntax: + pan [<coordsys> [<skyframe>] [<skyformat>]] # + get current coords + + pan [<x> <y> <coordsys> [<skyframe>]] # + relative +     [to <x> <y> <coordsys> + [<skyframe>]] # absolute +     [open|close] +     [close] + + 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 + pan open + pan close + + pixeltable + Display/Hide the pixel table. + Syntax: + pixeltable [] +     [yes|open] +     [no|close] + + Example: + string url = ds9.get(string cmd) + pixeltable + + ds9.set(string cmd) + pixeltable + pixeltable yes + pixeltable open + pixeltable close + + plot + Display and configure data plots. All plot commands take an + optional second command, the plot name. 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 x and y + errors + + To create a new plot, use the plot new command. + Syntax: + # create new empty plot window + plot [] +     [line|bar|scatter] +     [new] +     [new line|bar|scatter] +     [new name <plotname>] +     [new name <plotname> line|bar|scatter] + + #load data into existing plot from stdin + plot [[<plotname>] data xy|xyex|xyey|xyexey] + + # existing plot + plot [[<plotname>] load <filename> + xy|xyex|xyey|xyexey] +     [[<plotname>] save <filename>] +     [[<plotname>] layout + grid|row|column|strip] +     [[<plotname>] layout strip scale + <percent>] +     [[<plotname>] add graph + line|bar|scatter] +     [[<plotname>] select graph + <graph>] +     [[<plotname>] delete graph] +     [[<plotname>] select dataset + <dataset>] +     [[<plotname>] delete dataset] +     [[<plotname>] duplicate] +     [[<plotname>] stats yes|no] +     [[<plotname>] list yes|no] +     [[<plotname>] loadconfig + <filename>] +     [[<plotname>] saveconfig + <filename>] +     [[<plotname>] pagesetup orient + portrait|landscape] +     [[<plotname>] pagesetup size + letter|legal|tabloid|poster|a4] +     [[<plotname>] print] +     [[<plotname>] print destination + printer|file] +     [[<plotname>] print command + <command>] +     [[<plotname>] print filename + <filename>] +     [[<plotname>] print color rgb|gray] +     [[<plotname>] close] +     [[<plotname>] mode pointer|zoom] + + # export image + plot [[<plotname>] export <filename>] +     [[<plotname>] export gif|tiff|jpeg|png + <filename>] +     [[<plotname>] export jpeg + <filename> [1-100]] +     [[<plotname>] export tiff + <filename> none|jpeg|packbits|deflate]] + + # configure graph + plot [[<plotname>] axis x|y grid yes|no] +     [[<plotname>] axis x|y log yes|no] +     [[<plotname>] axis x|y flip yes|no] +     [[<plotname>] axis x|y auto yes|no] +     [[<plotname>] axis x|y min + <value>] +     [[<plotname>] axis x|y max + <value>] +     [[<plotname>] axis x|y format + <string>] +     [[<plotname>] background <value>] +     [[<plotname>] legend yes|no] +     [[<plotname>] legend position + right|left|top|bottom|plotarea] +     [[<plotname>] font title|labels|numbers + font times|helvetica|courier] +     [[<plotname>] font title|labels|numbers + size <value>] +     [[<plotname>] font title|labels|numbers + weight normal|bold] +     [[<plotname>] font title|labels|numbers + slant roman|italic] +     [[<plotname>] title <string>] +     [[<plotname>] title x|y <string>] +     [[<plotname>] barmode + normal|stacked|aligned|overlap] + + # configure current dataset + plot [[<plotname>] show yes|no] +     [[<plotname>] shape + none|circle|square|diamond|plus|splus|scross|triangle|arrow] +     [[<plotname>] shape fill yes|no] +     [[<plotname>] shape color + <value>] +     [[<plotname>] smooth + step|linear|cubic|quadratic|catrom] +     [[<plotname>] color <value>] +     [[<plotname>] width <value>] +     [[<plotname>] dash yes|no] +     [[<plotname>] error yes|no] +     [[<plotname>] error color + <value>] +     [[<plotname>] error cap yes|no] +     [[<plotname>] error width + <value>] +     [[<plotname>] name <string>] + + Example: + # return all plotnames + string value = ds9.get(string cmd) + plot + + # create new empty plot window + ds9.set(string cmd) + plot + plot bar + plot new + plot new bar + plot new name foo + plot new name foo bar + + # existing plot + string value = ds9.get(string cmd) + plot select layout + plot select layout strip scale + plot select graph + plot select dataset + plot stats + plot list + + ds9.set(string cmd) + plot load foo.dat xy + plot save foo.dat + plot layout strip + plot layout strip scale 30 + plot add graph scatter + plot select graph 1 + plot delete graph + plot select dataset 1 + plot delete dataset + plot duplicate + plot stats yes + plot list yes + plot loadconfig foo.plt + plot saveconfig foo.plt + plot pagesetup orient portrait + plot pagesetup size letter + plot print + plot print destination file + plot print command lp + plot print filename foo.ps + plot print color rgb + plot close + + # plot mode + string value = ds9.get(string cmd) + plot mode + + ds9.set(string cmd) + plot mode pointer + + # export plot + ds9.set(string cmd) + plot export tiff foo.tiff jpeg + plot export jpeg foo.jpeg 75 + plot export png foo.png + + # configure plot + string value = ds9.get(string cmd) + plot axis x grid + plot axis x log + plot axis x flip + plot axis x auto + plot axis x min + plot axis x max + plot axis x format + plot background + plot legend + plot legend position + plot font numbers font + plot font numbers size + plot font numbers weight + plot font numbers slant + plot title + plot title x + + ds9.set(string cmd) + plot axis x grid yes + plot axis x log yes + plot axis x flip yes + plot axis x auto no + plot axis x min 0 + plot axis x max 100 + plot axis x format "%f" + plot background white + plot legend yes + plot legend position left + plot font numbers font times + plot font numbers size 12 + plot font numbers weight bold + plot font numbers slant italic + plot title "This is a Title" + plot title x "X Axis" + plot title y "Y Axis" + plot title legend "This is the Legend" + + # bar plot + string value = ds9.get(string cmd) + plot barmode + + ds9.set(string cmd) + plot barmode aligned + + # configure current dataset + string value = ds9.get(string cmd) + plot show + plot shape + plot shape fill + plot shape color + plot smooth + plot color + plot width + plot dash + plot error + plot error color + plot error cap + plot error width + plot name + + ds9.set(string cmd) + plot show yes + plot shape circle + plot shape fill no + plot shape color cyan + plot smooth step + plot color red + plot width 2 + plot dash yes + plot error yes + plot error color red + plot error cap yes + plot error width 2 + plot name "My Data" + + png + Load PNG image into current frame. + Syntax: + png [new|slice] [<filename>] + + Example: + string value = ds9.get(string cmd) + png + + ds9.set(string cmd) + png foo.png + png new foo.png + png slice foo.png + precision + Set region and coordinate output format precision. + Syntax: + precision +<linear><degree><hms><dms><arcmin><arcsec> + + Example: + string value = ds9.get(string cmd) + precision + + ds9.set(string cmd) + precision 8 10 4 3 5 3 + + prefs + Controls various preference settings. + Syntax: + prefs [clear] +     [irafalign yes|no] + + Example: + string value = ds9.get(string cmd) + prefs irafalign + + ds9.set(string cmd) + prefs clear + prefs irafalign + + preserve + Preserve the follow attributes while loading a new image. + Syntax: + preserve [pan yes|no] +    [regions yes|no] + + Example: + string value = ds9.get(string cmd) + preserve pan + preserve regions + + ds9.set(string cmd) + preserve pan yes + preserve regions yes + + psprint + Invokes postscript printing. Please see print + for further details. + print + Controls printing. Use print option to set printing options. + Syntax: + print [destination printer|file] +     [command <command>] +     [filename <filename>] +     [color rgb|cmyk|gray] +     [level 1|2|3] +     + [resolution72|screen|96|144|150|225|300|600|1200] + + Example: + string value = ds9.get(string cmd) + print destination + print command + print filename + print color + print level + print resolution + + ds9.set(string cmd) + print + print destination file + print command lp + print filename foo.ps + print color cmyk + print level 2 + print resolution 96 + raise + Raise 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 [close]] +     [epsilon <integer>] +     [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 invert] +     [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>] +     [fixed|edit|rotate|delete yes|no] +     [include|exclude|source|background] +     [command <marker command>] +     [composite] +     [dissolve] +     [template <filename>] +     [template <filename> at <ra> + <dec> <coordsys> <skyframe>] +     [savetemplate <filename>] +     [groups] +     [group new] +     [group <tag> new] +     [group <tag> update] +     [group <tag> select] +     [group <tag> color <color>] +     [group <tag> copy] +     [group <tag> delete] +     [group <tag> cut] +     [group <tag> font <font>] +     [group <tag> move <int> + <int>] +     [group <tag> movefront] +     [group <tag> moveback] +     [group <tag> property <property> + yes|no] +     [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] +     [-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 epsilon + regions show + regions showtext + regions centroid + regions centroid auto + regions centroid radius + regions centroid iteration + regions selected + regions format + regions system + regions sky + regions skyformat + regions strip + regions shape + regions color + regions width + regions source + regions background + regions include + regions exclude + regions selected + regions groups + + ds9.set(string cmd) + regions foo.reg + regions -format ciao bar.reg # load as ciao format + regions foo.fits # FITS regions files do not need a format + specification + 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 list close + regions epsilon 5 + regions show yes + regions showtext no + regions centroid + regions centroid auto yes + regions centroid radius 10 + regions centroid iteration 20 + regions getinfo + regions move back + regions move front + regions select all + regions select none + regions select invert + regions delete all + regions delete select + regions format ds9 + regions system wcs + regions sky fk5 + regions skyformat degrees + regions strip yes + regions shape ellipse + regions color red + regions width 3 + regions edit yes + regions include + regions command "circle 100 100 20 # color=red" + 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 new + regions group foo new + regions group foo update + regions group foo select + 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 copy + regions cut + regions paste wcs + regions undo + + restore + Restore DS9 to a previous state from a backup save set. + Syntax: + restore <filename> + + Example: + restore ds9.bck + 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 + wcs|crop|slice|bin|scale|scalelimits|colorbar|block|smooth + [yes|no]] +     [open|close] + + Example: + string value = ds9.get(string cmd) + rgb channel + rgb lock wcs + rgb lock crop + rgb lock slice + rgb lock bin + rgb lock scale + rgb lock scalelimits + rgb lock colorbar + rgb lock block + rgb lock smooth + 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 wcs yes + rgb lock crop yes + rgb lock slice yes + rgb lock bin yes + rgb lock scale yes + rgb lock scalelimits yes + rgb lock colorbar yes + rgb lock block yes + rgb lock smooth yes + rgb open + rgb close + rgbarray + Load raw data array cube into rgb frame. + + Syntax: + rgbarray [native|big|little] + rgbarray [new] +[[xdim=<x>,ydim=<y>|dim=<dim>],[zdim=3],bitpix=<b>,skip=<s>,endian=[little|big]] + + Example: + string value = ds9.get(string cmd) + rgbarray + + ds9.set(string cmd) + rgbarray foo.arr[dim=512,zdim=3,bitpix=-32,endian=little] + rgbarray new foo.arr[dim=512,zdim=3,bitpix=-32,endian=little] + rgbcube + Load FITS rgbcube into rgb frame. + + Syntax: + rgbcube [new] [<filename>] + + Example: + string value = ds9.get(string cmd) + rgbcube + + ds9.set(string cmd) + rgbcube foo.fits + rgbcube new foo.fits + rgbimage + Load FITS rgbimage into rgb frame. + + Syntax: + rgbimage [new] [<filename>] + + Example: + string value = ds9.get(string cmd) + rgbimage + + ds9.set(string cmd) + rgbimage foo.fits + rgbimage new foo.fits + + rotate + Controls the rotation angle (in degrees) of the current frame. + Syntax: + rotate [<value>] +     [to <value>] +     [open|close] + + Example: + string value = ds9.get(string cmd) + rotate + + ds9.set(string cmd) + rotate 45 + rotate to 30 + rotate open + rotate close + samp + Configure SAMP protocol. + Syntax: + samp [no|disconnect] +     [broadcast [image|table]] +     [send [image|table] <application>] + + Example: + + ds9.set(string cmd) + samp no + samp disconnect + samp broadcast image + samp send image aladin + save + + Save loaded image data of current frame as FITS. + Syntax: + save[fits|rgbimage|rgbcube|mecube|mosaic|mosaicimage] + <filename> [image|table|slice] + + Example: + ds9.set(string cmd) + save foo.fits + save fits foo.fits image + save fits foo.fits table + save fits foo.fits slice + save rgbimage foo.fits + save rgbcube foo.fits + save mecube foo.fits + save mosaic foo.fits + save mosaicimage foo.fits + saveimage + Create a snap shot of the current DS9 window and save in + specified image format. If no format specified, the file name + extension is used to determine the output format. Optional + parameters: jpeg quality (1-100) and tiff + compression method. + Syntax: + saveimage[fits|eps|gif|tiff|jpeg|png]<filename> + saveimage <filename>.jpeg [1-100] + saveimage <filename>.tiff [none|jpeg|packbits|deflate] + + Example: + ds9.set(string cmd) + saveimage ds9.tiff + saveimage jpeg ds9.jpeg 75 + scale + Controls the limits and color scale distribution. + Syntax: + scale [linear|log|pow|sqrt|squared|asinh|sinh|histequ] +     [log exp <value>] +     [datasec yes|no] +     [limits <minvalue> <maxvalue>] +     [mode minmax|<value>|zscale|zmax] +     [scope local|global] +     [match] +     [match limits] +     [lock [yes|no]] +     [lock limits [yes|no]] +     [open|close] + + Example: + string value = ds9.get(string cmd) + scale + scale log exp + scale datasec + scale limits + scale mode + scale scope + scale lock + scale lock limits + + ds9.set(string cmd) + scale linear + scale log exp 100 + scale datasec yes + scale histequ + scale limits 1 100 + scale mode zscale + scale mode 99.5 + scale scope local + scale match + scale match limits + scale lock yes + scale lock limits yes + scale open + 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>]] +     [mosaicimage [iraf|wcs|wcsa...wcsz|wfpc2] + [key|shmid] <id> [<filename>]] +     [mosaic [iraf|wcs|wcsa...wcsz] [key|shmid] + <id> [<filename>]] +     [rgbcube [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>]] + + 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 mosaicimage iraf key 100 foo + shm mosaicimage wcs key 100 foo + shm mosaicimage wcsa key 100 foo + shm mosaicimage wfpc2 key 100 foo + shm mosaic iraf key 100 foo + shm mosaic wcs key 100 foo + shm rgbcube key 100 foo + shm rgbimage key 100 foo + shm rgbarray key 100 [dim=200,zdim=3,bitpix=-32] + shm array shmid 102 [dim=32,bitpix=-32] + + sia + + Support for VO Simple Image Access protocol. The first command + will create a new search. All other commands operated on the + last search created, unless indicated otherwise. + Syntax: sia[2mass|akari|astrowise|cadc|cxc|hla|mast|sdss|skyview|tgssadr] -    [<ref>] [cancel] -    [<ref>] [clear] -    [<ref>] [close] -    [<ref>] [coordinate <ra> <dec> <coordsys>] -    [<ref>] [crosshair] -    [<ref>] [export sb|tsv <filename>] -    [<ref>] [name <object>] -    [<ref>] [print] -    [<ref>] [retrieve] -    [<ref>] [save <filename>] -    [<ref>] [radius <value> degrees|arcmin|arcsec] -    [<ref>] [sky <skyframe>] -    [<ref>] [skyformat <skyformat>] -    [<ref>] [system <coordsys>] -    [<ref>] [update] - -Example: -string value = ds9.get(string cmd) -sia - -ds9.set(string cmd) -sia2mass -siacancel -siaclear -siaclose -siacoordinate 202.48 47.21 fk5 -siacrosshair -siaexport tsv bar.tsv -sianame m51 -siaprint -siaretrieve -siasave foo.xml -siaradius 1degrees -siasky fk5 -sia skyformat degrees -siasystem wcs -siaupdate - 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>|clear] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [pixels <width> <height>] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [survey <survey>] -    [open|close] - -Example: -string value = ds9.get(string cmd) -skyview name -skyview coord -skyview size -skyview pixels -skyview save -skyview frame -skyview survey - -ds9.set(string cmd) -skyview -skyview m31 -skyview name m31 -skyview name clear -skyview 00:42:44.404 +41:16:08.78 -skyview size 60 60 arcmin -skyview pixels 600 600 -skyview save yes -skyview frame current -skyview update frame -skyview survey sdssi -skyview open -skyview close -sleep -Delays execution for specified number of seconds. Default is 1 second. -Syntax: -sleep [#] - -Example: -ds9.set(string cmd) -sleep -sleep 2 -smooth -Smooth current image or set smooth parameters. -Boxcar width =2*radius+1 -Tophat diameter =2*radius+1 -Gaussian diameter =2*radius+1,mean=0 -Elliptical Gaussian diameter =2*radius+1,mean=0Syntax: -smooth [] -    [yes|no] -    [function boxcar|tophat|gaussian] -    [radius <value>] -    [radiusminor <value>] -    [sigma <value>] -    [sigmaminor <value>] -    [angle <value>] -    [match] -    [lock [yes|no]] -    [open|close] - -Example: -string value = ds9.get(string cmd) -smooth -smooth function -smooth radius -smooth radiusminor -smooth sigma -smooth sigmaminor -smooth angle -smooth lock - -ds9.set(string cmd) -smooth -smooth yes -smooth function tophat -smooth radius 4 -smooth radiusminor 4 -smooth sigma 2.0 -smooth sigmaminor 2.0 -smooth angle 45 -smooth match -smooth lock yes -smooth open -smooth close -source -Source TCL code from a file. -Syntax: -source [filename] - -Example: -ds9.set(string cmd) -source foo.tcl -tcl -Execute one TCL command. -Syntax: -tcl <tcl command> - -Example: -ds9.set(string cmd) -tcl {puts {Hello, World}} -threads -Set number of process threads for functions which are multi-threaded. -Syntax: -threads # - -Example: -string value = ds9.get(string cmd) -threads -ds9.set(string cmd) -threads 8 -tiff -Load TIFF image into current frame. Optional parameters: tiff compression method. -Syntax: -tiff [new|slice] [<filename>] [none|jpeg|packbits|deflate] - -Example: -string value = ds9.get(string cmd) -tiff -tiff jpeg - -ds9.set(string cmd) -tiff foo.tiff -tiff new foo.tiff -tiff slice foo.tiff -tile -Controls the tile display mode. -Syntax: -tile [] -    [yes|no] -    [mode grid|column|row] -    [grid] -    [grid mode automatic|manual] -    [grid direction x|y] -    [grid layout <col> <row>] -    [grid gap <pixels>] -    [row] -    [column] - -Example: -string value = ds9.get(string cmd) -tile -tile mode -tile grid mode -tile grid direction -tile grid layout -tile grid gap - -ds9.set(string cmd) -tile -tile yes -tile mode row -tile grid -tile grid mode manual -tile grid direction x -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] - -Example: - -ds9.set(string cmd) -update -update 1 100 100 300 400 -update now -update now 1 100 100 300 400 -url -Load FITS from URL into the current frame -Syntax: -url <url> - -Example: -ds9.set(string cmd) -url http://foo.bar.edu/foo.fits -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] -    [keyvalue <string>] -    [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] -    [keyword yes|no] -    [minmax yes|no] -    [lowhigh yes|no] -    [units yes|no] -    [image|physical|wcs|wcsa...wcsz yes|no] -    [frame yes|no] -    [red yes|no] -    [green yes|no] -    [blue yes|no] - -Example: -string value = ds9.get(string cmd) -view layout -view keyvalue -view info -view panner -view magnifier -view buttons -view colorbar -view graph horizontal -view filename -view object -view keyword -view minmax -view lowhigh -view units -view image -view wcsa -view red -view frame - -ds9.set(string cmd) -view layout vertical -view keyvalue BITPIX -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 keyword yes -view minmax yes -view lowhigh yes -view units yes -view wcsa yes -view frame yes -view red yes -view green yes -view blue yes -vla -Support for VLA Sky Survey. -Syntax: -vla [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [survey first|stripe82] -    [open|close] - -Example: -string value = ds9.get(string cmd) -vla name -vla coord -vla size -vla save -vla frame -vla survey - -ds9.set(string cmd) -vla -vla m31 -vla name m31 -vla name clear -vla 00:42:44.404 +41:16:08.78 -vla size 60 60 arcmin -vla save yes -vla frame current -vla update frame -vla survey stripe82 -vla open -vla close -vlss -Support for NRAO VLSS Sky Survey. -Syntax: -vlss [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [open|close] - -Example: -string value = ds9.get(string cmd) -vlss name -vlss coord -vlss size -vlss save -vlss frame - -ds9.set(string cmd) -vlss -vlss m31 -vlss name m31 -vlss name clear -vlss 00:42:44.404 +41:16:08.78 -vlss size 60 60 arcmin -vlss save yes -vlss frame current -vlss update frame -vlss open -vlss close -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: -string value = ds9.get(string cmd) -vo -vo method -vo server -vo internal -vo delay -vo connect - -ds9.set(string cmd) -vo method xpa -vo server "http://foo.bar.edu/list.txt" -vo internal yes -vo delay 15 -vo chandra-ed -vo connect chandra-ed -vo disconnect chandra-ed -vo open -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 [[system] wcs|wcsa...wcsz] -    [[sky] fk4|fk5|icrs|galactic|ecliptic] -    [[skyformat] degrees|sexagesimal] -    [align yes|no] -    [reset [#]] -    [replace [#] <filename>] -    [append [#] <filename>] -    [open|close] - -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 fk5 -wcs sky fk5 -wcs sexagesimal -wcs skyformat sexagesimal -wcs align yes -wcs reset -wcs reset 3 -wcs replace foo.wcs -wcs replace 3 foo.wcs -wcs append foo.wcs -wcs append 3 foo.wcs -wcs open -wcs close -web -Display specified URL in the web display. -Syntax: -web [] -    [<url>] -    [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>] -    [in] -    [out] -    [to fit] -    [open|close] - -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 in -zoom out -zoom to fit -zoom open -zoom close - +     [<ref>] [cancel] +     [<ref>] [clear] +     [<ref>] [close] +     [<ref>] [coordinate <ra> + <dec> <coordsys>] +     [<ref>] [crosshair] +     [<ref>] [export sb|tsv + <filename>] +     [<ref>] [name <object>] +     [<ref>] [print] +     [<ref>] [retrieve] +     [<ref>] [save <filename>] +     [<ref>] [radius <value> + degrees|arcmin|arcsec] +     [<ref>] [sky <skyframe>] +     [<ref>] [skyformat <skyformat>] +     [<ref>] [system <coordsys>] +     [<ref>] [update] + + Example: + string value = ds9.get(string cmd) + sia + + ds9.set(string cmd) + sia2mass + siacancel + siaclear + siaclose + siacoordinate 202.48 47.21 fk5 + siacrosshair + siaexport tsv bar.tsv + sianame m51 + siaprint + siaretrieve + siasave foo.xml + siaradius 1degrees + siasky fk5 + sia skyformat degrees + siasystem wcs + siaupdate + + 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>|clear] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [pixels <width> <height>] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [survey <survey>] +     [open|close] + + Example: + string value = ds9.get(string cmd) + skyview name + skyview coord + skyview size + skyview pixels + skyview save + skyview frame + skyview survey + + ds9.set(string cmd) + skyview + skyview m31 + skyview name m31 + skyview name clear + skyview 00:42:44.404 +41:16:08.78 + skyview size 60 60 arcmin + skyview pixels 600 600 + skyview save yes + skyview frame current + skyview update frame + skyview survey sdssi + skyview open + skyview close + +
sleep
+
Delays execution for specified number of seconds. Default is 1 + second.
+ Syntax: + sleep [#] + + Example: + ds9.set(string cmd) + sleep + sleep 2 + +
smooth
+
Smooth current image or set smooth parameters.
+
Boxcar width =2*radius+1 + Tophat diameter =2*radius+1 + Gaussian diameter =2*radius+1,mean=0 + Elliptical Gaussian diameter =2*radius+1,mean=0Syntax: +
+ smooth [] +     [yes|no] +     [function boxcar|tophat|gaussian] +     [radius <value>] +     [radiusminor <value>] +     [sigma <value>] +     [sigmaminor <value>] +     [angle <value>] +     [match] +     [lock [yes|no]] +     [open|close] + + Example: + string value = ds9.get(string cmd) + smooth + smooth function + smooth radius + smooth radiusminor + smooth sigma + smooth sigmaminor + smooth angle + smooth lock + + ds9.set(string cmd) + smooth + smooth yes + smooth function tophat + smooth radius 4 + smooth radiusminor 4 + smooth sigma 2.0 + smooth sigmaminor 2.0 + smooth angle 45 + smooth match + smooth lock yes + smooth open + smooth close + +
source
+
Source TCL code from a file.
+ Syntax: + source [filename] + + Example: + ds9.set(string cmd) + source foo.tcl
+
tcl
+
Execute one TCL command.
+
+ Syntax: + tcl <tcl command> + + Example: + ds9.set(string cmd) + tcl {puts {Hello, World}} + +
threads
+
Set number of process threads for functions which are + multi-threaded.
+ Syntax: + threads # + + Example: + string value = ds9.get(string cmd) + threads + ds9.set(string cmd) + threads 8
+
tiff
+
Load TIFF image into current frame. Optional parameters: tiff + compression method.
+ Syntax: + tiff [new|slice] [<filename>] [none|jpeg|packbits|deflate] + + Example: + string value = ds9.get(string cmd) + tiff + tiff jpeg + + ds9.set(string cmd) + tiff foo.tiff + tiff new foo.tiff + tiff slice foo.tiff
+
tile
+
Controls the tile display mode.
+ Syntax: + tile [] +     [yes|no] +     [mode grid|column|row] +     [grid] +     [grid mode automatic|manual] +     [grid direction x|y] +     [grid layout <col> <row>] +     [grid gap <pixels>] +     [row] +     [column] + + Example: + string value = ds9.get(string cmd) + tile + tile mode + tile grid mode + tile grid direction + tile grid layout + tile grid gap + + ds9.set(string cmd) + tile + tile yes + tile mode row + tile grid + tile grid mode manual + tile grid direction x + 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] + + Example: + + ds9.set(string cmd) + update + update 1 100 100 300 400 + update now + update now 1 100 100 300 400
+
url
+
Load FITS from URL into the current frame
+ Syntax: + url <url> + + Example: + ds9.set(string cmd) + url http://foo.bar.edu/foo.fits +
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] +     [keyvalue <string>] +     [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] +     [keyword yes|no] +     [minmax yes|no] +     [lowhigh yes|no] +     [units yes|no] +     [image|physical|wcs|wcsa...wcsz yes|no] +     [frame yes|no] +     [red yes|no] +     [green yes|no] +     [blue yes|no] + + Example: + string value = ds9.get(string cmd) + view layout + view keyvalue + view info + view panner + view magnifier + view buttons + view colorbar + view graph horizontal + view filename + view object + view keyword + view minmax + view lowhigh + view units + view image + view wcsa + view red + view frame + + ds9.set(string cmd) + view layout vertical + view keyvalue BITPIX + 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 keyword yes + view minmax yes + view lowhigh yes + view units yes + view wcsa yes + view frame yes + view red yes + view green yes + view blue yes
+
vla
+
Support for VLA Sky Survey.
+ Syntax: + vla [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [survey first|stripe82] +     [open|close] + + Example: + string value = ds9.get(string cmd) + vla name + vla coord + vla size + vla save + vla frame + vla survey + + ds9.set(string cmd) + vla + vla m31 + vla name m31 + vla name clear + vla 00:42:44.404 +41:16:08.78 + vla size 60 60 arcmin + vla save yes + vla frame current + vla update frame + vla survey stripe82 + vla open + vla close + +
vlss
+
Support for NRAO VLSS Sky Survey.
+ Syntax: + vlss [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [open|close] + + Example: + string value = ds9.get(string cmd) + vlss name + vlss coord + vlss size + vlss save + vlss frame + + ds9.set(string cmd) + vlss + vlss m31 + vlss name m31 + vlss name clear + vlss 00:42:44.404 +41:16:08.78 + vlss size 60 60 arcmin + vlss save yes + vlss frame current + vlss update frame + vlss open + vlss close
+
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: + string value = ds9.get(string cmd) + vo + vo method + vo server + vo internal + vo delay + vo connect + + ds9.set(string cmd) + vo method xpa + vo server "http://foo.bar.edu/list.txt" + vo internal yes + vo delay 15 + vo chandra-ed + vo connect chandra-ed + vo disconnect chandra-ed + vo open + 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 [[system] wcs|wcsa...wcsz] +     [[sky] fk4|fk5|icrs|galactic|ecliptic] +     [[skyformat] degrees|sexagesimal] +     [align yes|no] +     [reset [#]] +     [replace [#] <filename>] +     [append [#] <filename>] +     [open|close] + + 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 fk5 + wcs sky fk5 + wcs sexagesimal + wcs skyformat sexagesimal + wcs align yes + wcs reset + wcs reset 3 + wcs replace foo.wcs + wcs replace 3 foo.wcs + wcs append foo.wcs + wcs append 3 foo.wcs + wcs open + wcs close + +
web
+
Display specified URL in the web display.
+ Syntax: + web [] +     [<url>] +     [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>] +     [in] +     [out] +     [to fit] +     [open|close] + + 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 in + zoom out + zoom to fit + zoom open + zoom close +

+ diff --git a/ds9/doc/ref/xpa.html b/ds9/doc/ref/xpa.html index 8a074df..7a726cd 100644 --- a/ds9/doc/ref/xpa.html +++ b/ds9/doc/ref/xpa.html @@ -1,2846 +1,3162 @@ - - - - -XPA Access Points - - -

XPA Access Points

-
The XPA messaging system provides seamless communication between DS9 and other Unix programs, including X programs. 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 -3d -about -align -analysis -array -background -backup -bin -blink -block -catalog -cd -cmap -colorbar -console -contour -crop -crosshair -cube -cursor -data -dsssao -dsseso -dssstsci -envi -exit -export -file -fits -frame -gif -grid -header -height -iconify -iexam -iis -jpeg -lock -lower -magnifier -mask -match -mecube -minmax -mode -mosaic -mosaicimage -movie -multiframe -nameserver -nrrd -nvss -orient -pagesetup -pan -pixeltable -plot -png -precision -prefs -preserve -psprint -print -quit -raise -regions -restore -rgb -rgbarray -rgbcube -rgbimage -rotate -save -saveimage -scale -shm -sia -single -skyview -sleep -smooth -source -tcl -threads -tile -update -url -version -view -vla -vlss -vo -wcs -web -width -xpa -zscale -zoom -
2mass
-
Support for 2MASS Digital Sky Survey.
-Syntax: -2mass [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # 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 -$xpaset -p ds9 2mass m31 -$xpaset -p ds9 2mass name m31 -$xpaset -p ds9 2mass name clear -$xpaset -p ds9 2mass 00:42:44.404 +41:16:08.78 -$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
-
3d
-
Support for 3D frame.
-Syntax: -3d [] -    [view <az> <el>] -    [az <az>] -    [el <el>] -    [scale <scale>] -    [method mip|aip] -    [background none|azimuth|elevation] -    [border yes|no] -    [border color <color>] -    [highlite yes|no] -    [highlite color <color>] -    [compass yes|no] -    [compass color <color>] -    [match] -    [lock [yes|no]] -    [open|close] - -Example: -$xpaget ds9 3d view -$xpaget ds9 3d az -$xpaget ds9 3d el -$xpaget ds9 3d scale -$xpaget ds9 3d method -$xpaget ds9 3d background -$xpaget ds9 3d border -$xpaget ds9 3d border color -$xpaget ds9 3d highlite -$xpaget ds9 3d highlite color -$xpaget ds9 3d compass -$xpaget ds9 3d compass color -$xpaget ds9 3d lock - -$xpaset -p ds9 3d # create new 3D frame -$xpaset -p ds9 3d view 45 30 -$xpaset -p ds9 3d az 45 -$xpaset -p ds9 3d el 30 -$xpaset -p ds9 3d scale 10 -$xpaset -p ds9 3d method mip -$xpaset -p ds9 3d background azimuth -$xpaset -p ds9 3d border yes -$xpaset -p ds9 3d border color red -$xpaset -p ds9 3d highlite yes -$xpaset -p ds9 3d highlite color red -$xpaset -p ds9 3d compass yes -$xpaset -p ds9 3d compass color red -$xpaset -p ds9 3d match -$xpaset -p ds9 3d lock yes -$xpaset -p ds9 3d open -$xpaset -p ds9 3d close
-
about
-
Get DS9 credits.
-Syntax: -about - -Example: -$xpaget ds9 about -
align
-
Controls the World Coordinate System alignment for the current frame.
-Syntax: -align [] -    [yes|no] - -Example: -$xpaget ds9 align - -$xpaset -p ds9 align yes -
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 message okcancel {Hello World} - -$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 {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 into current frame.
-Syntax: -array [native|little|big] -array [new|mask] [[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,endian=[little|big]] - -Example: -$xpaget ds9 array > foo.arr -$xpaget ds9 array little > foo.arr - -$xpaset -p ds9 array foo.arr[dim=512,bitpix=-32,endian=little] -$xpaset -p ds9 array new foo.arr[dim=512,bitpix=-32,endian=little] -$xpaset -p ds9 array mask foo.arr[dim=512,bitpix=-32,endian=little] - -$cat foo.arr | xpaset ds9 array[dim=512,bitpix=-32,endian=little] -$cat foo.arr | xpaset ds9 array new[dim=512,bitpix=-32,endian=little] -$cat foo.arr | xpaset ds9 array mask [dim=512,bitpix=-32,endian=little] -
bg
-background
-
Set image background color.
-Syntax: -bg <color> - -Example: -$xpaget ds9 bg - -$xpaset -p ds9 bg red
-
backup
-
Create a backup save set.
-Syntax: -backup <filename> - -Example: -$xpaset -p ds9 backup ds9.bck
-
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>] -    [filter clear] -    [function average|sum] -    [in] -    [out] -    [to fit] -    [match] -    [lock [yes|no]] -    [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 -$xpaget ds9 bin lock - -$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 clear -$xpaset -p ds9 bin function sum -$xpaset -p ds9 bin in -$xpaset -p ds9 bin out -$xpaset -p ds9 bin to fit -$xpaset -p ds9 bin match -$xpaset -p ds9 bin lock yes -$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
-
block
-
Controls blocking parameters.
-Syntax: -block[<value>] -    [<value> <value>] -    [to <value>] -    [to <value><value>] -    [in] -    [out] -    [to fit] -    [match] -    [lock [yes|no]] -    [open|close] - -Example: -$xpaget ds9 block -$xpaget ds9 block lock - -$xpaset -p ds9 block 4 -$xpaset -p ds9 block 4 2 -$xpaset -p ds9 block to 4 -$xpaset -p ds9 block to 4 2 -$xpaset -p ds9 block in -$xpaset -p ds9block out -$xpaset -p ds9 block to fit -$xpaset -p ds9 block match -$xpaset -p ds9 block lock yes -$xpaset -p ds9 block open -$xpaset -p ds9 block close
-
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 [new] -    [ned|simbad|denis|skybot] -    [aavso|ac|ascss|cmc|gaia|gsc1|gsc2|gsc3|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|sdss9|tycho] -    [ua2|ub1|ucac2|ucac2sup|ucac3|ucac4|urat1] -    [2mass|iras] -    [csc|xmm|rosat] -    [first|nvss] -    [chandralog|cfhtlog|esolog|stlog|xmmlog] -    [cds <catalogname>] -    [cds <catalogid>] - -    [load <filename>] -    [import sb|tsv <filename>] - -    [<ref>] [<ra> <dec> <coordsys>] -    [<ref>] [allcols] -    [<ref>] [allrows] -    [<ref>] [cancel] -    [<ref>] [clear] -    [<ref>] [close] -    [<ref>] [crosshair] -    [<ref>] [dec <col>] -    [<ref>] [edit yes|no] -    [<ref>] [export sb|tsv <filename>] -    [<ref>] [filter <string>] -    [<ref>] [filter load <filename>] -    [<ref>] [header] -    [<ref>] [location <code>] -    [<ref>] [match] -    [<ref>] [match <ref> <ref>] -    [<ref>] [match error <value> degrees|arcmin|arcsec] -    [<ref>] [match function 1and2|1not2|2not1] -    [<ref>] [match return 1and2|1only|2only] -    [<ref>] [match unique yes|no] -    [<ref>] [maxrows <number>] -    [<ref>] [name <object>] -    [<ref>] [panto yes|no] -    [<ref>] [plot <xcol> <ycol> <xerrcol> <yerrcol>] -    [<ref>] [print] -    [<ref>] [psky <skyframe>] -    [<ref>] [psystem <coordsys>] -    [<ref>] [ra <col>] -    [<ref>] [regions] -    [<ref>] [retrieve] -    [<ref>] [samp] -    [<ref>] [samp broadcast] -    [<ref>] [samp send <application>] -    [<ref>] [save <filename>] -    [<ref>] [server cds|adac|cadc|cambridge|sao|ukirt|iucaa|bejing|saao] -    [<ref>] [show yes|no] -    [<ref>] [radius <value> degrees|arcmin|arcsec] -    [<ref>] [sky <skyframe>] -    [<ref>] [skyformat <skyformat>] -    [<ref>] [sort <col> incr|decr] -    [<ref>] [symbol [#] condition|shape|color|text|font|fontsize|fontweight|fontslant <value>] -    [<ref>] [symbol [#] text|size|size2|units|angle <value>] -    [<ref>] [symbol shape circle|ellipse|box|text|point] -    [<ref>] [symbol shapecircle point|box point|diamond point|cross point|x point|arrow point|boxcircle point] -    [<ref>] [symbol add| [#] remove] -    [<ref>] [symbol save|load <filename>] -    [<ref>] [system <coordsys>] -    [<ref>] [update] -    [<ref>] [x <col>] -    [<ref>] [y <col>] - -Example: -$xpaget ds9 catalog -$xpaget ds9 catalog header - -$xpaset -p ds9 catalog new -$xpaset -p ds9 catalog 2mass -$xpaset -p ds9 catalog cds 2mass -$xpaset -p ds9 catalog cds {I/252} - -$xpaset -p ds9 catalog load foo.xml -$xpaset -p ds9 catalog import tsv foo.tsv - -$xpaset -p ds9 catalog 202.48 47.21 fk5 -$xpaset -p ds9 catalog allrows -$xpaset -p ds9 catalog allcols -$xpaset -p ds9 catalog cancel -$xpaset -p ds9 catalog clear -$xpaset -p ds9 catalog close -$xpaset -p ds9 catalog crosshair -$xpaset -p ds9 catalog dec DEC -$xpaset -p ds9 catalog edit yes -$xpaset -p ds9 catalog export tsv bar.tsv -$xpaset -p ds9 catalog filter '$Jmag>10' -$xpaset -p ds9 catalog filter load foo.flt -$xpaset -p ds9 catalog header -$xpaset -p ds9 catalog location 500 -$xpaset -p ds9 catalog match error 2 arcsec -$xpaset -p ds9 catalog match function 1and2 -$xpaset -p ds9 catalog match unique no -$xpaset -p ds9 catalog match return 1only -$xpaset -p ds9 catalog match # last two catalogs loaded -$xpaset -p ds9 catalog match 2mass csc -$xpaset -p ds9 catalog maxrows 2000 -$xpaset -p ds9 catalog name m51 -$xpaset -p ds9 catalog panto no -$xpaset -p ds9 catalog plot '$Jmag' '$Hmag' '$e_Jmag' '$e_Hmag' -$xpaset -p ds9 catalog print -$xpaset -p ds9 catalog psky fk5 -$xpaset -p ds9 catalog psystem wcs -$xpaset -p ds9 catalog ra RA -$xpaset -p ds9 catalog regions -$xpaset -p ds9 catalog retrieve -$xpaset -p ds9 catalog samp broadcast -$xpaset -p ds9 catalog samp send aladin -$xpaset -p ds9 catalog save foo.xml -$xpaset -p ds9 catalog server sao -$xpaset -p ds9 catalog show yes -$xpaset -p ds9 catalog radius 1 degrees -$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 symbol font times -$xpaset -p ds9 catalog symbol fontsize 14 -$xpaset -p ds9 catalog symbol fontweight bold -$xpaset -p ds9 catalog symbol 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 sky fk5 -$xpaset -p ds9 catalog skyformat degrees -$xpaset -p ds9 catalog sort {Jmag} incr -$xpaset -p ds9 catalog system wcs -$xpaset -p ds9 catalog update -$xpaset -p ds9 catalog x RA -$xpaset -p ds9 catalog y DEC
-
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] -    [load <filename>] -    [save <filename>] -    [invert yes|no] -    [<constrast> <bias>] -    [tag [load|save] <filename>] -    [tag delete] -    [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 load foo.sao -$xpaset -p ds9 cmap save bar.sao -$xpaset -p ds9 cmap invert yes -$xpaset -p ds9 cmap 5 .5 -$xpaset -p ds9 cmap tag load foo.tag -$xpaset -p ds9 cmap tag save foo.tag -$xpaset -p ds9 cmap tag delete -$xpaset -p ds9 cmap open -$xpaset -p ds9 cmap close -
colorbar
-
Controls colorbar parameters.
-Syntax: -colorbar [] -    [yes|no] -    [orientation] -    [horizontal|vertical] -    [numerics yes|no] -    [space value|distance] -    [font times|helvetica|courier] -    [fontsize <value>] -    [fontweight normal|bold] -    [fontslant roman|italic] -    [size] -    [ticks] -    [match] -    [lock [yes|no]] -
-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 -$xpaget ds9 colorbar lock - -$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 -$xpaset -p ds9 colorbar match -$xpaset -p ds9 colorbar lock yes -
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>] -    [save <filename> [<coordsys> <skyframe>]] -    [convert] -    [load levels <filename>] -    [save levels <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|asinh|sinh|histequ] -    [log exp <value>] -    [mode minmax|<value>|zscale|zmax] -    [scope global|local] -    [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 scope -$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.ctr -$xpaset -p ds9 contour save ds9.ctr -$xpaset -p ds9 contour save ds9.ctr wcs fk5 -$xpaset -p ds9 contour convert -$xpaset -p ds9 contour load levels ds9.ctr -$xpaset -p ds9 contour save levels ds9.lev -$xpaset -p ds9 contour copy -$xpaset -p ds9 contour paste -$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 scope local -$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
-
crop
-
Set current image display area.
-Syntax: -crop [<x> <y> <width> <height> [<coordsys>][<skyframe>][degrees|arcmin|arcsec] -    [match <coordsys>] -    [lock <coordsys>|none] -    [reset] -    [3d zmin zmax <coordsys>] -    [open|close] - -Example: -$xpaget ds9 crop # get crop in physical coords -$xpaget ds9 crop wcs galactic sexagesimal arcsec -$xpaget ds9 crop lock - -$xpaset -p ds9 crop 40 30 10 20 # set crop in physical coords -$xpaset -p ds9 crop +104:51:06.915 +68:33:40.761 28.144405 22.000204 wcs galactic arcsec -$xpaset -p ds9 crop match wcs -$xpaset -p ds9 crop lock wcs -$xpaset -p ds9 crop reset -$xpaset -p ds9 crop 3d .25 .50 wcs -$xpaset -p ds9 crop open -$xpaset -p ds9 crop 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>]] -    [match <coordsys>] -    [lock <coordsys>|none] - -Example: -$xpaget ds9 crosshair # get crosshair in physical coords -$xpaget ds9 crosshair wcs fk4 sexagesimal # get crosshair in wcs coords -$xpaget ds9 crosshair lock - -$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 -$xpaset -p ds9 crosshair match wcs -$xpaset -p ds9 crosshair lock wcs -
cube
-
Controls FITS cube dialog.
-Syntax: -cube [] -    [play|stop|next|prev|first|last] -    [<slice> [<coordsys>]] -    [interval <numeric>] -    [match <coordsys>] -    [lock <coordsys>|none] -    [order 123|132|213|231|312|321] -    [axes lock [yes|no]] -    [open|close] - -Example: -$xpaget ds9 cube -$xpaget ds9 cube wcs -$xpaget ds9 cube interval -$xpaget ds9 cube lock -$xpaget ds9 cube order -$xpaget ds9 cube axes lock - -$xpaset -p ds9 cube -$xpaset -p ds9 cube play -$xpaset -p ds9 cube last -$xpaset -p ds9 cube 3 -$xpaset -p ds9 cube 4.4 wcs -$xpaset -p ds9 cube interval 2 -$xpaset -p ds9 cube match wcs -$xpaset -p ds9 cube lock wcs -$xpaset -p ds9 cube order 123 -$xpaset -p ds9 cube axes lock yes -$xpaset -p ds9 cube open -$xpaset -p ds9 cube close
-
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> <width> <height> [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 -
dsssao
-dss
-
Support for Digital Sky Survey at SAO.
-Syntax: -dsssao [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # 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 -$xpaset -p ds9 dsssao m31 -$xpaset -p ds9 dsssao name m31 -$xpaset -p ds9 dsssao name clear -$xpaset -p ds9 dsssao 00:42:44.404 +41:16:08.78 -$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>|clear] -    [<ra> <dec>] # 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 -$xpaset -p ds9 dsseso m31 -$xpaset -p ds9 dsseso name m31 -$xpaset -p ds9 dsseso name clear -$xpaset -p ds9 dsseso 00:42:44.404 +41:16:08.78 -$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>|clear] -    [<ra> <dec>] # 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 -$xpaset -p ds9 dssstsci m31 -$xpaset -p ds9 dssstsci name m31 -$xpaset -p ds9 dssstsci name clear -$xpaset -p ds9 dssstsci 00:42:44.404 +41:16:08.78 -$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
-
envi
-
Load an ENVI header and file. Optional parameter: array endian.
-Syntax: envi [new] <header> [<filename>] Example: $xpaset -p ds9 envi foo.hdr $xpaset -p ds9 envi new foo.hdr $xpaset -p ds9 envi foo.hdr foo.bsq
-exit
-
quits
-
Quits DS9.
-Syntax: -exit -quit - -Example: -$xpaset -p ds9 exit -
export
-
Export loaded image data of current frame in specified image format. Optional parameters: array endian, nrrd endian, jpeg quality (1-100) and tiff compression method.
-Syntax: -export[array|nrrd|envi|gif|tiff|jpeg|png]<filename> -export array <filename>[big|little|native] -export nrrd <filename>[big|little|native] -export envi <header> [<filename>][big|little|native] -export jpeg <filename>[1-100] -export tiff <filename>[none|jpeg|packbits|deflate] - -Example: -$xpaset -p ds9 export array foo.arr little -$xpaset -p ds9 export nrrd foo.nrrd little -$xpaset -p ds9 export envi foo.hdr little -$xpaset -p ds9 export envi foo.hdr foo.bsq little -$xpaset -p ds9 export tiff foo.tiff jpeg -$xpaset -p ds9 export jpeg foo.jpeg 75 -$xpaset -p ds9 export png foo.png
-
file
-
Query currently loaded file information.
-Syntax: -file - -Example: -$xpaget ds9 file
-
fits
-
Load a FITS image into the current frame or query the currently loaded image.
-Syntax: -fits[new|mask|slice] [<filename>] -    [width|height|depth|bitpix] -    [size [wcs|wcsa...wcsz] [fk4|fk5|icrs|galactic|ecliptic] [degrees|arcmin|arcsecs]] -    [header [<ext>] [keyword <string>]] -    [image|table|slice] - -Example: -$xpaget ds9 fits > foo.fits -$xpaget ds9 fits width -$xpaget ds9 fits height -$xpaget ds9 fits depth -$xpaget ds9 fits bitpix -$xpaget ds9 fits size -$xpaget ds9 fits size wcs fk5 arcmin -$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 table > bar.fits -$xpaget ds9 fits slice > foo.fits - -$xpaset -p ds9 fits foo.fits -$xpaset -p ds9 fits new foo.fits -$xpaset -p ds9 fits bar.fits[bin=detx,dety] -$xpaset -p ds9 fits slice foo.fits -$xpaset -p ds9 fits mask foo.fits - -$cat foo.fits | xpaset ds9 fits -$cat foo.fits | xpaset ds9 fits new -$cat bar.fits | xpaset ds9 fits -[bin=detx,dety] -$cat foo.fits | xpaset ds9 fits slice -$cat foo.fits | xpaset ds9 fits mask -
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|3d]] -    [delete [#|all]] -    [reset [#|all]] -    [refresh [#|all]] -    [hide [#|all]] -    [show [#|all]] -    [move first] -    [move back] -    [move forward] -    [move last] -    [first] -    [prev] -    [next] -    [last] -    [frameno #] -    [#] -    [match <coordsys>] -    [lock <coordsys>|none] -    [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>]] -    [has wcs celestial [<wcssys>]] -    [has wcs 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 lock -$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 celestial 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 -$xpaset -p ds9 frame match wcs -$xpaset -p ds9 frame lock wcs -
gif
-
Load GIF image into current frame.
-Syntax: -gif [new|slice] [<filename>] - -Example: -$xpaget ds9 gif > foo.gif - -$xpaset -p ds9 gif foo.gif -$xpaset -p ds9 gif new foo.gif -$xpaset -p ds9 gif slice foo.gif - -$cat foo.gif | xpaset ds9 gif # not available windows -$cat foo.gif | xpaset ds9 gifnew # not available windows -$cat foo.gif | xpaset ds9 gifslice# not available windows -
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 dash yes|no] -    [grid gap1 <value>] -    [grid gap2 <value>] -    [grid gap3 <value>] -    [axes yes|no] -    [axes color <color>] -    [axes width <value>] -    [axes dash yes|no] -    [axes type interior|exterior] -    [axes origin lll|llu|lul|luu|ull|ulu|uul|uuu] -    [format1 <format>] -    [format2 <format>] -    [tickmarks yes|no] -    [tickmarks color <color>] -    [tickmarks width <value>] -    [tickmarks dash yes|no] -    [border yes|no] -    [border color <color>] -    [border width <value>] -    [border dash yes|no] -    [numerics yes|no] -    [numerics font times|helvetica|courier] -    [numerics fontsize <value>] -    [numerics fontweight normal|bold] -    [numerics fontslant roman|italic] -    [numerics color <color>] -    [numerics gap1 <value>] -    [numerics gap2 <value>] -    [numerics gap3 <value>] -    [numerics type interior|exterior] -    [numerics 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>] -    [labels yes|no] -    [labels def1 yes|no] -    [labels def2 yes|no] -    [labels text1 <text>] -    [labels text2 <text>] -    [labels gap1 <value>] -    [labels gap2 <value>] -    [labels font times|helvetica|courier] -    [labels fontsize <value>] -    [labels fontweight normal|bold] -    [labels fontslant roman|italic] -    [labels 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 dash -$xpaget ds9 grid grid gap1 -$xpaget ds9 grid grid gap2 -$xpaget ds9 grid grid gap3 -$xpaget ds9 grid axes -$xpaget ds9 grid axes color -$xpaget ds9 grid axes width -$xpaget ds9 grid axes dash -$xpaget ds9 grid axes type -$xpaget ds9 grid axes origin -$xpaget ds9 grid format1 -$xpaget ds9 grid format2 -$xpaget ds9 grid tickmarks -$xpaget ds9 grid tickmarks color -$xpaget ds9 grid tickmarks width -$xpaget ds9 grid tickmarks dash -$xpaget ds9 grid border -$xpaget ds9 grid border color -$xpaget ds9 grid border width -$xpaget ds9 grid border dash -$xpaget ds9 grid numerics -$xpaget ds9 grid numerics font -$xpaget ds9 grid numerics fontsize -$xpaget ds9 grid numerics fontweight -$xpaget ds9 grid numerics fontslant -$xpaget ds9 grid numerics color -$xpaget ds9 grid numerics gap1 -$xpaget ds9 grid numerics gap2 -$xpaget ds9 grid numerics gap3 -$xpaget ds9 grid numerics type -$xpaget ds9 grid numerics 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 labels -$xpaget ds9 grid labels text1 -$xpaget ds9 grid labels def1 -$xpaget ds9 grid labels gap1 -$xpaget ds9 grid labels text2 -$xpaget ds9 grid labels def2 -$xpaget ds9 grid labels gap2 -$xpaget ds9 grid labels font -$xpaget ds9 grid labels fontsize -$xpaget ds9 grid labels fontweight -$xpaget ds9 grid labels fontslant -$xpaget ds9 grid labels 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 dash yes -$xpaset -p ds9 grid grid gap1 10 -$xpaset -p ds9 grid grid gap2 10 -$xpaset -p ds9 grid grid gap3 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 dash yes -$xpaset -p ds9 grid axes type exterior -$xpaset -p ds9 grid axes origin lll -$xpaset -p ds9 grid format1 d.2 -$xpaset -p ds9 grid format2 d.2 -$xpaset -p ds9 grid tickmarks yes -$xpaset -p ds9 grid tickmarks color red -$xpaset -p ds9 grid tickmarks width 2 -$xpaset -p ds9 grid tickmarks dash yes -$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 dash yes -$xpaset -p ds9 grid numerics yes -$xpaset -p ds9 grid numerics font courier -$xpaset -p ds9 grid numerics fontsize 12 -$xpaset -p ds9 grid numerics fontweight bold -$xpaset -p ds9 grid numerics fontslant italic -$xpaset -p ds9 grid numerics color red -$xpaset -p ds9 grid numerics gap1 10 -$xpaset -p ds9 grid numerics gap2 10 -$xpaset -p ds9 grid numerics gap3 10 -$xpaset -p ds9 grid numerics type exterior -$xpaset -p ds9 grid numerics 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 labels yes -$xpaset -p ds9 grid labels text1 {Hello World} -$xpaset -p ds9 grid labels def1 yes -$xpaset -p ds9 grid labels gap1 10 -$xpaset -p ds9 grid labels text2 {Hello World} -$xpaset -p ds9 grid labels def2 yes -$xpaset -p ds9 grid labels gap2 10 -$xpaset -p ds9 grid labels font courier -$xpaset -p ds9 grid labels fontsize 12 -$xpaset -p ds9 grid labels fontweight boldj -$xpaset -p ds9 grid labels fontslant italic -$xpaset -p ds9 grid labels 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 [<ext>] -    [close [<ext>]] -    [save [<ext>] <filename>] - -Example: -$xpaset -p ds9 header -$xpaset -p ds9 header 2 -$xpaset -p ds9 header close -$xpaset -p ds9 header save 1 foo.txt -
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 -
iexam
-
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. The default event is button. In the last form, the following macros will be expanded if present: $width, $height, $depth, $bitpix, $filename, $regions, $filename[$regions], $env, $pan, $value, $x, $y, $z. See Analysis Macros for more information.
-Syntax: -iexam [] -    [[]|button|key|any] coordinate <coordsys> [<skyframe>] [<skyformat>] -    [[]|button|key|any] data [width][height] -    [[]|button|key|any] <macro string>] - -Example: -$xpaget ds9 iexam # image coordinates -$xpaget ds9 iexam coordinate image -$xpaget ds9 iexam key coordinate image # return coordinate and key event -$xpaget ds9 iexam coordinate wcs fk5 degrees -$xpaget ds9 iexam coordinate wcs galactic sexagesimal -$xpaget ds9 iexam coordinate fk5 -$xpaget ds9 iexam data # return data value -$xpaget ds9 iexam key data # return data value and key event -$xpaget ds9 iexam data 3 3 # return all data in 3x3 box about selected point -$xpaget ds9 iexam {'Click at $x,$y in file $filename'}
-
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
-
jpeg
-
Load JPEG image into current frame. Optional parameters: jpeg quality (1-100)
-Syntax: -jpeg [new|slice] [<filename>] [1-100] - -Example: -$xpaget ds9 jpeg > foo.jpeg -$xpaget ds9 jpeg 100 > foo.jpeg - -$xpaset -p ds9 jpeg foo.jpeg -$xpaset -p ds9 jpeg new foo.jpeg -$xpaset -p ds9 jpeg slice foo.jpeg - -$cat foo.jpeg | xpaset ds9 jpeg# not available windows -$cat foo.jpeg | xpaset ds9 jpegnew# not available windows -$cat foo.jpeg | xpaset ds9 jpegslice# not available windows -
lock
-
Lock all other frames to the current frame.
-Syntax: -lock[frame <coordsys>|none] -    [crosshair <coordsys>|none] -    [crop <coordsys>|none] -    [slice <coordsys>|none]] -    [bin [yes|no]] -    [axes [yes|no]] -    [scale [yes|no]] -    [scalelimites [yes|no]] -    [colorbar [yes|no]] -    [block [yes|no]] -    [smooth [yes|no]] -    [3d [yes|no]] - -Example: -$xpaget -p ds9 lock frame -$xpaget -p ds9 lock crosshair -$xpaget -p ds9 lock crop -$xpaget -p ds9 lock slice -$xpaget -p ds9 lock bin -$xpaget -p ds9 lock axes -$xpaget -p ds9 lock scale -$xpaget -p ds9 lock scalelimits -$xpaget -p ds9 lock colorbar -$xpaget -p ds9 lock block -$xpaget -p ds9 lock smooth -$xpaget -p ds9 lock 3d - -$xpaset -p ds9 lock frame wcs -$xpaset -p ds9 lock crosshair wcs -$xpaset -p ds9 lock crop wcs -$xpaset -p ds9 lock slice wcs -$xpaset -p ds9 lock bin yes -$xpaset -p ds9 lock axes yes -$xpaset -p ds9 lock scale yes -$xpaset -p ds9 lock scalelimits yes -$xpaset -p ds9 lock colorbar yes -$xpaset -p ds9 lock block yes -$xpaset -p ds9 lock smooth yes -$xpaset -p ds9 lock 3d yes - lower -
Lower in the window stacking order.
-Syntax: -lower - -Example: -$xpaset -p ds9 lower -
magnifier
-
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 zero|nonzero|nan|nonnan|range] -    [range <low> <high>] -    [transparency <value>] -    [system <coordsys>] -    [clear] -    [open|close] - -Example: -$xpaget ds9 mask color -$xpaget ds9 mask mark -$xpaget ds9 mask range -$xpaget ds9 mask system -$xpaget ds9 mask transparency - -$xpaset -p ds9 mask color red -$xpaset -p ds9 mask mark zero -$xpaset -p ds9 mask range 10 100 -$xpaset -p ds9 mask transparency 50 -$xpaset -p ds9 mask system wcs -$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[frame <coordsys>] -    [crosshair <coordsys>] -    [crop <coordsys>] -    [slice <coordsys>] -    [bin] -    [axes] -    [scale] -    [scalelimits] -    [colorbar] -    [block] -    [smooth] -    [3d] - -Example: -$xpaset -p ds9 match frame wcs -$xpaset -p ds9 match crosshair wcs -$xpaset -p ds9 match crop wcs -$xpaset -p ds9 match slicewcs -$xpaset -p ds9 match bin -$xpaset -p ds9 match axes -$xpaset -p ds9 match scale -$xpaset -p ds9 match scalelimits -$xpaset -p ds9 match colorbar -$xpaset -p ds9 match block -$xpaset -p ds9 match smooth -$xpaset -p ds9 match 3d - mecube -
Load FITS multiple extension file as data cube.
-Syntax: -mecube [new] [<filename>] - -Example: -$xpaget ds9 mecube > foo.fits - -$xpaset -p ds9 mecube foo.fits -$xpaset -p ds9 mecube new foo.fits - -$cat foo.fits | xpaset ds9 mecube -$cat foo.fits | xpaset ds9 mecube new -
minmax
-
This is how DS9 determines the min and max data values from the data. SCAN will scan all data. DATAMIN and IRAFMIN will use the values of the keywords if present.
-Syntax: -minmax [scan|sample|datamin|irafmin] -    [mode scan|sample|datamin|irafmin] -    [interval #] - -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 100 -
mode
-
Controls the first mouse button mode.
-Syntax: -mode [none|region|crosshair|colorbar|pan|zoom|rotate|catalog|examine|3d] - -Example: -$xpaget ds9 mode -$xpaset -p ds9 mode crosshair
-
mosaic
-
Load FITS mosaic segment into current frame.
-Syntax: -mosaic [wcs|wcsa...wcsz|iraf] [new|mask] [<filename>] - -Example: -$xpaget ds9 mosaic > foo.fits - -$xpaset -p ds9 mosaic foo.fits -$xpaset -p ds9 mosaic wcs foo.fits -$xpaset -p ds9 mosaic wcs new foo.fits -$xpaset -p ds9 mosaic wcs mask foo.fits - -$cat foo.fits | xpaset ds9 mosaic -$cat foo.fits | xpaset ds9 mosaic wcs -$cat foo.fits | xpaset ds9 mosaic wcs new -$cat foo.fits | xpaset ds9 mosaic wcs mask -
mosaicimage
-
Load FITS mosaic image into current frame.
-Syntax: -mosaicimage [wcs|wcsa...wcsz|iraf|wfpc2] [new|mask] [<filename>] - -Example: -$xpaget ds9 mosaicimage > foo.fits - -$xpaset -p ds9 mosaicimage foo.fits -$xpaset -p ds9 mosaicimage wcs foo.fits -$xpaset -p ds9 mosaicimage wcs new foo.fits -$xpaset -p ds9 mosaicimage wcs mask foo.fits - -$cat foo.fits | xpaset ds9 mosaicimage -$cat foo.fits | xpaset ds9 mosaicimage wcs -$cat foo.fits | xpaset ds9 mosaicimage wcs new -$cat foo.fits | xpaset ds9 mosaicimage wcs mask -
movie
-
Create a movie from snap shots of the DS9 window. A slice movie cycles though all slices of a cube. A frame movie cycles through all active frames. A 3d movie cycles through specified viewing angles. The default action is slice. Movie types are either MPEG or Animated GIF, with default MPEG. Optional parameters for 3d: number of frames, azimuth from/to, elevation from/to, slice from/to, oscillate/repeat times.
-Syntax: -movie [slice|frame|3d][mpeg|gif] <filename> -movie 3d [mpeg|gif] <filename> [number|azfrom|azto|elfrom|elto|slfrom|slto|oscillate|repeat <#>] - -Example: -$xpaset -p ds9 movie slice mpeg ds9.mpg -$xpaset -p ds9 movie frame gif ds9.gif -$xpaset -p ds9 movie 3d mpeg ds9.mpg number 10 azfrom -60 azto 60 oscillate 1 -
multiframe
-
Load FITS multiple extension file as multiple images.
-Syntax: -multiframe [<filename>] - -Example: -$xpaset -p ds9 multiframe foo.fits - -$cat foo.fits | xpaset ds9 multiframe# not available windows
-
nameserver
-
Support Name Server functions. Coordinates are in fk5.
-Syntax: -nameserver [<object>] -    [name <object>] -    [serverned-sao|ned-cds|simbad-sao|simbad-cds|vizier-sao|vizier-cds] -    [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
-
nan
-
Set image not-a-number color.
-Syntax: -nan <color> - -Example: -$xpaget ds9 nan - -$xpaset -p ds9 nan red -
nrrd
-
Load an NRRD (Nearly Raw Raster Data) file. Optional parameter: array endian.
-Syntax: -nrrd [native|little|big] -nrrd [new|mask] [<filename>] - -Example: -$xpaget ds9 nrrd -$xpaget ds9 nrrd big - -$xpaset -p ds9 nrrd foo.nrrd -$xpaset -p ds9 nrrd new foo.nrrd -$xpaset -p ds9 nrrd mask foo.nrrd - -$cat foo.nrrd | xpaset ds9 nrrd -$cat foo.nrrd | xpaset ds9 nrrdnew -$cat foo.nrrd | xpaset ds9 nrrd mask -
nvss
-
Support for NRAO VLA Sky Survey.
-Syntax: -nvss [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # 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 -$xpaset -p ds9 nvss m31 -$xpaset -p ds9 nvss name m31 -$xpaset -p ds9 nvss name clear -$xpaset -p ds9 nvss 00:42:44.404 +41:16:08.78 -$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 [orient portrait|landscape] -    [scale <numberic>] -    [size letter|legal|tabloid|poster|a4] - -Example: -$xpaget ds9 pagesetup orient -$xpaget ds9 pagesetup scale -$xpaget ds9 pagesetup size - -$xpaset -p ds9 pagesetup orient portrait -$xpaset -p ds9 pagesetup scale 50 -$xpaset -p ds9 pagesetup size poster -
pan
-
Controls the current image cursor location for the current frame.
-Syntax: -pan [<coordsys> [<skyframe>] [<skyformat>]] # get current coords - -pan [<x> <y> <coordsys> [<skyframe>]] # relative -    [to <x> <y> <coordsys> [<skyframe>]] # absolute -    [open|close] - -Example: -$xpaget ds9 pan # get current image coords -$xpaget ds9 pan wcs fk4 sexagesimal # get current 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. 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 x and y errors
-
To create a new plot, use the plot new command.
-Syntax: -# create new empty plot window -plot [] -    [line|bar|scatter] -    [new] -    [new line|bar|scatter] -    [new name <plotname>] -    [new name <plotname> line|bar|scatter] - -# create new plot with data from stdin -plot[new <title> <xaxis label> <yaxis label>xy|xyex|xyey|xyexey] -    [new line|bar|scatter <title> <xaxis label> <yaxis label>xy|xyex|xyey|xyexey] -    [newname <plotname><title> <xaxis label> <yaxis label>xy|xyex|xyey|xyexey] -    [newname <plotname>line|bar|scatter <title> <xaxis label> <yaxis label>xy|xyex|xyey|xyexey] - -# create new plot with data from stdin which includes title/dim headers -plot [new stdin] -    [new line|bar|scatter stdin] -    [new name <plotname> stdin] -    [new name <plotname>line|bar|scatterstdin] - -#load data into existing plot from stdin -plot [[<plotname>] data xy|xyex|xyey|xyexey] - -# existing plot -plot [[<plotname>] load <filename> xy|xyex|xyey|xyexey] -    [[<plotname>] save <filename>] -    [[<plotname>] layout grid|row|column|strip] -    [[<plotname>] layout strip scale <percent>] -    [[<plotname>] add graph line|bar|scatter] -    [[<plotname>] select graph <graph>] -    [[<plotname>] delete graph] -    [[<plotname>] select dataset <dataset>] -    [[<plotname>] delete dataset] -    [[<plotname>] duplicate] -    [[<plotname>] stats yes|no] -    [[<plotname>] list yes|no] -    [[<plotname>] loadconfig <filename>] -    [[<plotname>] saveconfig <filename>] -    [[<plotname>] pagesetup orient portrait|landscape] -    [[<plotname>] pagesetup size letter|legal|tabloid|poster|a4] -    [[<plotname>] print] -    [[<plotname>] print destination printer|file] -    [[<plotname>] print command <command>] -    [[<plotname>] print filename <filename>] -    [[<plotname>] print color rgb|gray] -    [[<plotname>] close] -    [[<plotname>] mode pointer|zoom] - -# export -plot [[<plotname>] export <filename>] -    [[<plotname>] export gif|tiff|jpeg|png <filename>] -    [[<plotname>] export jpeg <filename> [1-100]] -    [[<plotname>] export tiff <filename> none|jpeg|packbits|deflate]] - -# configure graph -plot [[<plotname>] axis x|y grid yes|no] -    [[<plotname>] axis x|y log yes|no] -    [[<plotname>] axis x|y flip yes|no] -    [[<plotname>] axis x|y auto yes|no] -    [[<plotname>] axis x|y min <value>] -    [[<plotname>] axis x|y max <value>] -    [[<plotname>] axis x|y format <string>] -    [[<plotname>] background <value>] -    [[<plotname>] legend yes|no] -    [[<plotname>] legend position right|left|top|bottom|plotarea] -    [[<plotname>] font title|labels|numbers font times|helvetica|courier] -    [[<plotname>] font title|labels|numbers size <value>] -    [[<plotname>] font title|labels|numbers weight normal|bold] -    [[<plotname>] font title|labels|numbers slant roman|italic] -    [[<plotname>] title <string>] -    [[<plotname>] title x|y <string>] -    [[<plotname>] barmode normal|stacked|aligned|overlap] - -# configure current dataset -plot[[<plotname>] show yes|no] -    [[<plotname>] shape none|circle|square|diamond|plus|splus|scross|triangle|arrow] -    [[<plotname>] shape fill yes|no] -    [[<plotname>] shape color <value>] -    [[<plotname>] smooth step|linear|cubic|quadratic|catrom] -    [[<plotname>] color <value>] -    [[<plotname>] width <value>] -    [[<plotname>] dash yes|no] -    [[<plotname>] error yes|no] -    [[<plotname>] error color <value>] -    [[<plotname>] error cap yes|no] -    [[<plotname>] error width <value>] -    [[<plotname>] name <string>] - -Example: -# return all plotnames -$xpaget ds9 plot - -# create new empty plot window -$xpaset -p ds9 plot -$xpaset -p ds9 plot bar -$xpaset -p ds9 plot new -$xpaset -p ds9 plot new bar -$xpaset -p ds9 plot new name foo -$xpaset -p ds9 plot new name foo bar - -# create new plot with data from stdin -$cat xy.dat | xpaset ds9 plot new {The Title} {X Axis} {Y Axis} xy -$cat xy.dat | xpaset ds9 plot new bar {The Title} {X Axis} {Y Axis} xy -$cat xy.dat | xpaset ds9 plot new name foo {The Title} {X Axis} {Y Axis} xy -$cat xy.dat | xpaset ds9 plot new name foo bar {The Title} {X Axis} {Y Axis} xy - -# create new plot with data from stdin which includes title/dim headers -$cat stdin.2.dat | xpaset ds9 plot new stdin -$cat stdin.2.dat | xpaset ds9 plot new line stdin -$cat stdin.2.dat | xpaset ds9 plot new name foo stdin -$cat stdin.2.dat | xpaset ds9 plot new name foo line stdin - -#load data into existing plot from stdin -$cat xy.dat | xpaset ds9 plot data xy -$cat xy.dat | xpaset ds9 plot foo data xy - -# existing plot -$xpaget ds9 plot layout -$xpaget ds9 plot layout strip scale -$xpaget ds9 plot select graph -$xpaget ds9 plot select dataset -$xpaget ds9 plot stats -$xpaget ds9 plot list -$xpaset -p ds9 plot load xy.dat xy -$xpaset -p ds9 plot save foo.dat -$xpaset -p ds9 plot layout strip -$xpaset -p ds9 plot layout strip scale 30 -$xpaset -p ds9 plot add graph scatter -$xpaset -p ds9 plot select graph 1 -$xpaset -p ds9 plot delete graph -$xpaset -p ds9 plot select dataset 1 -$xpaset -p ds9 plot delete dataset -$xpaset -p ds9 plot duplicate -$xpaset -p ds9 plot stats yes -$xpaset -p ds9 plot list yes -$xpaset -p ds9 plot loadconfig foo.plt -$xpaset -p ds9 plot saveconfig foo.plt -$xpaset -p ds9 plot pagesetup orient portrait -$xpaset -p ds9 plot pagesetup size letter -$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 color rgb -$xpaset -p ds9 plot close - -# plot mode -$xpaget ds9 plot mode -$xpaset -p ds9 plot mode pointer - -# export plot -$xpaset -p ds9 plot export tiff foo.tiff jpeg -$xpaset -p ds9 plot export jpeg foo.jpeg 75 -$xpaset -p ds9 plot export png foo.png - -# configure plot -$xpaget ds9 plot axis x grid -$xpaget ds9 plot axis x log -$xpaget ds9 plot axis x flip -$xpaget ds9 plot axis x auto -$xpaget ds9 plot axis x min -$xpaget ds9 plot axis x max -$xpaget ds9 plot axis x format -$xpaget ds9 plot background -$xpaget ds9 plot legend -$xpaget ds9 plot legend position -$xpaget ds9 plot font numbers font -$xpaget ds9 plot font numbers size -$xpaget ds9 plot font numbers weight -$xpaget ds9 plot font numbers slant -$xpaget ds9 plot title -$xpaget ds9 plot title xaxis -$xpaget ds9 plot title yaxis -$xpaset -p ds9 plot axis x grid yes -$xpaset -p ds9 plot axis x log yes -$xpaset -p ds9 plot axis x flip yes -$xpaset -p ds9 plot axis x auto no -$xpaset -p ds9 plot axis x min 1 -$xpaset -p ds9 plot axis x max 100 -$xpaset -p ds9 plot axis x format {%f} -$xpaset -p ds9 plot background white -$xpaset -p ds9 plot legend yes -$xpaset -p ds9 plot legend position left -$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 title {This is a Title} -$xpaset -p ds9 plot title x {X Axis} -$xpaset -p ds9 plot title y {Y Axis} -$xpaset -p ds9 plot title legend {This is the Legend} - -# bar plot -$xpaget ds9 plot barmode - -$xpaset -p ds9 plot barmode aligned - -# configure current dataset -$xpaget ds9 plot show -$xpaget ds9 plot shape -$xpaget ds9 plot shape fill -$xpaget ds9 plot shape color -$xpaget ds9 plot smooth -$xpaget ds9 plot color -$xpaget ds9 plot width -$xpaget ds9 plot dash -$xpaget ds9 plot error -$xpaget ds9 plot error color -$xpaget ds9 plot error cap -$xpaget ds9 plot error width -$xpaget ds9 plot name - -$xpaset -p ds9 plot show yes -$xpaset -p ds9 plot shape circle -$xpaset -p ds9 plot shape fill no -$xpaset -p ds9 plot shape color cyan -$xpaset -p ds9 plot smooth step -$xpaset -p ds9 plot color red -$xpaset -p ds9 plot width 2 -$xpaset -p ds9 plot dash yes -$xpaset -p ds9 plot error yes -$xpaset -p ds9 plot error color red -$xpaset -p ds9 plot error cap yes -$xpaset -p ds9 plot error width 2 -$xpaset -p ds9 plot name {My Data} - png -
Load PNG image into current frame.
-Syntax: -png [new|slice] [<filename>] - -Example: -$xpaget ds9 png > foo.png - -$xpaset -p ds9 png foo.png -$xpaset -p ds9 png new foo.png -$xpaset -p ds9 png slice foo.png - -$cat foo.png | xpaset ds9 png -$cat foo.png | xpaset ds9 png new -$cat foo.png | xpaset ds9 png slice
-
precision
-
Set region and coordinate output format precision.
-Syntax: -precision <linear><degree><hms><dms><arcmin><arcsec> - -Example: -$xpaget ds9 precision - -$xpaset -p ds9 precision 8 10 4 3 5 3
-
prefs
-
Controls various preference settings.
-Syntax: -prefs [clear] -    [irafalign yes|no] - -Example: -$xpaget ds9 prefs irafalign - -$xpaset -p ds9 prefs clear -$xpaset -p ds9 prefs iraf yes -
preserve
-
Preserve the follow attributes while loading a new image.
-Syntax: -preserve [pan yes|no] -      [regions yes|no] - -Example: -$xpaget ds9 preserve pan -$xpaget ds9 preserve regions - -$xpaset -p ds9 preserve pan yes -$xpaset -p ds9 preserve regions yes -
psprint
-
Invokes postscript printing. Please see print for further details.
-
print
-
Controls printing. Use print option to set printing options. Only available for XPA_METHOD local.
-Syntax: -print [destination printer|file] -    [command <command>] -    [filename <filename>] -    [color rgb|cmyk|gray] -    [level 1|2|3] -    [resolution 72|screen|96|144|150|225|300|600|1200] - -Example: -$xpaget ds9 print destination -$xpaget ds9 print command -$xpaget ds9 print filename -$xpaget ds9 print color -$xpaget ds9 print level -$xpaget ds9 print resolution - -$xpaset -p ds9 print -$xpaset -p ds9 print destination file -$xpaset -p ds9 print command lp -$xpaset -p ds9 print filename foo.ps -$xpaset -p ds9 print color cmyk -$xpaset -p ds9 print level 2 -$xpaset -p ds9 print resolution 96 -
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]] -    [epsilon <integer>] -    [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 invert] -    [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>] -    [fixed|edit|rotate|delete yes|no] -    [include|exclude|source|background] -    [command <marker command>] -    [composite] -    [dissolve] -    [template <filename>] -    [template <filename> at <ra> <dec> <coordsys> <skyframe>] -    [savetemplate <filename>] -    [groups] -    [group new] -    [group <tag> new] -    [group <tag> update] -    [group <tag> select] -    [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] -    [copy] -    [cut] -    [paste image|physical|wcs|wcsa...wcsz] -    [undo] -    [-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 epsilon -$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 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 | xpaset 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 epsilon 5 -$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 invert -$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 strip yes -$xpaset -p ds9 regions shape ellipse -$xpaset -p ds9 regions color red -$xpaset -p ds9 regions width 3 -$xpaset -p ds9 regions edit yes -$xpaset -p ds9 regions include -$xpaset -p ds9 regions command '{circle 100 100 20 # color=red}' -$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 new -$xpaset -p ds9 regions group foo new -$xpaset -p ds9 regions group foo update -$xpaset -p ds9 regions group foo select -$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 copy -$xpaset -p ds9 regions cut -$xpaset -p ds9 regions paste wcs -$xpaset -p ds9 regions undo -
restore
-
Restore DS9 to a previous state from a backup save set.
-Syntax: -restore <filename> - -Example: -$xpaset -p ds9 restore ds9.bck
-
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 wcs|crop|slice|bin|scale|scalelimits|colorbar|block|smooth [yes|no]] -    [open|close] - -Example: -$xpaget ds9 rgb channel -$xpaget ds9 rgb lock wcs -$xpaget ds9 rgb lock crop -$xpaget ds9 rgb lock slice -$xpaget ds9 rgb lock bin -$xpaget ds9 rgb lock scale -$xpaset ds9 rgb lock scalelimits -$xpaget ds9 rgb lock colorbar -$xpaget ds9 rgb lock block -$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 wcs yes -$xpaset -p ds9 rgb lock crop yes -$xpaset -p ds9 rgb lock slice yes -$xpaset -p ds9 rgb lock bin yes -$xpaset -p ds9 rgb lock scale yes -$xpaset -p ds9 rgb lock scalelimits yes -$xpaset -p ds9 rgb lock colorbar yes -$xpaset -p ds9 rgb lock block yes -$xpaset -p ds9 rgb lock smooth yes -$xpaset -p ds9 rgb open -$xpaset -p ds9 rgb close
-
rgbarray
-
Load raw data array cube into rgb frame.
-Syntax: -rgbarray [native|big|little] -rgbarray [new] [[xdim=<x>,ydim=<y>|dim=<dim>],[zdim=3],bitpix=<b>,skip=<s>,endian=[little|big]] - -Example: -$xpaget ds9 rgbarray > foo.arr - -$xpaget ds9 rgbarray little > foo.arr -$xpaset -p ds9 rgbarray foo.arr[dim=512,zdim=3,bitpix=-32,endian=little] -$xpaset -p ds9 rgbarray new foo.arr[dim=512,zdim=3,bitpix=-32,endian=little] - -$cat foo.arr | xpaset ds9 rgbarray [dim=512,zdim=3,bitpix=-32,endian=little] -$cat foo.arr | xpaset ds9 rgbarray new [dim=512,zdim=3,bitpix=-32,endian=little]
-
rgbcube
-
Load FITS rgbcube into rgb frame.
-Syntax: -rgbcube [new] [<filename>] - -Example: -$xpaget ds9 rgbcube > foo.fits - -$xpaset -p ds9 rgbcube foo.fits -$xpaset -p ds9 rgbcube new foo.fits - -$cat foo.fits | xpaset ds9 rgbcube -$cat foo.fits | xpaset ds9 rgbcubenew
-
rgbimage
-
Load FITS rgbimage into rgb frame.
-Syntax: -rgbimage [new] [<filename>] - -Example: -$xpaget ds9 rgbimage > foo.fits - -$xpaset -p ds9 rgbimage foo.fits -$xpaset -p ds9 rgbimage new foo.fits - -$cat foo.fits | xpaset ds9 rgbimage -$cat foo.fits | xpaset ds9 rgbimage new -
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 -
save
-
Save loaded image data of current frame as FITS.
-Syntax: -save [fits|rgbimage|rgbcube|mecube|mosaic|mosaicimage] <filename> [image|table|slice] - -Example: -$xpaset -p ds9 save foo.fits -$xpaset -p ds9 save fits foo.fits image -$xpaset -p ds9 save fits foo.fits table -$xpaset -p ds9 save fits foo.fits slice -$xpaset -p ds9 save rgbimage foo.fits -$xpaset -p ds9 save rgbcube foo.fits -$xpaset -p ds9 save mecube foo.fits -$xpaset -p ds9 save mosaic foo.fits -$xpaset -p ds9 save mosaicimage foo.fits
-
saveimage
-
Create a snap shot of the current DS9 window and save in specified image format. If no format specified, the file name extension is used to determine the output format. Optional parameters: jpeg quality (1-100) and tiff compression method.
-Syntax: -saveimage [fits|eps|gif|tiff|jpeg|png]<filename> -saveimage <filename>.jpeg [1-100] -saveimage <filename>.tiff [none|jpeg|packbits|deflate] - -Example: -$xpaset -p ds9 saveimage ds9.tiff -$xpaset -p ds9 saveimage jpeg ds9.jpeg 75
-
scale
-
Controls the limits and color scale distribution.
-Syntax: -scale [linear|log|pow|sqrt|squared|asinh|sinh|histequ] -    [log exp <value>] -    [datasec yes|no] -    [limits <minvalue> <maxvalue>] -    [mode minmax|<value>|zscale|zmax] -    [scope local|global] -    [match] -    [match limits] -    [lock [yes|no]] -    [lock limits [yes|no]] -    [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 -$xpaget ds9 scale lock -$xpaget ds9 scale lock limits - -$xpaset -p ds9 scale linear -$xpaset -p ds9 scale log exp 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 match -$xpaset -p ds9 scale match limits -$xpaset -p ds9 scale lock yes -$xpaset -p ds9 scale lock limits yes -$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>]] -    [mosaicimage [iraf|wcs|wcsa...wcsz|wfpc2] [key|shmid] <id> [<filename>]] -    [mosaic [iraf|wcs|wcsa...wcsz] [key|shmid] <id> [<filename>]] -    [rgbcube [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>]] - -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 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 mosaic iraf key 100 foo -$xpaset -p ds9 shm mosaic wcs key 100 foo -$xpaset -p ds9 shm rgbcube key 100 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] - sia
-
Support for VO Simple Image Access protocol. The first command will create a new search. All other commands operated on the last search created, unless indicated otherwise.
-Syntax: -sia [2mass|akari|astrowise|cadc|cxc|hla|mast|sdss|skyview|tgssadr] -    [<ref>] [cancel] -    [<ref>] [clear] -    [<ref>] [close] -    [<ref>] [coordinate <ra> <dec> <coordsys>] -    [<ref>] [crosshair] -    [<ref>] [export sb|tsv <filename>] -    [<ref>] [name <object>] -    [<ref>] [print] -    [<ref>] [retrieve] -    [<ref>] [save <filename>] -    [<ref>] [radius <value> degrees|arcmin|arcsec] -    [<ref>] [sky <skyframe>] -    [<ref>] [skyformat <skyformat>] -    [<ref>] [system <coordsys>] -    [<ref>] [update] - -Example: -$xpaget ds9 sia - -$xpaset -p ds9 sia 2mass -$xpaset -p ds9 sia cancel -$xpaset -p ds9 sia clear -$xpaset -p ds9 sia close -$xpaset -p ds9 sia coordinate 202.48 47.21 fk5 -$xpaset -p ds9 sia crosshair -$xpaset -p ds9 sia export tsv bar.tsv -$xpaset -p ds9 sia name m51 -$xpaset -p ds9 sia print -$xpaset -p ds9 sia retrieve -$xpaset -p ds9 sia save foo.xml -$xpaset -p ds9 sia radius 1 degrees -$xpaset -p ds9 sia sky fk5 -$xpaset -p ds9 sia skyformat degrees -$xpaset -p ds9 sia system wcs -$xpaset -p ds9 sia update - 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>|clear] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [pixels <width> <height>] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [survey <survey>] -    [open|close] - -Example: -$xpaget ds9 skyview name -$xpaget ds9 skyview coord -$xpaget ds9 skyview size -$xpaget ds9 skyview pixels -$xpaget ds9 skyview save -$xpaget ds9 skyview frame -$xpaget ds9 skyview survey - -$xpaset -p ds9 skyview -$xpaset -p ds9 skyview m31 -$xpaset -p ds9 skyview name m31 -$xpaset -p ds9 skyview name clear -$xpaset -p ds9 skyview 00:42:44.404 +41:16:08.78 -$xpaset -p ds9 skyview size 60 60 arcmin -$xpaset -p ds9 skyview pixels 600 600 -$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.
-
Boxcar width =2*radius+1 -Tophat diameter =2*radius+1 -Gaussian diameter =2*radius+1,mean=0 -Elliptical Gaussian diameter =2*radius+1,mean=0 -Syntax: -smooth [] -    [yes|no] -    [function boxcar|tophat|gaussian] -    [radius <value>] -    [radiusminor <value>] -    [sigma <value>] -    [sigmaminor <value>] -    [angle <value>] -    [match] -    [lock [yes|no]] -    [open|close]
-
Example: -$xpaget ds9 smooth -$xpaget ds9 smooth function -$xpaget ds9 smooth radius -$xpaget ds9 smooth radiusminor -$xpaget ds9 smooth sigma -$xpaget ds9 smooth sigmaminor -$xpaget ds9 smooth lock
-
$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 radiusminor 4 -$xpaset -p ds9 smooth sigma 2.0 -$xpaset -p ds9 smooth sigmaminor 2.0 -$xpaset -p ds9 smooth angle 45 -$xpaset -p ds9 smooth match -$xpaset -p ds9 smooth lock yes -$xpaset -p ds9 smooth open -$xpaset -p ds9 smooth close
-
source
-
Source TCL code from a file. Only available for XPA_METHOD local.
-Syntax: -source [<filename>] - -Example: -$xpaset -p ds9 source foo.tcl -
tcl
-
Execute one tcl command. Only available for XPA_METHOD local.
-Syntax: -tcl [<tcl command>] - -Example: -$echo 'puts "Hello, World"' | xpaset ds9 tcl -$xpaset -p ds9 tcl {puts {Hello, World}} -
threads
-
Set number of process threads for functions which are multi-threaded.
-Syntax: -threads # - -Example: -$xpaget ds9 threads - -$xpaset -p ds9 threads 8
-
tiff
-
Load TIFF image into current frame. Optional parameters: tiff compression method.
-Syntax: -tiff [new|slice] [<filename>] [none|jpeg|packbits|deflate] - -Example: -$xpaget ds9 tiff > foo.tiff -$xpaget ds9 tiff jpeg > foo.tiff - -$xpaset -p ds9 tiff foo.tiff -$xpaset -p ds9 tiff new foo.tiff -$xpaset -p ds9 tiff slice foo.tiff - -$cat foo.tiff | xpaset ds9 tiff -$cat foo.tiff | xpaset ds9 tiff new -$cat foo.tiff | xpaset ds9 tiff slice -
tile
-
Controls the tile display mode.
-Syntax: -tile [] -    [yes|no] -    [mode grid|column|row] -    [grid] -    [grid mode automatic|manual] -    [grid direction x|y] -    [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 direction -$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 direction x -$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] - -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
-
url
-
Load FITS from URL into the current frame
-Syntax: -url <url> - -Example: -$xpaset -p ds9 url http://foo.bar.edu/foo.fits -
version
-
Returns the current version of DS9.
-Syntax: -version - -Example: -$xpaget ds9 version -
view
-
Controls the GUI.
-Syntax: -view [layout horizontal|vertical] -    [keyvalue <string>] -    [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] -    [keyword yes|no] -    [minmax yes|no] -    [lowhigh yes|no] -    [units yes|no] -    [image|physical|wcs|wcsa...wcsz yes|no] -    [frame yes|no] -    [red yes|no] -    [green yes|no] -    [blue yes|no] - -Example: -$xpaget ds9 view layout -$xpaget ds9 view keyvalue -$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 keyword -$xpaget ds9 view minmax -$xpaget ds9 view lowhigh -$xpaget ds9 view units -$xpaget ds9 view image -$xpaget ds9 view wcsa -$xpaget ds9 view red -$xpaget ds9 view frame - -$xpaset -p ds9 view layout vertical -$xpaset -p ds9 view keyvalue BITPIX -$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 keyword yes -$xpaset -p ds9 view minmax yes -$xpaset -p ds9 view lowhigh yes -$xpaset -p ds9 view units yes -$xpaset -p ds9 view wcsa yes -$xpaset -p ds9 view frame yes -$xpaset -p ds9 view red yes -$xpaset -p ds9 view green yes -$xpaset -p ds9 view blue yes
-
-vla -
Support for VLA Sky Survey.
-Syntax: -vla [] -    [<object>] -    [name <object>|clear] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [survey first|stripe82] -    [open|close] - -Example: -$xpaget ds9 vla name -$xpaget ds9 vla coord -$xpaget ds9 vla size -$xpaget ds9 vla save -$xpaget ds9 vla frame -$xpaget ds9 vla survey - -$xpaset -p ds9 vla -$xpaset -p ds9 vla m31 -$xpaset -p ds9 vla name m31 -$xpaset -p ds9 vla name clear -$xpaset -p ds9 vla 00:42:44.404 +41:16:08.78 -$xpaset -p ds9 vla size 60 60 arcmin -$xpaset -p ds9 vla save yes -$xpaset -p ds9 vla frame current -$xpaset -p ds9 vla update frame -$xpaset -p ds9 vla survey stripe82 -$xpaset -p ds9 vla open -$xpaset -p ds9 vla close
-
vlss
-
Support for NRAO VLSS Sky Survey.
-Syntax: -vlss [] -    [<object>] -    [name <object>] -    [<ra> <dec>] # in wcs fk5 -    [size <width> <height> degrees|arcmin|arcsec] -    [save yes|no] -    [frame new|current] -    [update frame|crosshair] -    [open|close] - -Example: -$xpaget ds9 vlss name -$xpaget ds9 vlss coord -$xpaget ds9 vlss size -$xpaget ds9 vlss save -$xpaget ds9 vlss frame - -$xpaset -p ds9 vlss -$xpaset -p ds9 vlss m31 -$xpaset -p ds9 vlss name m31 -$xpaset -p ds9 vlss name clear -$xpaset -p ds9 vlss 00:42:44.404 +41:16:08.78 -$xpaset -p ds9 vlss size 60 60 arcmin -$xpaset -p ds9 vlss save yes -$xpaset -p ds9 vlss frame current -$xpaset -p ds9 vlss update frame -$xpaset -p ds9 vlss open -$xpaset -p ds9 vlss close
-
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 [[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 fk5 -$xpaset -p ds9 wcs sky fk5 -$xpaset -p ds9 wcs sexagesimal -$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 -$xpaset -p ds9 open -$xpaset -p ds9 close
-$cat foo.wcs | xpaset ds9 wcs replace -$cat foo.wcs | xpaset ds9 wcs append -$echo "OBJECT = 'foobar'" | xpaset ds9 wcs append -
web
-
Display specified URL in the web display.
-Syntax: -web [] -    [<url>] -    [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
-
xpa
-
Configure XPA.
-Syntax: --xpa [disconnect] -    [info] - -Example: -$xpaget ds9 info - -$xpaset -p ds9 disconnect -$xpaset -p ds9 info -
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>] -    [in] -    [out] -    [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 in -$xpaset -p ds9 zoom out -$xpaset -p ds9 zoom to fit -$xpaset -p ds9 zoom open -$xpaset -p ds9 zoom close

- + + + + + XPA Access Points + + +

XPA Access Points

+
The XPA + messaging system provides seamless communication between DS9 and + other Unix programs, including X programs. 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 + 3d + about + align + analysis + array + background + backup + bin + blink + block + catalog + cd + cmap + colorbar + console + contour + crop + crosshair + cube + cursor + data + dsssao + dsseso + dssstsci + envi + exit + export + file + fits + frame + gif + grid + header + height + iconify + iexam + iis + jpeg + lock + lower + magnifier + mask + match + mecube + minmax + mode + mosaic + mosaicimage + movie + multiframe + nameserver + nrrd + nvss + orient + pagesetup + pan + pixeltable + plot + png + precision + prefs + preserve + psprint + print + quit + raise + regions + restore + rgb + rgbarray + rgbcube + rgbimage + rotate + save + saveimage + scale + shm + sia + single + skyview + sleep + smooth + source + tcl + threads + tile + update + url + version + view + vla + vlss + vo + wcs + web + width + xpa + zscale + zoom + +
2mass
+
Support for 2MASS Digital Sky Survey.
+ Syntax: + 2mass [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # 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 + $xpaset -p ds9 2mass m31 + $xpaset -p ds9 2mass name m31 + $xpaset -p ds9 2mass name clear + $xpaset -p ds9 2mass 00:42:44.404 +41:16:08.78 + $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
+
3d
+
Support for 3D frame.
+ Syntax: + 3d [] +     [view <az> <el>] +     [az <az>] +     [el <el>] +     [scale <scale>] +     [method mip|aip] +     [background none|azimuth|elevation] +     [border yes|no] +     [border color <color>] +     [highlite yes|no] +     [highlite color <color>] +     [compass yes|no] +     [compass color <color>] +     [match] +     [lock [yes|no]] +     [open|close] + + Example: + $xpaget ds9 3d view + $xpaget ds9 3d az + $xpaget ds9 3d el + $xpaget ds9 3d scale + $xpaget ds9 3d method + $xpaget ds9 3d background + $xpaget ds9 3d border + $xpaget ds9 3d border color + $xpaget ds9 3d highlite + $xpaget ds9 3d highlite color + $xpaget ds9 3d compass + $xpaget ds9 3d compass color + $xpaget ds9 3d lock + + $xpaset -p ds9 3d # create new 3D frame + $xpaset -p ds9 3d view 45 30 + $xpaset -p ds9 3d az 45 + $xpaset -p ds9 3d el 30 + $xpaset -p ds9 3d scale 10 + $xpaset -p ds9 3d method mip + $xpaset -p ds9 3d background azimuth + $xpaset -p ds9 3d border yes + $xpaset -p ds9 3d border color red + $xpaset -p ds9 3d highlite yes + $xpaset -p ds9 3d highlite color red + $xpaset -p ds9 3d compass yes + $xpaset -p ds9 3d compass color red + $xpaset -p ds9 3d match + $xpaset -p ds9 3d lock yes + $xpaset -p ds9 3d open + $xpaset -p ds9 3d close
+
about
+
Get DS9 credits.
+ Syntax: + about + + Example: + $xpaget ds9 about + +
align
+
Controls the World Coordinate System alignment for the current + frame.
+ Syntax: + align [] +     [yes|no] + + Example: + $xpaget ds9 align + + $xpaset -p ds9 align yes + +
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 message okcancel {Hello World} + + $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 {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 into current frame.
+
+ Syntax: + array [native|little|big] + array [new|mask] +[[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,endian=[little|big]] + + Example: + $xpaget ds9 array > foo.arr + $xpaget ds9 array little > foo.arr + + $xpaset -p ds9 array foo.arr[dim=512,bitpix=-32,endian=little] + $xpaset -p ds9 array new + foo.arr[dim=512,bitpix=-32,endian=little] + $xpaset -p ds9 array mask + foo.arr[dim=512,bitpix=-32,endian=little] + + $cat foo.arr | xpaset ds9 + array[dim=512,bitpix=-32,endian=little] + $cat foo.arr | xpaset ds9 array + new[dim=512,bitpix=-32,endian=little] + $cat foo.arr | xpaset ds9 array mask + [dim=512,bitpix=-32,endian=little] +
bg
+ background
+
Set image background color.
+ Syntax: + bg <color> + + Example: + $xpaget ds9 bg + + $xpaset -p ds9 bg red
+
backup
+
Create a backup save set.
+ Syntax: + backup <filename> + + Example: + $xpaset -p ds9 backup ds9.bck
+
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>] +     [filter clear] +     [function average|sum] +     [in] +     [out] +     [to fit] +     [match] +     [lock [yes|no]] +     [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 + $xpaget ds9 bin lock + + $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 clear + $xpaset -p ds9 bin function sum + $xpaset -p ds9 bin in + $xpaset -p ds9 bin out + $xpaset -p ds9 bin to fit + $xpaset -p ds9 bin match + $xpaset -p ds9 bin lock yes + $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
+
block
+
Controls blocking parameters.
+ Syntax: + block[<value>] +     [<value> <value>] +     [to <value>] +     [to <value><value>] +     [in] +     [out] +     [to fit] +     [match] +     [lock [yes|no]] +     [open|close] + + Example: + $xpaget ds9 block + $xpaget ds9 block lock + + $xpaset -p ds9 block 4 + $xpaset -p ds9 block 4 2 + $xpaset -p ds9 block to 4 + $xpaset -p ds9 block to 4 2 + $xpaset -p ds9 block in + $xpaset -p ds9block out + $xpaset -p ds9 block to fit + $xpaset -p ds9 block match + $xpaset -p ds9 block lock yes + $xpaset -p ds9 block open + $xpaset -p ds9 block close
+
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 [new] +     [ned|simbad|denis|skybot] +     +[aavso|ac|ascss|cmc|gaia|gsc1|gsc2|gsc3|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|sdss9|tycho] +     [ua2|ub1|ucac2|ucac2sup|ucac3|ucac4|urat1] +     [2mass|iras] +     [csc|xmm|rosat] +     [first|nvss] +     [chandralog|cfhtlog|esolog|stlog|xmmlog] +     [cds <catalogname>] +     [cds <catalogid>] + +     [load <filename>] +     [import sb|tsv <filename>] + +     [<ref>] [<ra> <dec> + <coordsys>] +     [<ref>] [allcols] +     [<ref>] [allrows] +     [<ref>] [cancel] +     [<ref>] [clear] +     [<ref>] [close] +     [<ref>] [crosshair] +     [<ref>] [dec <col>] +     [<ref>] [edit yes|no] +     [<ref>] [export sb|tsv + <filename>] +     [<ref>] [filter <string>] +     [<ref>] [filter load <filename>] +     [<ref>] [header] +     [<ref>] [location <code>] +     [<ref>] [match] +     [<ref>] [match <ref> <ref>] +     [<ref>] [match error <value> + degrees|arcmin|arcsec] +     [<ref>] [match function + 1and2|1not2|2not1] +     [<ref>] [match return + 1and2|1only|2only] +     [<ref>] [match unique yes|no] +     [<ref>] [maxrows <number>] +     [<ref>] [name <object>] +     [<ref>] [panto yes|no] +     [<ref>] [plot <xcol> <ycol> + <xerrcol> <yerrcol>] +     [<ref>] [print] +     [<ref>] [psky <skyframe>] +     [<ref>] [psystem <coordsys>] +     [<ref>] [ra <col>] +     [<ref>] [regions] +     [<ref>] [retrieve] +     [<ref>] [samp] +     [<ref>] [samp broadcast] +     [<ref>] [samp send <application>] +     [<ref>] [save <filename>] +     [<ref>] [server + cds|adac|cadc|cambridge|sao|ukirt|iucaa|bejing|saao] +     [<ref>] [show yes|no] +     [<ref>] [radius <value> + degrees|arcmin|arcsec] +     [<ref>] [sky <skyframe>] +     [<ref>] [skyformat <skyformat>] +     [<ref>] [sort <col> incr|decr] +     [<ref>] [symbol [#] + condition|shape|color|text|font|fontsize|fontweight|fontslant + <value>] +     [<ref>] [symbol [#] + text|size|size2|units|angle <value>] +     [<ref>] [symbol shape + circle|ellipse|box|text|point] +     [<ref>] [symbol shapecircle point|box + point|diamond point|cross point|x point|arrow point|boxcircle + point] +     [<ref>] [symbol add| [#] remove] +     [<ref>] [symbol save|load + <filename>] +     [<ref>] [system <coordsys>] +     [<ref>] [update] +     [<ref>] [x <col>] +     [<ref>] [y <col>] + + Example: + $xpaget ds9 catalog + $xpaget ds9 catalog header + + $xpaset -p ds9 catalog new + $xpaset -p ds9 catalog 2mass + $xpaset -p ds9 catalog cds 2mass + $xpaset -p ds9 catalog cds {I/252} + + $xpaset -p ds9 catalog load foo.xml + $xpaset -p ds9 catalog import tsv foo.tsv + + $xpaset -p ds9 catalog 202.48 47.21 fk5 + $xpaset -p ds9 catalog allrows + $xpaset -p ds9 catalog allcols + $xpaset -p ds9 catalog cancel + $xpaset -p ds9 catalog clear + $xpaset -p ds9 catalog close + $xpaset -p ds9 catalog crosshair + $xpaset -p ds9 catalog dec DEC + $xpaset -p ds9 catalog edit yes + $xpaset -p ds9 catalog export tsv bar.tsv + $xpaset -p ds9 catalog filter '$Jmag>10' + $xpaset -p ds9 catalog filter load foo.flt + $xpaset -p ds9 catalog header + $xpaset -p ds9 catalog location 500 + $xpaset -p ds9 catalog match error 2 arcsec + $xpaset -p ds9 catalog match function 1and2 + $xpaset -p ds9 catalog match unique no + $xpaset -p ds9 catalog match return 1only + $xpaset -p ds9 catalog match # last two catalogs loaded + $xpaset -p ds9 catalog match 2mass csc + $xpaset -p ds9 catalog maxrows 2000 + $xpaset -p ds9 catalog name m51 + $xpaset -p ds9 catalog panto no + $xpaset -p ds9 catalog plot '$Jmag' '$Hmag' '$e_Jmag' '$e_Hmag' + $xpaset -p ds9 catalog print + $xpaset -p ds9 catalog psky fk5 + $xpaset -p ds9 catalog psystem wcs + $xpaset -p ds9 catalog ra RA + $xpaset -p ds9 catalog regions + $xpaset -p ds9 catalog retrieve + $xpaset -p ds9 catalog samp broadcast + $xpaset -p ds9 catalog samp send aladin + $xpaset -p ds9 catalog save foo.xml + $xpaset -p ds9 catalog server sao + $xpaset -p ds9 catalog show yes + $xpaset -p ds9 catalog radius 1 degrees + $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 symbol font times + $xpaset -p ds9 catalog symbol fontsize 14 + $xpaset -p ds9 catalog symbol fontweight bold + $xpaset -p ds9 catalog symbol 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 sky fk5 + $xpaset -p ds9 catalog skyformat degrees + $xpaset -p ds9 catalog sort {Jmag} incr + $xpaset -p ds9 catalog system wcs + $xpaset -p ds9 catalog update + $xpaset -p ds9 catalog x RA + $xpaset -p ds9 catalog y DEC
+
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] +     [load <filename>] +     [save <filename>] +     [invert yes|no] +     [<constrast> <bias>] +     [tag [load|save] <filename>] +     [tag delete] +     [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 load foo.sao + $xpaset -p ds9 cmap save bar.sao + $xpaset -p ds9 cmap invert yes + $xpaset -p ds9 cmap 5 .5 + $xpaset -p ds9 cmap tag load foo.tag + $xpaset -p ds9 cmap tag save foo.tag + $xpaset -p ds9 cmap tag delete + $xpaset -p ds9 cmap open + $xpaset -p ds9 cmap close + +
colorbar
+
+
Controls colorbar parameters.
+ Syntax: + colorbar [] +     [yes|no] +     [orientation] +     [horizontal|vertical] +     [numerics yes|no] +     [space value|distance] +     [font times|helvetica|courier] +     [fontsize <value>] +     [fontweight normal|bold] +     [fontslant roman|italic] +     [size] +     [ticks] +     [match] +     [lock [yes|no]] +
+ 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 + $xpaget ds9 colorbar lock + + $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 + $xpaset -p ds9 colorbar match + $xpaset -p ds9 colorbar lock yes + +
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>] +     [save <filename> [<coordsys> + <skyframe>]] +     [convert] +     [load levels <filename>] +     [save levels <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|asinh|sinh|histequ] +     [log exp <value>] +     [mode minmax|<value>|zscale|zmax] +     [scope global|local] +     [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 scope + $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.ctr + $xpaset -p ds9 contour save ds9.ctr + $xpaset -p ds9 contour save ds9.ctr wcs fk5 + $xpaset -p ds9 contour convert + $xpaset -p ds9 contour load levels ds9.ctr + $xpaset -p ds9 contour save levels ds9.lev + $xpaset -p ds9 contour copy + $xpaset -p ds9 contour paste + $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 scope local + $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
+
crop
+
Set current image display area.
+ Syntax: + crop [<x> <y> <width> <height> + [<coordsys>][<skyframe>][degrees|arcmin|arcsec] +     [match <coordsys>] +     [lock <coordsys>|none] +     [reset] +     [3d zmin zmax <coordsys>] +     [open|close] + + Example: + $xpaget ds9 crop # get crop in physical coords + $xpaget ds9 crop wcs galactic sexagesimal arcsec + $xpaget ds9 crop lock + + $xpaset -p ds9 crop 40 30 10 20 # set crop in physical coords + $xpaset -p ds9 crop +104:51:06.915 +68:33:40.761 28.144405 + 22.000204 wcs galactic arcsec + $xpaset -p ds9 crop match wcs + $xpaset -p ds9 crop lock wcs + $xpaset -p ds9 crop reset + $xpaset -p ds9 crop 3d .25 .50 wcs + $xpaset -p ds9 crop open + $xpaset -p ds9 crop 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>]] +     [match <coordsys>] +     [lock <coordsys>|none] + + Example: + $xpaget ds9 crosshair # get crosshair in physical coords + $xpaget ds9 crosshair wcs fk4 sexagesimal # get crosshair in wcs + coords + $xpaget ds9 crosshair lock + + $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 + $xpaset -p ds9 crosshair match wcs + $xpaset -p ds9 crosshair lock wcs + +
cube
+
+
Controls FITS cube dialog.
+ Syntax: + cube [] +     [play|stop|next|prev|first|last] +     [<slice> [<coordsys>]] +     [interval <numeric>] +     [match <coordsys>] +     [lock <coordsys>|none] +     [order 123|132|213|231|312|321] +     [axes lock [yes|no]] +     [axis <axis>] +     [open|close] + + Example: + $xpaget ds9 cube + $xpaget ds9 cube wcs + $xpaget ds9 cube interval + $xpaget ds9 cube lock + $xpaget ds9 cube order + $xpaget ds9 cube axes lock + $xpaget ds9 cube axis + + $xpaset -p ds9 cube + $xpaset -p ds9 cube play + $xpaset -p ds9 cube last + $xpaset -p ds9 cube 3 + $xpaset -p ds9 cube 4.4 wcs + $xpaset -p ds9 cube interval 2 + $xpaset -p ds9 cube match wcs + $xpaset -p ds9 cube lock wcs + $xpaset -p ds9 cube order 123 + $xpaset -p ds9 cube axes lock yes + $xpaset -p ds9 cube axis 3 + $xpaset -p ds9 cube open + $xpaset -p ds9 cube close
+
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> + <width> <height> [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 + +
dsssao
+ dss
+
+
Support for Digital Sky Survey at SAO.
+ Syntax: + dsssao [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # 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 + $xpaset -p ds9 dsssao m31 + $xpaset -p ds9 dsssao name m31 + $xpaset -p ds9 dsssao name clear + $xpaset -p ds9 dsssao 00:42:44.404 +41:16:08.78 + $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>|clear] +     [<ra> <dec>] # 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 + $xpaset -p ds9 dsseso m31 + $xpaset -p ds9 dsseso name m31 + $xpaset -p ds9 dsseso name clear + $xpaset -p ds9 dsseso 00:42:44.404 +41:16:08.78 + $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>|clear] +     [<ra> <dec>] # 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 + $xpaset -p ds9 dssstsci m31 + $xpaset -p ds9 dssstsci name m31 + $xpaset -p ds9 dssstsci name clear + $xpaset -p ds9 dssstsci 00:42:44.404 +41:16:08.78 + $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
+
envi
+
Load an ENVI header and file. Optional parameter: array endian.
+
+ Syntax:+ envi [new] <header> [<filename>]+ + Example:+ $xpaset -p ds9 envi foo.hdr+ $xpaset -p ds9 envi new foo.hdr+ $xpaset -p ds9 envi foo.hdr foo.bsq+
+ exit
+
quits
+
+
Quits DS9.
+ Syntax: + exit + quit + + Example: + $xpaset -p ds9 exit + +
export
+
+
Export loaded image data of current frame in specified image + format. Optional parameters: array endian, nrrd endian, jpeg + quality (1-100) and tiff compression method.
+ Syntax: + export[array|nrrd|envi|gif|tiff|jpeg|png]<filename> + export array <filename>[big|little|native] + export nrrd <filename>[big|little|native] + export envi <header> [<filename>][big|little|native] + export jpeg <filename>[1-100] + export tiff <filename>[none|jpeg|packbits|deflate] + + Example: + $xpaset -p ds9 export array foo.arr little + $xpaset -p ds9 export nrrd foo.nrrd little + $xpaset -p ds9 export envi foo.hdr little + $xpaset -p ds9 export envi foo.hdr foo.bsq little + $xpaset -p ds9 export tiff foo.tiff jpeg + $xpaset -p ds9 export jpeg foo.jpeg 75 + $xpaset -p ds9 export png foo.png
+
file
+
Query currently loaded file information.
+ Syntax: + file + + Example: + $xpaget ds9 file
+
fits
+
Load a FITS image into the current frame or query the currently + loaded image.
+
+ Syntax: + fits[new|mask|slice] [<filename>] +     [width|height|depth|bitpix] +     [size [wcs|wcsa...wcsz] + [fk4|fk5|icrs|galactic|ecliptic] [degrees|arcmin|arcsecs]] +     [header [<ext>] [keyword + <string>]] +     [image|table|slice] + + Example: + $xpaget ds9 fits > foo.fits + $xpaget ds9 fits width + $xpaget ds9 fits height + $xpaget ds9 fits depth + $xpaget ds9 fits bitpix + $xpaget ds9 fits size + $xpaget ds9 fits size wcs fk5 arcmin + $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 table > bar.fits + $xpaget ds9 fits slice > foo.fits + + $xpaset -p ds9 fits foo.fits + $xpaset -p ds9 fits new foo.fits + $xpaset -p ds9 fits bar.fits[bin=detx,dety] + $xpaset -p ds9 fits slice foo.fits + $xpaset -p ds9 fits mask foo.fits + + $cat foo.fits | xpaset ds9 fits + $cat foo.fits | xpaset ds9 fits new + $cat bar.fits | xpaset ds9 fits -[bin=detx,dety] + $cat foo.fits | xpaset ds9 fits slice + $cat foo.fits | xpaset ds9 fits mask + +
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|3d]] +     [delete [#|all]] +     [reset [#|all]] +     [refresh [#|all]] +     [hide [#|all]] +     [show [#|all]] +     [move first] +     [move back] +     [move forward] +     [move last] +     [first] +     [prev] +     [next] +     [last] +     [frameno #] +     [#] +     [match <coordsys>] +     [lock <coordsys>|none] +     [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>]] +     [has wcs celestial [<wcssys>]] +     [has wcs 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 lock + $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 celestial 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 + $xpaset -p ds9 frame match wcs + $xpaset -p ds9 frame lock wcs + +
gif
+
Load GIF image into current frame.+
+ Syntax: + gif [new|slice] [<filename>] + + Example: + $xpaget ds9 gif > foo.gif + + $xpaset -p ds9 gif foo.gif + $xpaset -p ds9 gif new foo.gif + $xpaset -p ds9 gif slice foo.gif + + $cat foo.gif | xpaset ds9 gif # not available windows + $cat foo.gif | xpaset ds9 gifnew # not available windows + $cat foo.gif | xpaset ds9 gifslice# not available windows +
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 dash yes|no] +     [grid gap1 <value>] +     [grid gap2 <value>] +     [grid gap3 <value>] +     [axes yes|no] +     [axes color <color>] +     [axes width <value>] +     [axes dash yes|no] +     [axes type interior|exterior] +     [axes origin lll|llu|lul|luu|ull|ulu|uul|uuu] +     [format1 <format>] +     [format2 <format>] +     [tickmarks yes|no] +     [tickmarks color <color>] +     [tickmarks width <value>] +     [tickmarks dash yes|no] +     [border yes|no] +     [border color <color>] +     [border width <value>] +     [border dash yes|no] +     [numerics yes|no] +     [numerics font times|helvetica|courier] +     [numerics fontsize <value>] +     [numerics fontweight normal|bold] +     [numerics fontslant roman|italic] +     [numerics color <color>] +     [numerics gap1 <value>] +     [numerics gap2 <value>] +     [numerics gap3 <value>] +     [numerics type interior|exterior] +     [numerics 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>] +     [labels yes|no] +     [labels def1 yes|no] +     [labels def2 yes|no] +     [labels text1 <text>] +     [labels text2 <text>] +     [labels gap1 <value>] +     [labels gap2 <value>] +     [labels font times|helvetica|courier] +     [labels fontsize <value>] +     [labels fontweight normal|bold] +     [labels fontslant roman|italic] +     [labels 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 dash + $xpaget ds9 grid grid gap1 + $xpaget ds9 grid grid gap2 + $xpaget ds9 grid grid gap3 + $xpaget ds9 grid axes + $xpaget ds9 grid axes color + $xpaget ds9 grid axes width + $xpaget ds9 grid axes dash + $xpaget ds9 grid axes type + $xpaget ds9 grid axes origin + $xpaget ds9 grid format1 + $xpaget ds9 grid format2 + $xpaget ds9 grid tickmarks + $xpaget ds9 grid tickmarks color + $xpaget ds9 grid tickmarks width + $xpaget ds9 grid tickmarks dash + $xpaget ds9 grid border + $xpaget ds9 grid border color + $xpaget ds9 grid border width + $xpaget ds9 grid border dash + $xpaget ds9 grid numerics + $xpaget ds9 grid numerics font + $xpaget ds9 grid numerics fontsize + $xpaget ds9 grid numerics fontweight + $xpaget ds9 grid numerics fontslant + $xpaget ds9 grid numerics color + $xpaget ds9 grid numerics gap1 + $xpaget ds9 grid numerics gap2 + $xpaget ds9 grid numerics gap3 + $xpaget ds9 grid numerics type + $xpaget ds9 grid numerics 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 labels + $xpaget ds9 grid labels text1 + $xpaget ds9 grid labels def1 + $xpaget ds9 grid labels gap1 + $xpaget ds9 grid labels text2 + $xpaget ds9 grid labels def2 + $xpaget ds9 grid labels gap2 + $xpaget ds9 grid labels font + $xpaget ds9 grid labels fontsize + $xpaget ds9 grid labels fontweight + $xpaget ds9 grid labels fontslant + $xpaget ds9 grid labels 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 dash yes + $xpaset -p ds9 grid grid gap1 10 + $xpaset -p ds9 grid grid gap2 10 + $xpaset -p ds9 grid grid gap3 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 dash yes + $xpaset -p ds9 grid axes type exterior + $xpaset -p ds9 grid axes origin lll + $xpaset -p ds9 grid format1 d.2 + $xpaset -p ds9 grid format2 d.2 + $xpaset -p ds9 grid tickmarks yes + $xpaset -p ds9 grid tickmarks color red + $xpaset -p ds9 grid tickmarks width 2 + $xpaset -p ds9 grid tickmarks dash yes + $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 dash yes + $xpaset -p ds9 grid numerics yes + $xpaset -p ds9 grid numerics font courier + $xpaset -p ds9 grid numerics fontsize 12 + $xpaset -p ds9 grid numerics fontweight bold + $xpaset -p ds9 grid numerics fontslant italic + $xpaset -p ds9 grid numerics color red + $xpaset -p ds9 grid numerics gap1 10 + $xpaset -p ds9 grid numerics gap2 10 + $xpaset -p ds9 grid numerics gap3 10 + $xpaset -p ds9 grid numerics type exterior + $xpaset -p ds9 grid numerics 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 labels yes + $xpaset -p ds9 grid labels text1 {Hello World} + $xpaset -p ds9 grid labels def1 yes + $xpaset -p ds9 grid labels gap1 10 + $xpaset -p ds9 grid labels text2 {Hello World} + $xpaset -p ds9 grid labels def2 yes + $xpaset -p ds9 grid labels gap2 10 + $xpaset -p ds9 grid labels font courier + $xpaset -p ds9 grid labels fontsize 12 + $xpaset -p ds9 grid labels fontweight boldj + $xpaset -p ds9 grid labels fontslant italic + $xpaset -p ds9 grid labels 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 [<ext>] +     [close [<ext>]] +     [save [<ext>] <filename>] + + Example: + $xpaset -p ds9 header + $xpaset -p ds9 header 2 + $xpaset -p ds9 header close + $xpaset -p ds9 header save 1 foo.txt + +
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 + +
iexam
+
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. The default event is + button. In the last form, the following macros will be + expanded if present: $width, $height, $depth, $bitpix, + $filename, $regions, $filename[$regions], $env, $pan, $value, + $x, $y, $z. See Analysis + Macros for more information.
+
+ Syntax: + iexam [] +     [[]|button|key|any] coordinate + <coordsys> [<skyframe>] [<skyformat>] +     [[]|button|key|any] data [width][height] +     [[]|button|key|any] <macro string>] + + Example: + $xpaget ds9 iexam # image coordinates + $xpaget ds9 iexam coordinate image + $xpaget ds9 iexam key coordinate image # return coordinate and + key event + $xpaget ds9 iexam coordinate wcs fk5 degrees + $xpaget ds9 iexam coordinate wcs galactic sexagesimal + $xpaget ds9 iexam coordinate fk5 + $xpaget ds9 iexam data # return data value + $xpaget ds9 iexam key data # return data value and key event + $xpaget ds9 iexam data 3 3 # return all data in 3x3 box about + selected point + $xpaget ds9 iexam {'Click at $x,$y in file $filename'}
+
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
+
jpeg
+
Load JPEG image into current frame. Optional parameters: jpeg + quality (1-100)
+ Syntax: + jpeg [new|slice] [<filename>] [1-100] + + Example: + $xpaget ds9 jpeg > foo.jpeg + $xpaget ds9 jpeg 100 > foo.jpeg + + $xpaset -p ds9 jpeg foo.jpeg + $xpaset -p ds9 jpeg new foo.jpeg + $xpaset -p ds9 jpeg slice foo.jpeg + + $cat foo.jpeg | xpaset ds9 jpeg# not available windows + $cat foo.jpeg | xpaset ds9 jpegnew# not available windows + $cat foo.jpeg | xpaset ds9 jpegslice# not available windows +
lock
+
Lock all other frames to the current frame.
+ Syntax: + lock[frame <coordsys>|none] +     [crosshair <coordsys>|none] +     [crop <coordsys>|none] +     [slice <coordsys>|none]] +     [bin [yes|no]] +     [axes [yes|no]] +     [scale [yes|no]] +     [scalelimites [yes|no]] +     [colorbar [yes|no]] +     [block [yes|no]] +     [smooth [yes|no]] +     [3d [yes|no]] + + Example: + $xpaget -p ds9 lock frame + $xpaget -p ds9 lock crosshair + $xpaget -p ds9 lock crop + $xpaget -p ds9 lock slice + $xpaget -p ds9 lock bin + $xpaget -p ds9 lock axes + $xpaget -p ds9 lock scale + $xpaget -p ds9 lock scalelimits + $xpaget -p ds9 lock colorbar + $xpaget -p ds9 lock block + $xpaget -p ds9 lock smooth + $xpaget -p ds9 lock 3d + + $xpaset -p ds9 lock frame wcs + $xpaset -p ds9 lock crosshair wcs + $xpaset -p ds9 lock crop wcs + $xpaset -p ds9 lock slice wcs + $xpaset -p ds9 lock bin yes + $xpaset -p ds9 lock axes yes + $xpaset -p ds9 lock scale yes + $xpaset -p ds9 lock scalelimits yes + $xpaset -p ds9 lock colorbar yes + $xpaset -p ds9 lock block yes + $xpaset -p ds9 lock smooth yes + $xpaset -p ds9 lock 3d yes + + lower +
Lower in the window stacking order.
+ Syntax: + lower + + Example: + $xpaset -p ds9 lower + +
magnifier
+
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 zero|nonzero|nan|nonnan|range] +     [range <low> <high>] +     [transparency <value>] +     [system <coordsys>] +     [clear] +     [open|close] + + Example: + $xpaget ds9 mask color + $xpaget ds9 mask mark + $xpaget ds9 mask range + $xpaget ds9 mask system + $xpaget ds9 mask transparency + + $xpaset -p ds9 mask color red + $xpaset -p ds9 mask mark zero + $xpaset -p ds9 mask range 10 100 + $xpaset -p ds9 mask transparency 50 + $xpaset -p ds9 mask system wcs + $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[frame <coordsys>] +     [crosshair <coordsys>] +     [crop <coordsys>] +     [slice <coordsys>] +     [bin] +     [axes] +     [scale] +     [scalelimits] +     [colorbar] +     [block] +     [smooth] +     [3d] + + Example: + $xpaset -p ds9 match frame wcs + $xpaset -p ds9 match crosshair wcs + $xpaset -p ds9 match crop wcs + $xpaset -p ds9 match slicewcs + $xpaset -p ds9 match bin + $xpaset -p ds9 match axes + $xpaset -p ds9 match scale + $xpaset -p ds9 match scalelimits + $xpaset -p ds9 match colorbar + $xpaset -p ds9 match block + $xpaset -p ds9 match smooth + $xpaset -p ds9 match 3d + + mecube +
Load FITS multiple extension file as data cube.
+
+ Syntax: + mecube [new] [<filename>] + + Example: + $xpaget ds9 mecube > foo.fits + + $xpaset -p ds9 mecube foo.fits + $xpaset -p ds9 mecube new foo.fits + + $cat foo.fits | xpaset ds9 mecube + $cat foo.fits | xpaset ds9 mecube new +
minmax
+
This is how DS9 determines the min and max data values + from the data. SCAN will scan all data. DATAMIN + and IRAFMIN will use the values of the keywords if + present.
+
+ Syntax: + minmax [scan|sample|datamin|irafmin] +     [mode scan|sample|datamin|irafmin] +     [interval #] + + 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 100 + +
mode
+
Controls the first mouse button mode.
+ Syntax: + mode + [none|region|crosshair|colorbar|pan|zoom|rotate|catalog|examine|3d] + + Example: + $xpaget ds9 mode + $xpaset -p ds9 mode crosshair
+
mosaic
+
Load FITS mosaic segment into current frame.
+ Syntax: + mosaic [wcs|wcsa...wcsz|iraf] [new|mask] [<filename>] + + Example: + $xpaget ds9 mosaic > foo.fits + + $xpaset -p ds9 mosaic foo.fits + $xpaset -p ds9 mosaic wcs foo.fits + $xpaset -p ds9 mosaic wcs new foo.fits + $xpaset -p ds9 mosaic wcs mask foo.fits + + $cat foo.fits | xpaset ds9 mosaic + $cat foo.fits | xpaset ds9 mosaic wcs + $cat foo.fits | xpaset ds9 mosaic wcs new + $cat foo.fits | xpaset ds9 mosaic wcs mask + +
mosaicimage
+
Load FITS mosaic image into current frame.
+ Syntax: + mosaicimage [wcs|wcsa...wcsz|iraf|wfpc2] [new|mask] + [<filename>] + + Example: + $xpaget ds9 mosaicimage > foo.fits + + $xpaset -p ds9 mosaicimage foo.fits + $xpaset -p ds9 mosaicimage wcs foo.fits + $xpaset -p ds9 mosaicimage wcs new foo.fits + $xpaset -p ds9 mosaicimage wcs mask foo.fits + + $cat foo.fits | xpaset ds9 mosaicimage + $cat foo.fits | xpaset ds9 mosaicimage wcs + $cat foo.fits | xpaset ds9 mosaicimage wcs new + $cat foo.fits | xpaset ds9 mosaicimage wcs mask + +
movie
+
+
Create a movie from snap shots of the DS9 window. A slice + movie cycles though all slices of a cube. A frame + movie cycles through all active frames. A 3d movie + cycles through specified viewing angles. The default action is slice. + Movie types are either MPEG or Animated GIF, + with default MPEG. Optional parameters for 3d: + number of frames, azimuth from/to, elevation from/to, slice + from/to, oscillate/repeat times.
+ Syntax: + movie [slice|frame|3d][mpeg|gif] <filename> + movie 3d [mpeg|gif] <filename> + [number|azfrom|azto|elfrom|elto|slfrom|slto|oscillate|repeat + <#>] + + Example: + $xpaset -p ds9 movie slice mpeg ds9.mpg + $xpaset -p ds9 movie frame gif ds9.gif + $xpaset -p ds9 movie 3d mpeg ds9.mpg number 10 azfrom -60 azto + 60 oscillate 1 + +
multiframe
+
Load FITS multiple extension file as multiple images.
+
+ Syntax: + multiframe [<filename>] + + Example: + $xpaset -p ds9 multiframe foo.fits + + $cat foo.fits | xpaset ds9 multiframe# not available windows
+
nameserver
+
Support Name Server functions. Coordinates are in fk5.
+ Syntax: + nameserver [<object>] +     [name <object>] +     + [serverned-sao|ned-cds|simbad-sao|simbad-cds|vizier-sao|vizier-cds] +     [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
+
nan
+
Set image not-a-number color.
+ Syntax: + nan <color> + + Example: + $xpaget ds9 nan + + $xpaset -p ds9 nan red + +
nrrd
+
Load an NRRD (Nearly Raw Raster Data) file. Optional parameter: + array endian.
+
+ Syntax: + nrrd [native|little|big] + nrrd [new|mask] [<filename>] + + Example: + $xpaget ds9 nrrd + $xpaget ds9 nrrd big + + $xpaset -p ds9 nrrd foo.nrrd + $xpaset -p ds9 nrrd new foo.nrrd + $xpaset -p ds9 nrrd mask foo.nrrd + + $cat foo.nrrd | xpaset ds9 nrrd + $cat foo.nrrd | xpaset ds9 nrrdnew + $cat foo.nrrd | xpaset ds9 nrrd mask +
nvss
+
Support for NRAO VLA Sky Survey.
+ Syntax: + nvss [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # 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 + $xpaset -p ds9 nvss m31 + $xpaset -p ds9 nvss name m31 + $xpaset -p ds9 nvss name clear + $xpaset -p ds9 nvss 00:42:44.404 +41:16:08.78 + $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 [orient portrait|landscape] +     [scale <numberic>] +     [size letter|legal|tabloid|poster|a4] + + Example: + $xpaget ds9 pagesetup orient + $xpaget ds9 pagesetup scale + $xpaget ds9 pagesetup size + + $xpaset -p ds9 pagesetup orient portrait + $xpaset -p ds9 pagesetup scale 50 + $xpaset -p ds9 pagesetup size poster + +
pan
+
Controls the current image cursor location for the current + frame.
+ Syntax: + pan [<coordsys> [<skyframe>] [<skyformat>]] # + get current coords + + pan [<x> <y> <coordsys> [<skyframe>]] # + relative +     [to <x> <y> <coordsys> + [<skyframe>]] # absolute +     [open|close] + + Example: + $xpaget ds9 pan # get current image coords + $xpaget ds9 pan wcs fk4 sexagesimal # get current 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. 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 x and y + errors +
+
To create a new plot, use the plot new command.
+ Syntax: + # create new empty plot window + plot [] +     [line|bar|scatter] +     [new] +     [new line|bar|scatter] +     [new name <plotname>] +     [new name <plotname> line|bar|scatter] + + # create new plot with data from stdin + plot[new <title> <xaxis label> <yaxis + label>xy|xyex|xyey|xyexey] +     [new line|bar|scatter <title> <xaxis + label> <yaxis label>xy|xyex|xyey|xyexey] +     [newname <plotname><title> + <xaxis label> <yaxis label>xy|xyex|xyey|xyexey] +     [newname <plotname>line|bar|scatter + <title> <xaxis label> <yaxis + label>xy|xyex|xyey|xyexey] + + # create new plot with data from stdin which includes title/dim + headers + plot [new stdin] +     [new line|bar|scatter stdin] +     [new name <plotname> stdin] +     [new name + <plotname>line|bar|scatterstdin] + + #load data into existing plot from stdin + plot [[<plotname>] data xy|xyex|xyey|xyexey] + + # existing plot + plot [[<plotname>] load <filename> + xy|xyex|xyey|xyexey] +     [[<plotname>] save <filename>] +     [[<plotname>] layout + grid|row|column|strip] +     [[<plotname>] layout strip scale + <percent>] +     [[<plotname>] add graph + line|bar|scatter] +     [[<plotname>] select graph + <graph>] +     [[<plotname>] delete graph] +     [[<plotname>] select dataset + <dataset>] +     [[<plotname>] delete dataset] +     [[<plotname>] duplicate] +     [[<plotname>] stats yes|no] +     [[<plotname>] list yes|no] +     [[<plotname>] loadconfig + <filename>] +     [[<plotname>] saveconfig + <filename>] +     [[<plotname>] pagesetup orient + portrait|landscape] +     [[<plotname>] pagesetup size + letter|legal|tabloid|poster|a4] +     [[<plotname>] print] +     [[<plotname>] print destination + printer|file] +     [[<plotname>] print command + <command>] +     [[<plotname>] print filename + <filename>] +     [[<plotname>] print color rgb|gray] +     [[<plotname>] close] +     [[<plotname>] mode pointer|zoom] + + # export + plot [[<plotname>] export <filename>] +     [[<plotname>] export gif|tiff|jpeg|png + <filename>] +     [[<plotname>] export jpeg + <filename> [1-100]] +     [[<plotname>] export tiff + <filename> none|jpeg|packbits|deflate]] + + # configure graph + plot [[<plotname>] axis x|y grid yes|no] +     [[<plotname>] axis x|y log yes|no] +     [[<plotname>] axis x|y flip yes|no] +     [[<plotname>] axis x|y auto yes|no] +     [[<plotname>] axis x|y min + <value>] +     [[<plotname>] axis x|y max + <value>] +     [[<plotname>] axis x|y format + <string>] +     [[<plotname>] background <value>] +     [[<plotname>] legend yes|no] +     [[<plotname>] legend position + right|left|top|bottom|plotarea] +     [[<plotname>] font title|labels|numbers + font times|helvetica|courier] +     [[<plotname>] font title|labels|numbers + size <value>] +     [[<plotname>] font title|labels|numbers + weight normal|bold] +     [[<plotname>] font title|labels|numbers + slant roman|italic] +     [[<plotname>] title <string>] +     [[<plotname>] title x|y <string>] +     [[<plotname>] barmode + normal|stacked|aligned|overlap] + + # configure current dataset + plot[[<plotname>] show yes|no] +     [[<plotname>] shape + none|circle|square|diamond|plus|splus|scross|triangle|arrow] +     [[<plotname>] shape fill yes|no] +     [[<plotname>] shape color + <value>] +     [[<plotname>] smooth + step|linear|cubic|quadratic|catrom] +     [[<plotname>] color <value>] +     [[<plotname>] width <value>] +     [[<plotname>] dash yes|no] +     [[<plotname>] error yes|no] +     [[<plotname>] error color + <value>] +     [[<plotname>] error cap yes|no] +     [[<plotname>] error width + <value>] +     [[<plotname>] name <string>] + + Example: + # return all plotnames + $xpaget ds9 plot + + # create new empty plot window + $xpaset -p ds9 plot + $xpaset -p ds9 plot bar + $xpaset -p ds9 plot new + $xpaset -p ds9 plot new bar + $xpaset -p ds9 plot new name foo + $xpaset -p ds9 plot new name foo bar + + # create new plot with data from stdin + $cat xy.dat | xpaset ds9 plot new {The Title} {X Axis} {Y Axis} + xy + $cat xy.dat | xpaset ds9 plot new bar {The Title} {X Axis} {Y + Axis} xy + $cat xy.dat | xpaset ds9 plot new name foo {The Title} {X Axis} + {Y Axis} xy + $cat xy.dat | xpaset ds9 plot new name foo bar {The Title} {X + Axis} {Y Axis} xy + + # create new plot with data from stdin which includes title/dim + headers + $cat stdin.2.dat | xpaset ds9 plot new stdin + $cat stdin.2.dat | xpaset ds9 plot new line stdin + $cat stdin.2.dat | xpaset ds9 plot new name foo stdin + $cat stdin.2.dat | xpaset ds9 plot new name foo line stdin + + #load data into existing plot from stdin + $cat xy.dat | xpaset ds9 plot data xy + $cat xy.dat | xpaset ds9 plot foo data xy + + # existing plot + $xpaget ds9 plot layout + $xpaget ds9 plot layout strip scale + $xpaget ds9 plot select graph + $xpaget ds9 plot select dataset + $xpaget ds9 plot stats + $xpaget ds9 plot list + $xpaset -p ds9 plot load xy.dat xy + $xpaset -p ds9 plot save foo.dat + $xpaset -p ds9 plot layout strip + $xpaset -p ds9 plot layout strip scale 30 + $xpaset -p ds9 plot add graph scatter + $xpaset -p ds9 plot select graph 1 + $xpaset -p ds9 plot delete graph + $xpaset -p ds9 plot select dataset 1 + $xpaset -p ds9 plot delete dataset + $xpaset -p ds9 plot duplicate + $xpaset -p ds9 plot stats yes + $xpaset -p ds9 plot list yes + $xpaset -p ds9 plot loadconfig foo.plt + $xpaset -p ds9 plot saveconfig foo.plt + $xpaset -p ds9 plot pagesetup orient portrait + $xpaset -p ds9 plot pagesetup size letter + $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 color rgb + $xpaset -p ds9 plot close + + # plot mode + $xpaget ds9 plot mode + $xpaset -p ds9 plot mode pointer + + # export plot + $xpaset -p ds9 plot export tiff foo.tiff jpeg + $xpaset -p ds9 plot export jpeg foo.jpeg 75 + $xpaset -p ds9 plot export png foo.png + + # configure plot + $xpaget ds9 plot axis x grid + $xpaget ds9 plot axis x log + $xpaget ds9 plot axis x flip + $xpaget ds9 plot axis x auto + $xpaget ds9 plot axis x min + $xpaget ds9 plot axis x max + $xpaget ds9 plot axis x format + $xpaget ds9 plot background + $xpaget ds9 plot legend + $xpaget ds9 plot legend position + $xpaget ds9 plot font numbers font + $xpaget ds9 plot font numbers size + $xpaget ds9 plot font numbers weight + $xpaget ds9 plot font numbers slant + $xpaget ds9 plot title + $xpaget ds9 plot title xaxis + $xpaget ds9 plot title yaxis + $xpaset -p ds9 plot axis x grid yes + $xpaset -p ds9 plot axis x log yes + $xpaset -p ds9 plot axis x flip yes + $xpaset -p ds9 plot axis x auto no + $xpaset -p ds9 plot axis x min 1 + $xpaset -p ds9 plot axis x max 100 + $xpaset -p ds9 plot axis x format {%f} + $xpaset -p ds9 plot background white + $xpaset -p ds9 plot legend yes + $xpaset -p ds9 plot legend position left + $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 title {This is a Title} + $xpaset -p ds9 plot title x {X Axis} + $xpaset -p ds9 plot title y {Y Axis} + $xpaset -p ds9 plot title legend {This is the Legend} + + # bar plot + $xpaget ds9 plot barmode + + $xpaset -p ds9 plot barmode aligned + + # configure current dataset + $xpaget ds9 plot show + $xpaget ds9 plot shape + $xpaget ds9 plot shape fill + $xpaget ds9 plot shape color + $xpaget ds9 plot smooth + $xpaget ds9 plot color + $xpaget ds9 plot width + $xpaget ds9 plot dash + $xpaget ds9 plot error + $xpaget ds9 plot error color + $xpaget ds9 plot error cap + $xpaget ds9 plot error width + $xpaget ds9 plot name + + $xpaset -p ds9 plot show yes + $xpaset -p ds9 plot shape circle + $xpaset -p ds9 plot shape fill no + $xpaset -p ds9 plot shape color cyan + $xpaset -p ds9 plot smooth step + $xpaset -p ds9 plot color red + $xpaset -p ds9 plot width 2 + $xpaset -p ds9 plot dash yes + $xpaset -p ds9 plot error yes + $xpaset -p ds9 plot error color red + $xpaset -p ds9 plot error cap yes + $xpaset -p ds9 plot error width 2 + $xpaset -p ds9 plot name {My Data} + + png +
Load PNG image into current frame.
+
+ Syntax: + png [new|slice] [<filename>] + + Example: + $xpaget ds9 png > foo.png + + $xpaset -p ds9 png foo.png + $xpaset -p ds9 png new foo.png + $xpaset -p ds9 png slice foo.png + + $cat foo.png | xpaset ds9 png + $cat foo.png | xpaset ds9 png new + $cat foo.png | xpaset ds9 png slice
+
precision
+
Set region and coordinate output format precision.
+ Syntax: + precision +<linear><degree><hms><dms><arcmin><arcsec> + + Example: + $xpaget ds9 precision + + $xpaset -p ds9 precision 8 10 4 3 5 3
+
prefs
+
Controls various preference settings.
+ Syntax: + prefs [clear] +     [irafalign yes|no] + + Example: + $xpaget ds9 prefs irafalign + + $xpaset -p ds9 prefs clear + $xpaset -p ds9 prefs iraf yes + +
preserve
+
Preserve the follow attributes while loading a new image.
+ Syntax: + preserve [pan yes|no] +       [regions yes|no] + + Example: + $xpaget ds9 preserve pan + $xpaget ds9 preserve regions + + $xpaset -p ds9 preserve pan yes + $xpaset -p ds9 preserve regions yes + +
psprint
+
Invokes postscript printing. Please see print for further details.
+
print
+
Controls printing. Use print option to set printing options. + Only available for XPA_METHOD local.
+ Syntax: + print [destination printer|file] +     [command <command>] +     [filename <filename>] +     [color rgb|cmyk|gray] +     [level 1|2|3] +     [resolution + 72|screen|96|144|150|225|300|600|1200] + + Example: + $xpaget ds9 print destination + $xpaget ds9 print command + $xpaget ds9 print filename + $xpaget ds9 print color + $xpaget ds9 print level + $xpaget ds9 print resolution + + $xpaset -p ds9 print + $xpaset -p ds9 print destination file + $xpaset -p ds9 print command lp + $xpaset -p ds9 print filename foo.ps + $xpaset -p ds9 print color cmyk + $xpaset -p ds9 print level 2 + $xpaset -p ds9 print resolution 96 +
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]] +     [epsilon <integer>] +     [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 invert] +     [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>] +     [fixed|edit|rotate|delete yes|no] +     [include|exclude|source|background] +     [command <marker command>] +     [composite] +     [dissolve] +     [template <filename>] +     [template <filename> at <ra> + <dec> <coordsys> <skyframe>] +     [savetemplate <filename>] +     [groups] +     [group new] +     [group <tag> new] +     [group <tag> update] +     [group <tag> select] +     [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] +     [copy] +     [cut] +     [paste image|physical|wcs|wcsa...wcsz] +     [undo] +     [-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 epsilon + $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 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 | xpaset 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 epsilon 5 + $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 invert + $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 strip yes + $xpaset -p ds9 regions shape ellipse + $xpaset -p ds9 regions color red + $xpaset -p ds9 regions width 3 + $xpaset -p ds9 regions edit yes + $xpaset -p ds9 regions include + $xpaset -p ds9 regions command '{circle 100 100 20 # color=red}' + $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 new + $xpaset -p ds9 regions group foo new + $xpaset -p ds9 regions group foo update + $xpaset -p ds9 regions group foo select + $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 copy + $xpaset -p ds9 regions cut + $xpaset -p ds9 regions paste wcs + $xpaset -p ds9 regions undo + +
restore
+
Restore DS9 to a previous state from a backup save set.
+ Syntax: + restore <filename> + + Example: + $xpaset -p ds9 restore ds9.bck
+
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 + wcs|crop|slice|bin|scale|scalelimits|colorbar|block|smooth + [yes|no]] +     [open|close] + + Example: + $xpaget ds9 rgb channel + $xpaget ds9 rgb lock wcs + $xpaget ds9 rgb lock crop + $xpaget ds9 rgb lock slice + $xpaget ds9 rgb lock bin + $xpaget ds9 rgb lock scale + $xpaset ds9 rgb lock scalelimits + $xpaget ds9 rgb lock colorbar + $xpaget ds9 rgb lock block + $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 wcs yes + $xpaset -p ds9 rgb lock crop yes + $xpaset -p ds9 rgb lock slice yes + $xpaset -p ds9 rgb lock bin yes + $xpaset -p ds9 rgb lock scale yes + $xpaset -p ds9 rgb lock scalelimits yes + $xpaset -p ds9 rgb lock colorbar yes + $xpaset -p ds9 rgb lock block yes + $xpaset -p ds9 rgb lock smooth yes + $xpaset -p ds9 rgb open + $xpaset -p ds9 rgb close
+
rgbarray
+
Load raw data array cube into rgb frame.
+
+ Syntax: + rgbarray [native|big|little] + rgbarray [new] +[[xdim=<x>,ydim=<y>|dim=<dim>],[zdim=3],bitpix=<b>,skip=<s>,endian=[little|big]] + + Example: + $xpaget ds9 rgbarray > foo.arr + + $xpaget ds9 rgbarray little > foo.arr + $xpaset -p ds9 rgbarray + foo.arr[dim=512,zdim=3,bitpix=-32,endian=little] + $xpaset -p ds9 rgbarray new + foo.arr[dim=512,zdim=3,bitpix=-32,endian=little] + + $cat foo.arr | xpaset ds9 rgbarray + [dim=512,zdim=3,bitpix=-32,endian=little] + $cat foo.arr | xpaset ds9 rgbarray new + [dim=512,zdim=3,bitpix=-32,endian=little]
+
rgbcube
+
Load FITS rgbcube into rgb frame.
+
+ Syntax: + rgbcube [new] [<filename>] + + Example: + $xpaget ds9 rgbcube > foo.fits + + $xpaset -p ds9 rgbcube foo.fits + $xpaset -p ds9 rgbcube new foo.fits + + $cat foo.fits | xpaset ds9 rgbcube + $cat foo.fits | xpaset ds9 rgbcubenew
+
rgbimage
+
Load FITS rgbimage into rgb frame.
+
+ Syntax: + rgbimage [new] [<filename>] + + Example: + $xpaget ds9 rgbimage > foo.fits + + $xpaset -p ds9 rgbimage foo.fits + $xpaset -p ds9 rgbimage new foo.fits + + $cat foo.fits | xpaset ds9 rgbimage + $cat foo.fits | xpaset ds9 rgbimage new + +
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 + +
save
+
+
Save loaded image data of current frame as FITS.
+ Syntax: + save [fits|rgbimage|rgbcube|mecube|mosaic|mosaicimage] + <filename> [image|table|slice] + + Example: + $xpaset -p ds9 save foo.fits + $xpaset -p ds9 save fits foo.fits image + $xpaset -p ds9 save fits foo.fits table + $xpaset -p ds9 save fits foo.fits slice + $xpaset -p ds9 save rgbimage foo.fits + $xpaset -p ds9 save rgbcube foo.fits + $xpaset -p ds9 save mecube foo.fits + $xpaset -p ds9 save mosaic foo.fits + $xpaset -p ds9 save mosaicimage foo.fits
+
saveimage
+
+
Create a snap shot of the current DS9 window and save in + specified image format. If no format specified, the file name + extension is used to determine the output format. Optional + parameters: jpeg quality (1-100) and tiff + compression method.
+ Syntax: + saveimage [fits|eps|gif|tiff|jpeg|png]<filename> + saveimage <filename>.jpeg [1-100] + saveimage <filename>.tiff [none|jpeg|packbits|deflate] + + Example: + $xpaset -p ds9 saveimage ds9.tiff + $xpaset -p ds9 saveimage jpeg ds9.jpeg 75
+
scale
+
Controls the limits and color scale distribution.
+ Syntax: + scale [linear|log|pow|sqrt|squared|asinh|sinh|histequ] +     [log exp <value>] +     [datasec yes|no] +     [limits <minvalue> <maxvalue>] +     [mode minmax|<value>|zscale|zmax] +     [scope local|global] +     [match] +     [match limits] +     [lock [yes|no]] +     [lock limits [yes|no]] +     [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 + $xpaget ds9 scale lock + $xpaget ds9 scale lock limits + + $xpaset -p ds9 scale linear + $xpaset -p ds9 scale log exp 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 match + $xpaset -p ds9 scale match limits + $xpaset -p ds9 scale lock yes + $xpaset -p ds9 scale lock limits yes + $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>]] +     [mosaicimage [iraf|wcs|wcsa...wcsz|wfpc2] + [key|shmid] <id> [<filename>]] +     [mosaic [iraf|wcs|wcsa...wcsz] [key|shmid] + <id> [<filename>]] +     [rgbcube [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>]] + + 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 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 mosaic iraf key 100 foo + $xpaset -p ds9 shm mosaic wcs key 100 foo + $xpaset -p ds9 shm rgbcube key 100 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] + + sia
+ +
Support for VO Simple Image Access protocol. The first command + will create a new search. All other commands operated on the + last search created, unless indicated otherwise.
+ Syntax: + sia + [2mass|akari|astrowise|cadc|cxc|hla|mast|sdss|skyview|tgssadr] +     [<ref>] [cancel] +     [<ref>] [clear] +     [<ref>] [close] +     [<ref>] [coordinate <ra> + <dec> <coordsys>] +     [<ref>] [crosshair] +     [<ref>] [export sb|tsv + <filename>] +     [<ref>] [name <object>] +     [<ref>] [print] +     [<ref>] [retrieve] +     [<ref>] [save <filename>] +     [<ref>] [radius <value> + degrees|arcmin|arcsec] +     [<ref>] [sky <skyframe>] +     [<ref>] [skyformat <skyformat>] +     [<ref>] [system <coordsys>] +     [<ref>] [update] + + Example: + $xpaget ds9 sia + + $xpaset -p ds9 sia 2mass + $xpaset -p ds9 sia cancel + $xpaset -p ds9 sia clear + $xpaset -p ds9 sia close + $xpaset -p ds9 sia coordinate 202.48 47.21 fk5 + $xpaset -p ds9 sia crosshair + $xpaset -p ds9 sia export tsv bar.tsv + $xpaset -p ds9 sia name m51 + $xpaset -p ds9 sia print + $xpaset -p ds9 sia retrieve + $xpaset -p ds9 sia save foo.xml + $xpaset -p ds9 sia radius 1 degrees + $xpaset -p ds9 sia sky fk5 + $xpaset -p ds9 sia skyformat degrees + $xpaset -p ds9 sia system wcs + $xpaset -p ds9 sia update + + 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>|clear] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [pixels <width> <height>] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [survey <survey>] +     [open|close] + + Example: + $xpaget ds9 skyview name + $xpaget ds9 skyview coord + $xpaget ds9 skyview size + $xpaget ds9 skyview pixels + $xpaget ds9 skyview save + $xpaget ds9 skyview frame + $xpaget ds9 skyview survey + + $xpaset -p ds9 skyview + $xpaset -p ds9 skyview m31 + $xpaset -p ds9 skyview name m31 + $xpaset -p ds9 skyview name clear + $xpaset -p ds9 skyview 00:42:44.404 +41:16:08.78 + $xpaset -p ds9 skyview size 60 60 arcmin + $xpaset -p ds9 skyview pixels 600 600 + $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.
+
Boxcar width =2*radius+1 + Tophat diameter =2*radius+1 + Gaussian diameter =2*radius+1,mean=0 + Elliptical Gaussian diameter =2*radius+1,mean=0 + + Syntax: + smooth [] +     [yes|no] +     [function boxcar|tophat|gaussian] +     [radius <value>] +     [radiusminor <value>] +     [sigma <value>] +     [sigmaminor <value>] +     [angle <value>] +     [match] +     [lock [yes|no]] +     [open|close] +
+
Example: + $xpaget ds9 smooth + $xpaget ds9 smooth function + $xpaget ds9 smooth radius + $xpaget ds9 smooth radiusminor + $xpaget ds9 smooth sigma + $xpaget ds9 smooth sigmaminor + $xpaget ds9 smooth lock
+
$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 radiusminor 4 + $xpaset -p ds9 smooth sigma 2.0 + $xpaset -p ds9 smooth sigmaminor 2.0 + $xpaset -p ds9 smooth angle 45 + $xpaset -p ds9 smooth match + $xpaset -p ds9 smooth lock yes + $xpaset -p ds9 smooth open + $xpaset -p ds9 smooth close
+
source
+
Source TCL code from a file. Only available for XPA_METHOD + local.
+ Syntax: + source [<filename>] + + Example: + $xpaset -p ds9 source foo.tcl +
tcl
+
Execute one tcl command. Only available for XPA_METHOD + local.
+ Syntax: + tcl [<tcl command>] + + Example: + $echo 'puts "Hello, World"' | xpaset ds9 tcl + $xpaset -p ds9 tcl {puts {Hello, World}} + +
threads
+
Set number of process threads for functions which are + multi-threaded.
+
+ Syntax: + threads # + + Example: + $xpaget ds9 threads + + $xpaset -p ds9 threads 8
+
tiff
+
Load TIFF image into current frame. Optional parameters: tiff + compression method.
+ Syntax: + tiff [new|slice] [<filename>] [none|jpeg|packbits|deflate] + + Example: + $xpaget ds9 tiff > foo.tiff + $xpaget ds9 tiff jpeg > foo.tiff + + $xpaset -p ds9 tiff foo.tiff + $xpaset -p ds9 tiff new foo.tiff + $xpaset -p ds9 tiff slice foo.tiff + + $cat foo.tiff | xpaset ds9 tiff + $cat foo.tiff | xpaset ds9 tiff new + $cat foo.tiff | xpaset ds9 tiff slice +
tile
+
Controls the tile display mode.
+ Syntax: + tile [] +     [yes|no] +     [mode grid|column|row] +     [grid] +     [grid mode automatic|manual] +     [grid direction x|y] +     [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 direction + $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 direction x + $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] + + 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
+
url
+
Load FITS from URL into the current frame
+ Syntax: + url <url> + + Example: + $xpaset -p ds9 url http://foo.bar.edu/foo.fits + +
version
+
Returns the current version of DS9.
+ Syntax: + version + + Example: + $xpaget ds9 version +
view
+
Controls the GUI.
+ Syntax: + view [layout horizontal|vertical] +     [keyvalue <string>] +     [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] +     [keyword yes|no] +     [minmax yes|no] +     [lowhigh yes|no] +     [units yes|no] +     [image|physical|wcs|wcsa...wcsz yes|no] +     [frame yes|no] +     [red yes|no] +     [green yes|no] +     [blue yes|no] + + Example: + $xpaget ds9 view layout + $xpaget ds9 view keyvalue + $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 keyword + $xpaget ds9 view minmax + $xpaget ds9 view lowhigh + $xpaget ds9 view units + $xpaget ds9 view image + $xpaget ds9 view wcsa + $xpaget ds9 view red + $xpaget ds9 view frame + + $xpaset -p ds9 view layout vertical + $xpaset -p ds9 view keyvalue BITPIX + $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 keyword yes + $xpaset -p ds9 view minmax yes + $xpaset -p ds9 view lowhigh yes + $xpaset -p ds9 view units yes + $xpaset -p ds9 view wcsa yes + $xpaset -p ds9 view frame yes + $xpaset -p ds9 view red yes + $xpaset -p ds9 view green yes + $xpaset -p ds9 view blue yes
+
+ vla +
Support for VLA Sky Survey.
+ Syntax: + vla [] +     [<object>] +     [name <object>|clear] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [survey first|stripe82] +     [open|close] + + Example: + $xpaget ds9 vla name + $xpaget ds9 vla coord + $xpaget ds9 vla size + $xpaget ds9 vla save + $xpaget ds9 vla frame + $xpaget ds9 vla survey + + $xpaset -p ds9 vla + $xpaset -p ds9 vla m31 + $xpaset -p ds9 vla name m31 + $xpaset -p ds9 vla name clear + $xpaset -p ds9 vla 00:42:44.404 +41:16:08.78 + $xpaset -p ds9 vla size 60 60 arcmin + $xpaset -p ds9 vla save yes + $xpaset -p ds9 vla frame current + $xpaset -p ds9 vla update frame + $xpaset -p ds9 vla survey stripe82 + $xpaset -p ds9 vla open + $xpaset -p ds9 vla close
+
vlss
+
Support for NRAO VLSS Sky Survey.
+ Syntax: + vlss [] +     [<object>] +     [name <object>] +     [<ra> <dec>] # in wcs fk5 +     [size <width> <height> + degrees|arcmin|arcsec] +     [save yes|no] +     [frame new|current] +     [update frame|crosshair] +     [open|close] + + Example: + $xpaget ds9 vlss name + $xpaget ds9 vlss coord + $xpaget ds9 vlss size + $xpaget ds9 vlss save + $xpaget ds9 vlss frame + + $xpaset -p ds9 vlss + $xpaset -p ds9 vlss m31 + $xpaset -p ds9 vlss name m31 + $xpaset -p ds9 vlss name clear + $xpaset -p ds9 vlss 00:42:44.404 +41:16:08.78 + $xpaset -p ds9 vlss size 60 60 arcmin + $xpaset -p ds9 vlss save yes + $xpaset -p ds9 vlss frame current + $xpaset -p ds9 vlss update frame + $xpaset -p ds9 vlss open + $xpaset -p ds9 vlss close
+
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 [[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 fk5 + $xpaset -p ds9 wcs sky fk5 + $xpaset -p ds9 wcs sexagesimal + $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 + $xpaset -p ds9 open + $xpaset -p ds9 close +
+ $cat foo.wcs | xpaset ds9 wcs replace + $cat foo.wcs | xpaset ds9 wcs append + $echo "OBJECT = 'foobar'" | xpaset ds9 wcs append + +
web
+
Display specified URL in the web display.
+ Syntax: + web [] +     [<url>] +     [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
+
xpa
+
Configure XPA.
+ Syntax: + -xpa [disconnect] +     [info] + + Example: + $xpaget ds9 info + + $xpaset -p ds9 disconnect + $xpaset -p ds9 info + +
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>] +     [in] +     [out] +     [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 in + $xpaset -p ds9 zoom out + $xpaset -p ds9 zoom to fit + $xpaset -p ds9 zoom open + $xpaset -p ds9 zoom close +

+ -- cgit v0.12