| Command: | header [n] |
| Menu: | File - Header |
| Description: | Displays a selected FITS extension header in a popup window. |
| Command: | header close |
| Menu: | File - Header - File - Close |
| Description: | Close the popup header window |
| Command: | header save [n] [filemame] |
| Menu: | File - Header - File - Save |
| Description: | Save header of FITS extension n to the given text file. |
| Command: | fits header |
| Menu: | - |
| Description: | Dumps the current FITS header to standard output. |
| Command: | fits header [n] |
| Menu: | - |
| Description: | Dumps the header for HDU n. |
| Command: | fits header [n] keyword [name] |
| Menu: | - |
| Description: | Dumps the value of the header keyword for HDU n. Example: xpaget ds9 fits header keyword OBSERVER |
| Command: | fits width|height|depth|bitpix |
| Menu: | - |
| Description: | Dump the current FITS image x,y,z dimensions and BITPIX values using xpaget.Example: xpaget ds9 fits height |
| Command: | fits size |
| Menu: | - |
| Description: | Returns the x,y dimensions in image pixels. Example:xpaget ds9 fits size1024 1024 |
| Command: | fits size [coordsys] [skyframe] [units] |
| Menu: | - |
| Description: | Returns the image dimensions in world coordinates. Example:xpaget ds9 fits size galactic arcmin20.04862 19.97157Options: wcs, wcsa...wcsz, fk4, fk5, icrs, galactic, ecliptic; degrees, arcmin, arcsec. |
| Command: | fits count |
| Menu: | - |
| Description: | This appears to be a synonym for 'fits depth'. |
| Command: | iis filename |
| Menu: | - |
| Description: | Return IIS (Internet Information Services) Filename. Can support an optional mosaic number,e.g. xpaget ds9 iis filename 4; xpaset -p ds9 iis filename foo.fits |
| Command: | version |
| Menu: | Help - About DS9 |
| Description: | View the current version of DS9. Example: xpaget ds9 version |
| Command: | help |
| Menu: | - |
| Description: | Issue command line help. 'ds9 -help'. Only available on command line. |
| Command: | file |
| Menu: | - |
| Description: | The command 'xpaget ds9 file' (or 'xpaget foo file' if DS9 was started as 'ds9 -title foo') echoes the full path of the currentlyloaded file to the terminal. Not available on command line. Can be used in SAMP. |
| Command: | fits image|table|slice |
| Menu: | - |
| Description: | Dump the current DS9 FITS data to standard output. Example: ds9 fits image > foo.fits.Note that this command can also load data:cat foo.fits | xpaset ds9 fits |
| Command: | data [coordsys] [skyframe] [x] [y] [w] [h] yes|no |
| Menu: | - |
| Description: | Retrun array of data values from the image given a lower leftcorner and a width and height. [coordsys] and [skyframe] specify the coordinate system for x and y and implies the units for w and h (pixels or deg).The last argument says whether to return the bare values (yes) or also return the coordinates of each value (no).Used with the xpaget command; not available to command line or to xpaset. xpaget ds9 data image 342 613 3 3 yesEchoes 9 lines to standard output, each line gives the values of a 3 x 3 box starting at image coords (342,613). xpaget ds9 data image 342 613 3 3 noAs above, but each line is of the form '(x,y) = value' instead of just 'value'. xpaget ds9 data physical 4028 4137 3 3 no4030,4139 = 64029,4139 = 94028,4137 = 154030,4137 = 94029,4137 = 74028,4138 = 174030,4138 = 54029,4138 = 124028,4139 = 17 |
xpaget ds9 data wcs fk5 15:34:57.1 +23:30:12.5 0.0002 0.0002 no
233.7379167,23.5036089 = 12
233.7379167,23.5034722 = 7
233.7377676,23.5036089 = 5
233.7377676,23.5034722 = 9
DS9 provides strong Postscript printing support. This is not a screen capture method, but a full level 1/2/3 postscript driver. The postscript images generated are detailed and accurate as possible, given the resolution of the data, and the printing resolution.
Postscript Level
DS9 supports three color models for level 2/3 postscript: RGB, CMYK, Grayscale. All three color models generate approximately the same size files.
Unlike graphic elements, image data must be sampled when encoded into postscript. The specified resolution parameter is in "pixels per inch" and is independent of the current screen resolution. A value of 96 maps to the current screen resolution. Any value over 96 will over sample the image, while any value under 96 will under sample. For high resolution printers and posters, the higher resolution sampling, the better. However, keep in mind the size of the postscript file grows with the square of the increase in resolution.
| Command: | |
| Menu: | File - Print |
| Description: | Prints the main image pane including colorbar and horizontal and vertical graphs if present.The rest of the window, including info and menu button panes, are not included. The properties of the print outputcan be controlled by File - Page Setup and Edit - Preferences. |
Some options are:
| Command: | print destination printer|file |
| Menu: | - |
| Description: | Specify whether destination is to printer or a file |
| Command: | print command [printer] |
| Menu: | Edit - Preferences - Postscript - Print To - Printer |
| Description: | allows the target printer to be selected.Example: print command lp -Plpm |
| Command: | print filename [filename] |
| Menu: | Edit - Preferences - Postscript - Print To - File |
| Description: | allows the output filename to be selected. |
| Command: | print color [value] |
| Menu: | Edit - Preferences - Postscript - Postscript - Color |
| Description: | allows the user to specify rgb, cmyk, or gray. |
| Command: | print level [value] |
| Menu: | Edit - Preferences - Postscript - Postscript - Level |
| Description: | allows the user to specify the Postscript level 1,2,3. |
| Command: | print resolution [value] |
| Menu: | Edit - Preferences - Postscript - Postscript - DPI |
| Description: | allows the user to specify theresolution: "screen", or 72, 96, 144, 150, 225, 300, 600 or 1200 dpi |
| Command: | - |
| Menu: | Edit - Preferences - Print Coordinates |
| Description: | Hitting the 'c' key brings up a dialog which gives the current cursor coordinates. This option controls which coordinate system is used. |
| Command: | pagesetup orient portrait|landscape |
| Menu: | Edit - Preferences - Page Seup - Layout - Orientation - Portrait/Landscape |
| Description: | allows the user to specify the page orientation. |
| Command: | pagesetup scale [value] |
| Menu: | Edit - Preferences - Page Setup - Layout - Scale |
| Description: | allows the user to specify the scaling. |
| Command: | pagesetup size [value] |
| Menu: | Edit - Preferences - Page Setup - Page Size |
| Description: | allows the user to specify the page size (letter, legal, tabloid, poster, a4). The GUI also allows setting an explicit size in mm or in. |
| Command: | psprint |
| Menu: | - |
| Description: | Invokes postscript printing. Same arguments as print. |
Sometimes images that are saved as PS or JPG files look great on the screen, but are poor when printed out as hardcopy. This is because the files are created by default using the RGB color model, but color printers use the CMYK (cyan, yellow, magenta, black) color model. The mapping between RGB and CMYK is not bijective and information can be lost; some RGB colors are not present in the CMYK color gamut. A color of #0000FF (RGB blue) is usually mapped to an excessively purple shade in CMYK. For this reason, you may wish to use colormaps without deep blues and purples, such as BB or Heat. The DS9 authors recommend that if the exact hardcopy color is important you should use CMYK definitions and that CMYK (100,65,0,0) gives a nice clean blue.
Also, in practice, different printers and monitors may display colors differently. In principle tuning a gamma correction for a given monitor or printer could improve things, but it's a bit hit and miss. Note that printers tend to wash out blues and purples, so avoid or oversaturate these colors. Our experience is that although ApJ requestes CMYK images, submitting RGB images to them results in printed results closer to the original.
| Command: | illustrate |
| Menu: | Edit - Illustrate |
| Description: | This mode makes the top level Illustrate menu available (it is normally greyed out) and disables the Region menu.The Illustrate menu is similar to the region menu, and allows you to select a region shape, then left-click in the imageto create an instance of that shape; it also has the selection choices All, None, etc., as well as Save/List/Delete selection and the ordering choices (Front/Back).The difference between the Illustrate menu and the Region menu is that the regions and text created by Illustratedo not move or resize when the image is panned or zoomed; unlike Region mode, they are not tied to the image and its coordinates.Saving Illustrate entries creates a '.seg' file which is a valid region file; however the formatis somewhat different from that saved in '.reg' (e.g. 'circle x y r' rather than 'circle(x,y,r)', andthere is no option to use different coordinate systems. |
| Command: | illustrate save [filename] |
| Menu: | Illustrate - Save |
| Description: | Save current illustration to a file |
| Command: | illustrate load [filename] |
| Menu: | Illustrate - Open |
| Description: | Load region file to current illustration |
| Command: | illustrate select all|none|invert|front|back |
| Menu: | Illustrate - All|None|Invert|Front|Back |
| Description: | Control selection of illustrate regions |
| Command: | illustrate move front|back |
| Menu: | Illustrate - Move To Front/Move To Back |
| Description: | Shuffle layering of illustrate regions |
| Command: | illustrate delete select|all |
| Menu: | Illustrate - Delete Selection/Delete All |
| Description: | Delete selected, or all, illustrate regions |
| Command: | illustrate shape [value] |
| Menu: | Illustrate - Shape |
| Description: | Specify current illustrate region shape |
| Command: | illustrate color [value] |
| Menu: | Illustrate - Color |
| Description: | Specify current illustrate region color |
| Command: | illustrate fill yes|no |
| Menu: | Illustrate - Color - Fill |
| Description: | Turn on/off illustrate region fill state |
| Command: | illustrate width [value] |
| Menu: | Illustrate - Width |
| Description: | Specify current illustrate region line width |
| Command: | illustrate dash yes|no |
| Menu: | Illustrate - Width - Dash |
| Description: | Turn on/off illustrate region line dash |
| Command: | illustrate copy|cut|paste |
| Menu: | - |
| Description: | Copy, cut, paste selected region to/from buffer |
| Command: | illustrate undo |
| Menu: | - |
| Description: | Undo last illustrate operation |
| Command: | illustrate open|close |
| Menu: | - |
| Description: | Open or close illustate save file |
| Command: | illustrate command [string] |
| Menu: | - |
| Description: | Add region to illustration. Example: illustrate command {circle 100 100 20} |
| Command: | - |
| Menu: | Edit - Examine |
| Description: | Examine mode emulates an old IRAF examine functionality. Clicking in the image generatesa new frame showing a zoomed in region around the clicked location. Clicking againgenerates a further new frame of a further-magnified region. |
| Command: | - |
| Menu: | Edit - Preferences - Examine - Magnification |
| Description: | allows you to control the magnification step |
| Command: | - |
| Menu: | Edit - Preferences - Examine - Mode |
| Description: | selects whether or not a new frame is generated each time you click. |
| Command: | iexam |
| Menu: | - |
| Description: | Examine coordinates at current location. Example: xpaget ds9 iexam; the command waits until you click the mouse button and thenreturns the current cursor coordinates. iexam not available for xpaset or command line. |
| Command: | iexam cooordinate wcs [coordsys] [frame] [units] |
| Menu: | - |
| Description: | Examine coordinates at current location. Example: xpaget ds9 iexam coordinate wcs fk5 sexagesimal; xpaget ds9 iexam coordinate wcs galactic degrees |
| Command: | iexam data |
| Menu: | - |
| Description: | Examine pixel value at current location. Example: xpaget ds9 iexam data |
| Command: | iexam data [n] [m] |
| Menu: | - |
| Description: | Examine pixel values in n x m box around current location. Example: xpaget ds9 iexam data 3 3 |
| Command: | iexam [string] |
| Menu: | - |
| Description: | Click at location, fill in variables accordingly. Variables are $width, $height, $depth, $bitpix, $filename, $regions, $filename[$regions], $env, $pan, $value, $x, $y, $z.Example: xpaget ds9 iexam 'Location $x $y in file $filename'. JCM Note: This command appears to be no longer working. |
When the crosshair mode is on with Edit - Crosshair, The crosshair position can be read off from Analysis - Crosshair Parameters - Crosshair. Conversely, entering coordinates in the Analysis - Crosshair Parameters - Crosshair coordinate boxes and using Analysis - Crosshair Parameters - Apply will move the crosshair to those coordinates.
| Command: | cursor [x] [y] |
| Menu: | - |
| Description: | Move crosshair and mouse cursor by given number of pixels. Selected regions will alsomove by the given amount. |
| Command: | pixeltable yes|open |
| Menu: | Analysis - Pixel Table |
| Description: | displays a window witha table showing the pixel values in the vicinity of the cursor,as a function of the image pixel number coordinates. |
| Command: | pixeltable no|close |
| Menu: | Analysis - Pixel Table - Close |
| Description: | Closes the pixel table window |
| Command: | - |
| Menu: | Analysis - Pixel Table - Size |
| GUI Default: | Edit - Preferences - Pixel Table - Size |
| Description: | controls the size of the vicinity shown, in pixels.The maximum available is a 13 x 13 region around the cursor, default is 5x5. |
Entering special characters into an entry dialog used to be done by selecting a special symbol font.
Such symbol fonts are no longer implemented with the
latest OS font and scripting support, especially with scalable
anti-alias fonts such as Xft for Linux. Most newer fonts (if not all)
now have greek characters as part of the font. The greek chars start at
unicode
u0391 for 'A' and
u03b1 for 'a'. Each OS has a tool used to
build and copy a string of characters. Then use the Edit:Paste menu of
DS9 to insert the character string.