DS9(1)

NAME

ds9 - image tool for astronomy

SYNOPSIS

ds9 [options]

DESCRIPTION

DS9 DS9 is the modern image tool used by astronomers for visualization of astronomical data. It supports a plethora of command line options, which may be used in a script-like fashion. An instance of the program is entirely controllable from the commandline with the XPA tools.

OPTIONS

-help Displays list of Command Line Options. Users of csh and

tcsh may

have to quote.

Syntax

-?
-- -help

Example:

ds9 -- -help

ds9 '-?'

-2mass Support for 2MASS Digital Sky Survey. The first three

options will

download an image based on the name or specified fk5

coordinate.

The remaining options are used to configure downloads.

Syntax

-2mass [<object> ]
[name <object> ]
[coord <ra> <dec> ] # in wcs fk5
[survey j| h| k]
[size <radius> ] # in arcsec

Example:

ds9 -2mass m31

ds9 -2mass name m31

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

ds9 -2mass survey j

ds9 -2mass size 600

-about Get DS9 credits.

Syntax

-about

Example:

ds9 -about

-analysis

Load analysis file.

Syntax

-analysis filename

Example:

ds9 -analysis my.analysis

-array Load an array.

Syntax

-array
<filename> [[xdim=<x> , ydim=<y> | dim=<dim> ] ,

zdim=<z> , bitpix=<b> , skip=

<s> ,
arch=[littleendian| bigendian] ]

Example:

ds9 -array bar.arr[xdim=512, ydim=512, zdim=1, bitpix=16] # load

512x512 short

ds9 -array bar.arr[dim=256, bitpix=-32, skip=4] # load
256x256

float with 4 byte head

ds9 -array bar.arr[dim=512, bitpix=32, arch=littleendian] # load

512x512 long, intel

-bin Controls binning factor, binning buffer size, and bin

ning

function for binning FITS bin tables.

Syntax

-bin [about <x> <y> ]
[buffersize <value> ]
[cols <x> <y> ]
[factor <value> [<value> ] ]
[depth <value> ]
[filter <string> ]
[function average| sum]
[to fit]

Example:

ds9 -bin about 4096 4096

ds9 -bin buffersize 512

ds9 -bin cols detx dety

ds9 -bin factor 4

ds9 -bin factor 4 2

ds9 -bin depth 10

ds9 -bin filter '{pha > 5}'

ds9 -bin function sum

ds9 -bin to fit

-blink Activates Blink Mode.

Syntax

-blink

Example:

ds9 -blink

-blue For RGB frames, sets the current color channel to blue.

Syntax

-blue

Example:

ds9 -blue foo.fits

-catalog

Support for catalogs.

Syntax

-catalog [cds
sao| hst| gsc| tycho| ac| ua2| ub1| ucac2| 2mass|

denis| rosat| rosf| first]

[cds <catalogid> ]
[load <filename> ]
[<catname> ] [name <object> ]
[<catname> ] [coordinate <ra> <dec> <coordinate sys

tem> ]

[<catname> ] [size <width> <height> degrees| arcmin|

arcsec]

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

Example:

ds9 -catalog cds 2mass

ds9 -catalog cds "I/252"

ds9 -catalog load foo.cat

ds9 -catalog cat2mass symbol color red

ds9 -catalog name m51

ds9 -catalog coordinate 202.48 47.21 fk5

ds9 -catalog size 22 22 arcmin

ds9 -catalog save bar.cat

ds9 -catalog filter "$Jmag> 10"

ds9 -catalog filter load foo.flt

ds9 -catalog clear

ds9 -catalog retreive

ds9 -catalog cancel

ds9 -catalog print

ds9 -catalog close

ds9 -catalog server sao

ds9 -catalog symbol shape "{boxcircle point}"

ds9 -catalog symbol color red

ds9 -catalog symbol load foo.sym

ds9 -catalog sort "Jmag" incr

ds9 -catalog maxrows 2000

ds9 -catalog allcols

-cmap Controls the colormap for the current frame. The colormap

name is

not case sensitive. A valid contrast value is from 0 to

10 and

bias value from 0 to 1.

Syntax

-cmap [<colormap> ]
[file <filename> ]
[invert yes| no]
[value <contrast> <bias> ]

Example:

ds9 -cmap Heat

ds9 -cmap file foo.sao

ds9 -cmap invert yes

ds9 -cmap value 5 .5

-contour

Controls contours in the current frame.

Syntax

-contour [yes| no]
[copy]
[clear]
[paste <coordinate system> [<sky frame> ] <color>

<width> ]

[load <filename> <coordinate system> [<sky frame> ]

<color

<width> ]
[save <filename> <coordinate system> [<sky frame> ] ]

Example:

ds9 -contour

ds9 -contour yes

ds9 -contour copy

ds9 -contour clear

ds9 -contour paste wcs fk4 red 2

ds9 -contour load foo.con wcs fk5 yellow 2

ds9 -contour save foo.con wcs fk5

-crosshair

Controls the current position of the crosshair in the
current

frame. DS9 is placed in crosshair mode when the

crosshair is set.

Syntax

-crosshair [x y <coordinate system> [<sky frame> ]

[<sky format> ] ]

Example:

ds9 -crosshair 100 100 physical # set crosshair in physical

ds9 -crosshair 345 58.8 wcs fk5 # set crosshair in wcs
coords

ds9 -crosshair 23:01:00 +58:52:51 wcs fk5

-datacube

Controls FITS datacube.

Syntax

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

Example:

ds9 -datacube play

ds9 -datacube last

ds9 -datacube 3

ds9 -datacube interval 2

-dss Support for Digital Sky Survey. The first three options

will

download an image based on the name or specified fk5

coordinate.

The remaining options are used to configure downloads.

Syntax

-dss [<object> ]
[name <object> ]
[coord <ra> <dec> ] # in wcs fk5
[server sao| stsci| eso]
[survey dss| dss2red| dss2blue]
[size <width> <height> ] # in arcmin

Example:

ds9 -dss m31

ds9 -dss name m31

ds9 -dss coord 00:42:44.404 +41:16:08.78

ds9 -dss server eso

ds9 -dss survey dss2red

ds9 -dss size 10 10

-exit

-fifo Set the name of the IRAF input and output fifos. The

default is

/dev/imt1. These fifos are used by IRAF to communicate

with DS9.

Syntax

-fifo name

Example:

ds9 -fifo /dev/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 FITS file.

Syntax

-fits <filename>

Example:

ds9 -fits foo.fits

-sfits Load split FITS file.

Syntax

-sfits <filename> <filename>

Example:

ds9 -sfits foo.hdr foo.arr

-frame Controls frame functions. Frames may be created,

deleted, reset,

and centered. While return the current frame number. If

you goto a

frame that does not exists, it will be created. If the

frame is

hidden, it will be shown. The 'frameno' option is

available for

backward compatibility.

Syntax

-frame [center [#| all] ]
[clear [#| all] ]
[new [rgb] ]
[delete [#| all] ]
[reset [#| all] ]
[refresh [#| all] ]
[hide [#| all] ]
[show [#| all] ]
[first]
[next]
[prev]
[last]
[frameno #]
[#]

Example:

ds9 -frame center

ds9 -frame center 1

ds9 -frame center all

ds9 -frame clear

ds9 -frame new

ds9 -frame new rgb

ds9 -frame delete

ds9 -frame reset

ds9 -frame refresh

ds9 -frame hide

ds9 -frame show 1

ds9 -frame first

ds9 -frame next

ds9 -frame prev

ds9 -frame last

ds9 -frame frameno 4

ds9 -frame 3

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

Syntax

-grid [yes| no]
[load <filename> ]
[save <filename> ]
[system <coordinate system> ]
[sky <sky frame> ]
[skyformat <skyformat> ]
[type analysis| publication]
[type axes interior| exterior]
[type numerics interior| exterior]
[view grid| axes| title| border| vertical yes| no]
[view axes numbers| tickmarks| label yes| no]

Example:

ds9 -grid

ds9 -grid yes

ds9 -grid load foo.grd

ds9 -grid save foo.grd

ds9 -grid system wcs

ds9 -grid sky fk5

ds9 -grid skyformat degrees

ds9 -grid type analysis

ds9 -grid type axes interior

ds9 -grid type numerics interior

ds9 -grid view grid yes

ds9 -grid view axes yes

ds9 -grid view axes numbers yes

ds9 -grid view axes tickmarks yes

ds9 -grid view axes label yes

ds9 -grid view title yes

ds9 -grid view border yes

ds9 -grid view vertical no

-height

Set the height of the image display window. Use the [89]
geometry

command to set the overall width and height of the ds9

window.

Syntax

-height [<value> ]

Example:

ds9 -height 512

-histequ

Select histogram equalization scale for current frame.

Syntax

-histequ

Example:

ds9 -histequ

-iconify

Toggles iconification.

Syntax

-iconify [yes| no]

Example:

ds9 -iconify yes

-inet_only

Only use the IRAF port number. This is the same as -fifo

none -unix none.

Syntax

-port_only

Example:

ds9 -port_only

-invert

Invert Colormap.

Syntax

-invert

Example:

ds9 -invert

-linear

Select Linear scale for current frame.

Syntax

-linear

Example:

ds9 -linear

-lock Lock frames.

Syntax

lock [crosshairs none| wcs| wcsa...wcsz| physical|

image]

Example:

ds9 -lock crosshairs wcs

-log Select LOG scale for current frame. This is the same

algorithm as

used in IRAF.

Syntax

-log

Example:

ds9 -log

-lower Lower ds9 in the window stacking order.

Syntax

-lower

Example:

ds9 -lower

-match Match all other frames to the current frame.

Syntax

-match [frames wcs| physical| image]
[colorbars]
[scales]

Example:

ds9 -match frames wcs

ds9 -match colorbars

ds9 -match scales

-medatacube

Load multiple extension FITS file as a data cube.

Syntax

-medatacube <filename>

Example:

ds9 -medatacube foo.fits

-minmax

This is how DS9 determines the min and max data values
from

the data. SCAN will scan all data. SAMPLE will sample

the data

every n samples. DATAMIN and IRAFMIN will use the values

of the

keywords if present. In general, it is recommended to

use SCAN

unless your computer is slow or your data files are very

large.

Select the increment interval for determining the min

and max

data values during sampling. The larger the interval,

the quicker

the process.

Syntax

-minmax []
[scan| sample| datamin| irafmin]
[mode auto| scan| sample| datamin| irafmin]
[interval <value> ]

Example:

ds9 -minmax

ds9 -minmax scan

ds9 -minmax mode sample

ds9 -minmax interval 10

-mode Select the current mode.

Syntax

-mode
[none| pointer| crosshair| colorbar| pan| zoom| rotate|

catalog| examine]

Example:

ds9 -mode crosshair

-mosaicimage

Load entire FITS Mosaic image composed of multiple extensions in

one FITS file. All extensions that are FITS Images and

are valid

FITS Mosaic Images will be loaded.

Syntax

-mosaicimage [iraf| wcs| wcsa...wcsz| wfpc2] <file

name>

Example:

ds9 -mosaicimage iraf bar.fits

ds9 -mosaicimage wcs bar.fits

ds9 -mosaicimage wcsa bar.fits

ds9 -mosaicimage wfpc2 hst.fits

-mosaicimagenext

Load entire FITS WCS Mosaic image composed of multiple
extensions

in one FITS file with out clearing the current frame.

All

extensions that are FITS Images and are valid FITS

Mosaic Images

will be loaded.

Syntax

-mosaicimagenext [iraf| wcs| wcsa...wcsz| wfpc2]

<filename>

Example:

ds9 -mosaicimagenext wcs bar.fits

-mosaic

Load FITS Mosaic image segment.

Syntax

-mosaic [iraf| wcs| wcsa...wcsz] <filename>

Example:

ds9 -mosaic iraf foo.fits

ds9 -mosaic wcs bar.fits

-smosaic

Load split FITS Mosaic image segment.

Syntax

-smosaic [iraf| wcs| wcsa...wcsz] <filename> <file

name>

Example:

ds9 -smosaic iraf foo.hdr foo.arr

ds9 -smosaic wcs foo.hdr foo.arr

-nameserver

Support Name Server functions. Coordinates are in fk5.

Syntax

-nameserver [<object> ]
[name <object> ]
[server ned-sao| ned-eso| simbad-sao| simbad-eso]
[skyformat degrees| sexagesimal]

Example:

ds9 -nameserver m31

ds9 -nameserver name m31

ds9 -nameserver server ned-sao

ds9 -nameserver skyformat sexagesimal

-orient

Controls the orientation of the current frame.

Syntax

-orient [none| x| y| xy]

Example:

ds9 -orient xy

-pagesetup

Controls Page Setup options.

Syntax

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

Example:

ds9 -pagesetup orientation portrait

ds9 -pagesetup pagescale scaled

ds9 -pagesetup pagesize poster

-pan Controls the current image cursor location for the cur

rent frame.

Syntax

-pan [x y <coordinate system> [<sky frame> ] [<sky

format> ]

[to x y <coordinate system> [<sky frame> ] [<sky for

mat> ]

Example:

ds9 -pan 200 200 image

ds9 -pan to 400 400 physical

ds9 -pan to 13:29:55 47:11:50 wcs fk5

-pixeltable

Display/Hide the pixel table.

Syntax

-pixeltable [yes| no]

Example:

ds9 -pixeltable yes

-plot Display and configure data plots. All plot commands take

an

optional second command, the plot name. Use xpaget plot

to retreive

all plot names. If no plot name is specified, the last

plot created

is assumed. Plot data is assumed to be a pair of coordi

nates, with

optional error values. The follow are valid data

descriptions:

xy x and y coordinates
xyex x, y coordinates with x errors
xyey x, y coordinates with y errors
xyexey x, y coordinates with both x and y errors
To create a new plot, use the plot new command. If the

second arg

is stdin, the title, x axis title, y axis title, and

dimension are

assumed to be on the first line of the data.

Syntax

# create new empty plot window
-plot []
[new [name <plotname> ] ]
# edit existing plot
-plot [<plotname> ] [close]
[<plotname> ] [clear]
[<plotname> ] [load <filename> xy| xyex| xyey|

xyexey]

[<plotname> ] [save <filename> ]
[<plotname> ] [loadconfig <filename> ]
[<plotname> ] [saveconfig <filename> ]
[<plotname> ] [print]
[<plotname> ] [print destination printer| file]
[<plotname> ] [print command <command> ]
[<plotname> ] [print filename <filename> ]
[<plotname> ] [print palette color| gray| mono]
[<plotname> ] [page orientation portrait| landscape]
[<plotname> ] [page pagescale scaled| fixed]
[<plotname> ] [page pagesize letter| legal| tabloid|

poster| a4]

[<plotname> ] [graph grid yes| no]
[<plotname> ] [graph scale
linearlinear| linearlog| loglinear| loglog]
[<plotname> ] [graph range x| y auto yes| no]
[<plotname> ] [graph range x| y min <value> ]
[<plotname> ] [graph range x| y max <value> ]
[<plotname> ] [graph labels title| xaxis| yaxis

<value> ]

[<plotname> ] [font numbers| labels| title font
times| helvetica| symbol| courier]
[<plotname> ] [font numbers| labels| title size

<value> ]

[<plotname> ] [font numbers| labels| title style
plain| bold| italic]
# edit current dataset
-plot [<plotname> ] [dataset #]
[<plotname> ] [view discrete| line| step| quadratic|

errorbar

yes| no]
[<plotname> ] [color discrete| line| step| quadratic|

errorbar

<color> ]
[<plotname> ] [line discrete circle| diamond| plus|

cross]

[<plotname> ] [line line| step| quadratic| errorbar

width

<value> ]
[<plotname> ] [line line| step| quadratic dash yes|

no]

[<plotname> ] [line errorbar style 1| 2]

Example:

# create new empty plot window

ds9 -plot

ds9 -plot new

ds9 -plot new name foo

# edit existing plot

ds9 -plot close # close last plot

ds9 -plot foo close # close plot foo

ds9 -plot clear # clear all datasets

ds9 -plot load foo.dat xy # load new dataset with dimension xy

ds9 -plot save bar.dat # save current dataset

ds9 -plot loadconfig foo.plt # load plot configuration

ds9 -plot saveconfig bar.plt # save current plot configuration

ds9 -plot print

ds9 -plot print destination file

ds9 -plot print command "lp"

ds9 -plot print filename "foo.ps"

ds9 -plot print palette gray

ds9 -plot page orientation portrait

ds9 -plot page pagescale scaled

ds9 -plot page pagesize letter

ds9 -plot graph grid yes

ds9 -plot graph scale loglog

ds9 -plot graph range x auto yes

ds9 -plot graph range x min 0

ds9 -plot graph range x max 100

ds9 -plot graph range y auto yes

ds9 -plot graph range y min 0

ds9 -plot graph range y max 100

ds9 -plot graph labels title {The Title}

ds9 -plot graph labels xaxis {X}

ds9 -plot graph labels yaxis {Y}

ds9 -plot font numbers font times

ds9 -plot font numbers size 12

ds9 -plot font numbers style bold

ds9 -plot font labels font times

ds9 -plot font title font times

# edit current dataset

ds9 -plot dataset 2 # set current dataset to the second
dataset

loaded

ds9 -plot view discrete yes

ds9 -plot color discrete red

ds9 -plot line discrete cross

ds9 -plot line step width 2

ds9 -plot line step dash yes

ds9 plot line errorbar style 2

-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

-port_only

-prefs Controls various preference settings.

Syntax

prefs [save]
[clear]
[mosaicfast yes| no]
[bgcolor white| black| red| green| blue| cyan| magenta|

yellow]

[nancolor white| black| red| green| blue| cyan|

magenta| yellow]

Example:

ds9 -prefs save

ds9 -prefs clear

ds9 -prefs mosaicfast no

ds9 -prefs bgcolor black

ds9 -prefs nancolor red

-preserve

Preserve the follow attributes while loading a new image.

Syntax

preserve [scale yes| no]
[pan yes| no]
[regions yes| no]

Example:

ds9 -preserve scale yes

ds9 -preserve pan yes

ds9 -preserve regions yes

-print Controls printing. Use print option to set printing

options. Use

print to actually print.

Syntax

-print [destination printer| file]
[command <command> ]
[filename <filename> ]
[palette rgb| cmyk| gray]
[level 1| 2]
[resolution 53| 72| 75| 150| 300| 600]

Example:

ds9 -print

ds9 -print destination file

ds9 -print command 'gv -'

ds9 -print filename foo.ps

ds9 -print palette cmyk

ds9 -print level 2

ds9 -print resolution 75

-private

use private colormap, valid for pseudocolor 8 mode.

Syntax

-private

Example:

ds9 -private

-quit Quits DS9.

Syntax

-exit
-quit

Example:

ds9 -exit

-raise Raise ds9 in the window stacking order.

Syntax

-raise

Example:

ds9 -raise

-red For RGB frames, sets the current color channel to red.

Syntax

-red

Example:

ds9 -red foo.fits

-regions

Controls regions in the current frame.

Syntax

-regions [<filename> ]
[load <filename> ]
[save <filename> ]
[move front]
[move back]
[select all]
[select none]
[select group <groupname> ]
[delete all]
[delete select]
[format ds9| ciao| saotng| saoimage| pros| xy]
[system image| physical| wcs| wcsa...wcsz]
[sky fk4| fk5| icrs| galactic| ecliptic]
[skyformat degrees| sexagesimal]
[strip yes| no]
[wcs yes| no]
[shape <shape> ]
[color white| black| red| green| blue| cyan| magenta|

yellow]

[width <width> ]
[delim [nl| <char> ] ]
[command <marker command> ]
[composite]
[desolve]
[template <filename> ]
[savetemplate <filename> ]
[group <tag> ]
[group <tag> color
[black| white| red| green| blue| cyan| magenta| yellow]

]

[group <tag> copy]
[group <tag> delete]
[group <tag> cut]
[group <tag> font <font> ]
[group <tag> move <int> <int> ]
[group <tag> movefront]
[group <tag> moveback]
[group <tag> property <property> yes| no]
[group <tag> select]
[copy]
[cut]
[paste image| physical| wcs| wcsa...wcsz
fk4| fk5| icrs| galactic| ecliptic]
[undo]

Example:

ds9 -regions foo.reg

ds9 -regions load foo.reg

ds9 -regions save foo.reg

ds9 -regions move back

ds9 -regions move front

ds9 -regions select all

ds9 -regions select none

ds9 -regions select group foo

ds9 -regions delete all

ds9 -regions delete select

ds9 -regions format ds9

ds9 -regions system wcs

ds9 -regions sky fk5

ds9 -regions skyformat degrees

ds9 -regions delim nl

ds9 -regions strip yes

ds9 -regions wcs yes

ds9 -regions shape ellipse

ds9 -regions color red

ds9 -regions width 3

ds9 -regions command {circle 100 100 20}

ds9 -regions composite

ds9 -regions desolve

ds9 -regions template foo.tpl

ds9 -regions savetemplate foo.tpl

ds9 -regions group foo color red

ds9 -regions group foo copy

ds9 -regions group foo delete

ds9 -regions group foo cut

ds9 -regions group foo font {times 14 bold}

ds9 -regions group foo move 100 100

ds9 -regions group foo movefront

ds9 -regions group foo moveback

ds9 -regions group foo property delete no

ds9 -regions group foo select

ds9 -regions copy

ds9 -regions cut

ds9 -regions paste wcs fk5

ds9 -regions undo

-rgb Create RGB frame and control RGB frame parameters.

Syntax

-rgb # empty
[red| green| blue]
[channel [red| green| blue] ]
[view [red| green| blue] [yes| no] ]
[system <coordinate system> ]
[lock scale| bin| colorbar [yes| no]

Example:

ds9 -rgb # create new rgb frame

ds9 -rgb red # set current channel to red

ds9 -rgb channel red # set current channel to red

ds9 -rgb view blue no # turn off blue channel

ds9 -rgb system wcs # set rgb coordinate system

ds9 -rgb lock scale yes # lock rgb channels for scaling

ds9 -rgb lock bin yes # lock rgb channels for binning

ds9 -rgb lock colorbar yes # lock rgb colorbar channels

-rgbarray

Load entire RGB image composed of a 3D Array Data Cube
that

contains red, green, and blue channels.

Syntax

-rgbarray
<filename> [xdim=<x> , ydim=<y> | dim=<dim> , zdim=3] ,

bitpix=<b> , [skip=<s>

] ]

Example:

ds9 -rgbarray rgb.arr[dim=200, zdim=3, bitpix=-32]

-rgbcube

Load entire RGB image composed of a FITS 3D Data Cube
that contains

red, green, and blue channels.

Syntax

-rgbcube <filename>

Example:

ds9 -rgbcube rgb.fits

-srgbcube

Load entire RGB image composed of a split FITS 3D Data
Cube that

contains red, green, and blue channels.

Syntax

-srgbcube <filename> <filename>

Example:

ds9 -srgbcube rgb.hdr rgb.arr

-rgbimage

Load entire RGB image composed of a FITS multiple extension file

that contains red, green, and blue channels.

Syntax

-rgbimage <filename>

Example:

ds9 -rgbimage rgb.fits

-rotate

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

Syntax

-rotate [<value> ]
[to <value> ]

Example:

ds9 -rotate 45

ds9 -rotate to 30

-saveimage

Save visible image(s) as a raster. If image is a data
cube,

the mpeg option will cycle thru each slice creating a

mpeg movie.

Syntax

-saveimage [fits| jpeg| tiff| png| ppm| mpeg] <file

name>

Example:

ds9 -saveimage jpeg ds9.jpg

-savefits

Save current frame data as FITS. This differs from
SAVEIMAGE in

that the entire image of the current frame is saved as a

FITS,

without graphics.

Syntax

-savefits <filename>

Example:

ds9 -savefits ds9.fits

-savempeg

Save all active frames as a mpeg movie.

Syntax

-savempeg <filename>

Example:

ds9 -savempeg ds9.mpg

-scale Controls the limits, color scale distribution, and use

of

DATASEC keyword.

Syntax

-scale [linear| log| squared| sqrt| histequ]
[datasec yes| no]
[limits <minvalue> <maxvalue> ]
[mode minmax| <value> | zscale| zmax]
[scope local| global]

Example:

ds9 -scale datasec yes

ds9 -scale histequ

ds9 -scale limits 1 100

ds9 -scale mode zscale

ds9 -scale mode 99.5

ds9 -scale scope local

-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> ] ]
[sfits [key| shmid] <id> <id> [<filename> ] ]
[mosaicimage [iraf| wcs| wcsa...wcsz| wfpc2] [key|

shmid] <id>

[<filename> ] ]
[mosaicimagenext [wcs| wcsa...wcsz] [key| shmid] <id>
[<filename> ] ]
[mosaic [iraf| wcs| wcsa...wcsz] [key| shmid] <id>

[<filename> ] ]

[smosaic [iraf| wcs| wcsa...wcsz] [key| shmid] <id>

<id>

[<filename> ] ]
[rgbcube [key| shmid] <id> [<filename> ] ]
[srgbcube [key| shmid] <id> <id> [<filename> ] ]
[rgbimage [key| shmid] <id> [<filename> ] ]
[rgbarray [key| shmid] <id>
[xdim=<x> , ydim=<y> | dim=<dim> , zdim=3] , bitpix=<b>

, [skip=<s> ] ]

[array [key| shmid] <id>
[xdim=<x> , ydim=<y> | dim=<dim> ] , bitpix=<b> ,

[skip=<s> ] ]

Example:

ds9 -shm 102

ds9 -shm key 102

ds9 -shm shmid 102 foo

ds9 -shm fits 100 foo

ds9 -shm sfits 100 101 foo

ds9 -shm mosaicimage iraf key 100 foo

ds9 -shm mosaicimage wcs key 100 foo

ds9 -shm mosaicimage wcsa key 100 foo

ds9 -shm mosaicimage wfpc2 key 100 foo

ds9 -shm mosaicimagenext wcs key 100 foo

ds9 -shm mosaic iraf key 100 foo

ds9 -shm mosaic wcs key 100 foo

ds9 -shm smosaic wcs key 100 101 foo

ds9 -shm rgbcube key 100 foo

ds9 -shm srgbcube key 100 101 foo

ds9 -shm rgbimage key 100 foo

ds9 -shm rgbarray shmid 102 [dim=32, zdim=3, bitpix=-32]

ds9 -shm array shmid 102 [dim=32, bitpix=-32]

-single

Set display mode to single.

Syntax

-single

Example:

ds9 -single

-smooth

Smooth current image or set smooth parameters.

Syntax

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

Example:

ds9 -smooth yes

ds9 -smooth function tophat

ds9 -smooth radius 4

-squared

Select Squared scale for current frame.

Syntax

-squared

Example:

ds9 -squared

-sqrt Select Square Root scale for current frame.

Syntax

-sqrt

Example:

ds9 -sqrt

-source

Sources a valid TCL file.

Syntax

-source filename

Example:

ds9 -source extensions.tcl

-tile Controls the tile display mode.

Syntax

-tile [yes| no]
[mode grid| column| row]
[grid]
[grid mode [automatic| manual] ]
[grid layout <row> <col> ]
[grid gap <pixels> ]
[row]
[column]

Example:

ds9 -tile

ds9 -tile yes

ds9 -tile mode row

ds9 -tile grid

ds9 -tile grid mode manual

ds9 -tile grid layout 5 5

ds9 -tile grid gap 10

ds9 -tile row

ds9 -tile 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 communi

cate 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

-url Load FITS file from specified url.

Syntax

-url <url>

Example:

ds9 -url 'ftp://foo.bar.edu/img.fits'

-version

Returns the current version of DS9.

Syntax

-version

Example:

ds9 -version

-view Controls the GUI and visible RGB frame color channels.

Syntax

-view [horizontal| vertical]
[info yes| no]
[panner yes| no]
[magnifier yes| no]
[buttons yes| no]
[colorbar yes| no]
[horzgraph yes| no]
[vertgraph yes| no]
[filename yes| no]
[object yes| no]
[minmax yes| no]
[frame yes| no]
[image| physical| wcs| wcsa...wcsz yes| no]
[red yes| no]
[green yes| no]
[blue yes| no]

Example:

ds9 -view vertical

ds9 -view info yes

ds9 -view panner yes

ds9 -view magnifier yes

ds9 -view buttons yes

ds9 -view colorbar yes

ds9 -view horzgraph yes

ds9 -view vertgraph yes

ds9 -view filename yes

ds9 -view object yes

ds9 -view minmax

ds9 -view frame yes

ds9 -view wcsa yes

ds9 -view red yes

ds9 -view green yes

ds9 -view blue yes

-visual

Force DS9 to use the specified color visual. This argument

MUST be the first argument listed. Requires the visual

be

available.

Syntax

-visual
[pseudocolor| pseudocolor8| truecolor| truecolor8|

truecolor16| truecol

or24]

Example:

ds9 -visual truecolor24

-vo Invoke an connection to a Virtual Observatory site.

Syntax

-vo <url>

Example:

ds9 -vo chandra-ed.havard.edu

-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 [90] WCS for more information.

Syntax

-wcs [wcs| wcsa...wcsz]
[system wcs| wcsa...wcsz]
[sky fk4| fk5| icrs| galactic| ecliptic]
[skyformat degrees| sexagesimal]
[align yes| no]
[reset]
[replace file <filename> ]
[append file <filename> ]

Example:

ds9 -wcs wcs

ds9 -wcs system wcs

ds9 -wcs sky fk5

ds9 -wcs skyformat sexagesimal

ds9 -wcs align yes

ds9 -wcs reset

ds9 -wcs replace file foo.wcs

ds9 -wcs append file foo.wcs

-web Display specified URL in the web display.

-web <url>

Example:

ds9 -web chandra.harvard.edu

-width Set the width of the image display window. Use the [91]

geometry

command to set the overall width and height of the ds9

window.

Syntax

-width [<value> ]

Example:

ds9 -width 512

-xpa Configure XPA at startup. The option tcl allows the user

to send

tcl code via xpa to be executed by ds9. Warning: this is

a major

security risk and is disabled by default. Please use

with caution.

-xpa [yes| no]
[inet| local| unix| localhost]
[noxpans]
[tcl yes| no]

Example:

ds9 -xpa no

ds9 -xpa local

ds9 -xpa noxpans

ds9 -xpa tcl yes

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

Example:

ds9 -zscale

-zoom Controls the current zoom value for the current

frame.

Syntax

-zoom [<value> ]
[<value> <value> ]
[to <value> ]
[to <value> <value> ]
[to fit]

Example:

ds9 -zoom 2

ds9 -zoom 2 4

ds9 -zoom to 4

ds9 -zoom to 2 4

ds9 -zoom to fit

FILES

The complete text of the DS9 manual may be found on Debian systems at /usr/share/doc/saods9/ref/.

AUTHOR

DS9 is a product of the Smithsonian Astrophysical Observatory.

This manual page was generated from the DS9 HTML documentation
by a script written by Justin Pryzby.

SEE ALSO

xpaget(1), xpaset(1), xpaaccess(1), xpamb(1), xpainfo(1), xpans(1), xpachanges(7),

14 November 2005 DS9(1)