- stretch 7.5+repack1-2
- testing 8.0.1+repack-2
- unstable 8.0.1+repack-2
- experimental 8.1~b1+repack-1
DS9(1) | General Commands Manual | DS9(1) |
NAME¶
ds9 - image tool for astronomySYNOPSIS¶
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¶
- -2mass
- Support for 2MASS Digital Sky Survey.
- -3d
- Support for 3D frame.
- -about
- Get DS9 credits.
- -align
- Controls the World Coordinate System alignment for the current frame.
- -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.
- -array
- Load raw data array into current frame.
- -asinh
- Select ASINH scale function for the current frame.
- -background
- Set image background color.
- -backup
- Create a backup save set.
- -bin
- Controls binning factor, binning buffer size, and binning function for binning FITS bin tables.
- -blink
- Blink mode parameters. Interval is in seconds.
- -block
- Controls blocking parameters.
- -blue
- For RGB frames, sets the current color channel to blue.
- -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.
[ascss| cmc| gsc1| gsc2| gsc3| ac| nomad| ppmx| sao| sdss5| sdss6| sdss7| sdss8| tycho| ua2| ub1| ucac2] [2mass| iras] [csc| xmm| rosat] [first| nvss] [chandralog| cfhtlog| esolog| stlog| xmmlog] [cds <catalogname> ] [cds <catalogid> ] [load <filename> ] [import sb| tsv <filename> ] [<ref> ] [allcols] [<ref> ] [allrows] [<ref> ] [cancel] [<ref> ] [clear] [<ref> ] [close] [<ref> ] [coordinate <ra> <dec> <coordsys> ] [<ref> ] [crosshair] [<ref> ] [dec <col> ] [<ref> ] [edit yes| no] [<ref> ] [export sb| tsv <filename> ] [<ref> ] [filter <string> ] [<ref> ] [filter load <filename> ] [<ref> ] [header] [<ref> ] [hide] [<ref> ] [location <code> ] [<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
- -cd
- Sets the current working directory.
- -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.
- -colorbar
- Controls colorbar parameters.
- -console
- Display tcl console window.
- -contour
- Controls contours in the current frame.
- -crop
- Set current image display area.
- -crosshair
- Controls the current position of the crosshair in the current frame. DS9 is placed in crosshair mode when the crosshair is set.
- -cube
- Controls FITS cube.
- -cursor
- Move mouse pointer or crosshair in image pixels in the current frame. Note, this will move selected Regions also.
- -dsssao
- dss Support for Digital Sky Survey at SAO.
- -dsseso
- Support for Digital Sky Survey at ESO.
- -dssstsci
- Support for Digital Sky Survey at STSCI.
- -envi
- Load an ENVI header and file. Optional parameter: array endian.
- -exit
- quit Quits DS9.
- -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.
- -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.
- -fifo_only
- -fits
- Load a FITS image into the current frame.
- -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.
- -geometry
- Define the initial window geometry. This includes all of the ds9 window, not just the image space. see X(1).
- -gif
- Import gif file.
- -green
- For RGB frames, sets the current color channel to green.
- -geometry
- Define the initial window geometry. This includes all of the ds9 window, not just the image space. see X(1).
- -header
- Display current fits header dialog. Optional extension number maybe specified.
- -height
- Set the height of the image display window. Use the geometry command to set the overall width and height of the ds9 window.
- -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.
- -histequ
- Select histogram equalization scale function for the current frame.
- -iconify
- Toggles iconification.
- -inet_only
- Only use the IRAF port number. This is the same as -fifo none -unix none.
- -invert
- Invert Colormap.
- -iis
- Set IIS Filename. Optional mosaic number maybe supplied.
- -jpeg
- Load JPEG image into current frame.
- -language
- Select current language.
- -linear
- Select linear scale function for the current frame.
- -lock
- Lock all other frames to the current frame.
- -log
- Select log scale function for the current frame.
- -lower
- Lower in the window stacking order.
- -magnifier
- Controls the magnifier settings.
- -mask
- nomask Controls mask parameters.
- -match
- Match all other frames to the current frame.
- -mecube
- Load FITS multiple extension file as data cube.
- -minmax
- This is how DS9 determines the min and max data values from the data. SCAN will scan all data.
- -mode
- Select the current mode.
- -mosaic
- Load FITS mosaic segment into current frame.
- -mosaicimage
- -movie
- -msg
- Specify a directory of translation tables to be loaded.
- -multiframe
- Load FITS multiple extension file as multiple images.
- -nameserver
- Support Name Server functions. Coordinates are in fk5.
- -nan
- Set image not-a-number color.
- -nrrd
- Load an NRRD (Nearly Raw Raster Data) file.
- -nvss
- Support for NRAO VLA Sky Survey.
- -orient
- Controls the orientation of the current frame.
- -pagesetup
- Controls Page Setup options.
- -pan
- Controls the current image cursor location for the current frame.
- -pixeltable
- Display/Hide the pixel table.
- -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.
[<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 width <value>
[<plotname> ] name <string> # select current dataset -plot [<plotname> ] select <value>
- -png
- Load PNG image into current frame.
- -prefs
- Controls various preference settings.
- -preserve
- Preserve the follow attributes while loading a new image.
- -psprint
- Invokes postscript printing. Please see print for further details.
- Controls printing. Use print option to set printing options.
- -private
- use private colormap, valid for pseudocolor 8 mode.
- -port
- Set the IRAF port number, used by IRAF to communicate with DS9. The default is 5137, the standard IRAF port used by ximtool.
- -port_only
- -pow
- Select power scale function for the current frame.
- -exit
- quit Quits DS9.
- -raise
- Raise in the window stacking order.
- -regions
- Controls regions in the current frame.
- -red
- For RGB frames, sets the current color channel to red.
- -restore
- Restore DS9 to a previous state from a backup save set.
- -rgb
- Create RGB frame and control RGB frame parameters.
- -rgbarray
- -rgbcube
- -rgbimage
- -rotate
- Controls the rotation angle (in degrees) of the current frame.
- -samp
- Configure SAMP protocol.
- -save
- Save loaded image data of current frame as FITS.
- -saveimage
- -scale
- Controls the limits and color scale distribution.
- -shm
- Load a shared memory segment into the current frame.
- -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.
- -single
- Set display mode to single.
- -skyview
- Support for SkyView image server at HEASARC.
- -sleep
- Delays execution for specified number of seconds. Default is 1 second.
- -slice
- noslice Indicates next files loaded are to treated as slices of a cube. Can be disabled with noslice command.
- -smooth
- Smooth current image or set smooth parameters.
- -squared
- Select squared scale function for the current frame.
- -sqrt
- Select square soot scale function for the current frame.
- -source
- Source TCL code from a file.
- -tcl
- Execute one TCL command. Note: this a different behavior from previous versions of DS9.
- -threads
- Set number of process threads for functions which are multi-threaded.
- -tiff
- Load TIFF image into current frame.
- -tile
- Controls the tile display mode.
- -title
- Changes the display window title to the specified name.
- -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.
- -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.
- -url
- Load FITS from URL into the current frame
- -version
- Returns the current version of DS9 and exits.
- -view
- Controls the GUI and visible RGB frame color channels.
- -visual
- Force DS9 to use the specified color visual. This argument MUST be the first argument listed. Requires the visual be available.
- -vla
- Support for VLA Sky Survey.
- -vlss
- Support for NRAO VLSS Sky Survey.
- -vo
- Invoke an connection to a Virtual Observatory site.
- -wcs
- galactic arcsec
- -web
- Display specified URL in the web display.
- -width
- Set the width of the image display window. Use the geometry command to set the overall width and height of the ds9 window.
- -xpa
- Configure XPA.
- -zmax
- Set Scale Limits based on the IRAF algorithm and maximum data value.
- -zoom
- Controls the current zoom value for the current frame.
- -zscale
FILES¶
The complete text of the DS9 manual may be found on Debian systems at /usr/share/doc/saods9-doc/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 and Ole Streicher.
SEE ALSO¶
xpaget(1), xpaset(1), xpaaccess(1), xpamb(1), xpainfo(1), xpans(1), xpachanges(7),03 Jul 2012 |