diff options
| author | William Joye <wjoye@cfa.harvard.edu> | 2016-10-27 19:01:15 (GMT) |
|---|---|---|
| committer | William Joye <wjoye@cfa.harvard.edu> | 2016-10-27 19:01:15 (GMT) |
| commit | 12166aa342f7c8d905097e43a1f50e0775503069 (patch) | |
| tree | 73a6e7296fbf9898633a02c2503a3e959789d8c3 /ds9/doc/ref | |
| parent | d4d595fa7fb12903db9227d33d48b2b00120dbd1 (diff) | |
| download | blt-12166aa342f7c8d905097e43a1f50e0775503069.zip blt-12166aa342f7c8d905097e43a1f50e0775503069.tar.gz blt-12166aa342f7c8d905097e43a1f50e0775503069.tar.bz2 | |
Initial commit
Diffstat (limited to 'ds9/doc/ref')
28 files changed, 21642 insertions, 0 deletions
diff --git a/ds9/doc/ref/3d.html b/ds9/doc/ref/3d.html new file mode 100644 index 0000000..7be0aa9 --- /dev/null +++ b/ds9/doc/ref/3d.html @@ -0,0 +1,80 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=ISO-8859-1"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>3D</title> + </head> + <body alink="#ff0000" bgcolor="#ffffff" link="#0000ee" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" align="middle" width="100" + height="98"> 3-D Frames<br> + </h3> + <blockquote> + <p>Previous versions of SAOImage DS9 would allow users to load 3-D + data into the traditional 2-D frames, and would allow users to + step through successive z-dimension pixel slices of the data + cube. To visualize the 3-D data in DS9 v. 7.0, a new module, + encompassed by the new <tt>Frame 3D</tt> option, allows users + to load and view data cubes in multiple dimensions.<br> + </p> + <p>The new module implements a simple ray-trace algorithm. For + each pixel on the screen, a ray is projected back into the view + volume, based on the current viewing parameters, returning a + data value if the ray intersects the FITS data cube. To + determine the value returned, there are 2 methods available, + Maximum Intensity Projection (MIP) and Average Intensity + Projection (AIP). MIP returns the maximum value encountered, AIP + returns an average of all values encountered. At this point, + normal DS9 operations are applied, such as scaling, clipping and + applying a color map.<br> + </p> + <p>Rendering time is independent upon the actual data cube size. + Instead, the time it takes to render is based on how many rays + are needed to project the data cube upon the screen in the view + volume and the current zoom factor. The new module requires no + special hardware or graphical processor unit (GPU) and the + rendering time is adequate for interactive GUI manipulation on + most computers. The rendering engine is developed using the + POSIX thread library, allowing multiple light weight processes + to be spawned to complete an image in parallel. The number of + threads actually generated is a user specified parameter. Since + all modern hardware contain multiple CPU cores, the default + value is 8 threads. For larger work stations, this number can be + increase. For every doubling in the number of CPU cores + available, rendering times decrease approximately 75%.<br> + </p> + <blockquote><tt>Example:</tt><br> + <tt># create 3d frame, load fits file</tt><br> + <tt> # set view angle to az 45 el 30 deg</tt><br> + <tt> # set rendering method to Average Intensity Projection</tt><br> + <br> + <tt>% ds9 -3d mycube.fits </tt><tt>-3d vp 45 30 </tt><tt>-3d + method aip</tt><br> + <br> + <tt>% xpaset -p ds9 3d</tt><br> + <tt> % xpaset -p ds9 file mycube.fits</tt><br> + <tt> % xpaset -p ds9 3d vp 45 30</tt><br> + <tt> % xpaset -p ds9 3d method aip</tt></blockquote> + <blockquote> </blockquote> + All 2-D graphics, regions, cross hairs, contours, and coordinate + grids, are applied to the current slice, which is selected by the + user. When the user wishes to match or lock a 2-D image and to a + 3-D data cube, the current slice is used to determine the + rendering solution. The user can crop the data cube for all 3 axes + via the command line or the GUI. The new module also supports FITS + event files binned into a data cube.<br> + <br> + All printing support has been extended to the new 3-D module. The + user may generate 3-D images in Postscript, JPEG, TIFF, and other + formats, just as in the 2-D case. Furthermore, native printing is + supported for the Windows version.<br> + <br> + DS9 analysis macros have been enhanced to fully support the new + 3-D module, allowing the user to invoke external analysis tasks + based on the current view parameters and to return results back + into DS9 in the form of text, plot, 2-D image, or 3-D image. </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/analysis.html b/ds9/doc/ref/analysis.html new file mode 100644 index 0000000..e5dd279 --- /dev/null +++ b/ds9/doc/ref/analysis.html @@ -0,0 +1,878 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Analysis</title> + </head> + <body link="#0000ee" alink="#ff0000" bgcolor="#ffffff" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" height="98" align="middle" + width="100"> Analysis</h3> + <blockquote> + <p>Each file type known to DS9 can have user-defined analysis + commands associated with it. These analysis commands are defined + at start-up time , or loaded by the user, by means of an ASCII + analysis description file. The analysis commands are available + for execution, either via the <i>Analysis Menu </i>or the XPA + point <i>Analysis</i>. In addition, commands may be <i>bound</i> + to events, such as keystrokes or mouse clicks. This type of + command is called a bind command.<br> + </p> + <p>DS9 searches for an analysis file named <tt>ds9.ans</tt> or <tt>ds9.analysis</tt> + in the current directory and <tt>$HOME</tt> to be loaded at + startup. In addition, DS9 will search the following directories + for any analysis files to be loaded at startup in the form of <tt>*.ds9</tt>: + the current directory, <tt>$HOME/bin</tt>, <tt>/usr/local/bin</tt>, + <tt>/opt/local/bin</tt>, and <tt>/soft/saord/bin</tt>. Finally, + the user may specify analysis files to be loaded at startup in + the preferences analysis panel. The user may also load or clear + current analysis commands via command line options or the <i>Analysis + + + + m</i>enu<i>.</i></p> + <p>When activated, either from the menu, XPA, or bound event, an + analysis command first is macro-expanded to fill in user-defined + arguments and then is executed externally. Results may be + displayed in a separate text window, plot window, or in a image + frame. </p> + <a href="#Syntax">Syntax</a> <br> + <a href="#CommandType">Command Type</a> <br> + <a href="#Macros">Macros</a> <br> + <a href="#Help">Help</a> <br> + <a href="#Web"> </a><a href="#Parameters">Parameters</a> <br> + <a href="#HierarchicalMenus">Hierarchical Menus</a> <br> + <a href="#Sample">Sample</a> + <p><b><a name="Syntax"></a>Syntax</b></p> + The analysis file that defines the known analysis commands + consists of one or more file descriptors, each of which has the + following format: + <blockquote> <tt>Menu label to be used</tt> <br> + <tt>A space separated list of file templates</tt> <br> + <tt>Command type [menu | bind <event>]</tt> <br> + <tt>The command line for the analysis program</tt> </blockquote> + <p>Task names may contain space characters. All lines may be + indented. Also, the '#' character is a comment character. A + separator can be inserted in the menu by specifying the + following sequence '---'.</p> + <tt>Example:</tt> + <blockquote> <tt># this will insert a menu separator</tt> <br> + <tt>---</tt> </blockquote> + <p><b><a name="CommandType"></a>Command Type</b></p> + <p>The third line indicates the type of command. </p> + <blockquote> + <p><b>menu</b></p> + <p>A <tt>menu</tt> command creates an menu option under the <i>Analysis + + + + + + + </i>menu option, and can be invoked by the user via the GUI or + XPA.</p> + <tt>Example:</tt> + <blockquote> <tt># Menu command example</tt><br> + <tt>My Analysis Task</tt><br> + <tt> </tt><tt>*.fits</tt> <br> + <tt>menu</tt> <br> + <tt>$data | doit | $text</tt> </blockquote> + <p><b>bind</b></p> + <p>A <tt>bind</tt> command is a command that is bound to an + event. When the event occurs, the command is executed. Types + of events available include all TK events, including all <i>keystrokes</i> + and <i>mouse clicks.</i> If a command is bound to an event + other that a <i>keystroke</i>, care must be taken to not to + interfere with other internal DS9 events. </p> + <p>To bind to a key stroke, use the following command type:</p> + <blockquote> <tt>bind <keystroke> </tt><br> + </blockquote> + <tt>Example:</tt> + <blockquote> <tt># Bind command example</tt><br> + <tt>Print coordinates</tt><br> + <tt>*.fits</tt><br> + <tt>bind x</tt><br> + <tt>echo "$x $y" | $text</tt><br> + </blockquote> + <p><b>web</b></p> + <p>A <tt>web</tt> command allows the user to invoke the + internal web browser from the analysis menu.</p> + <tt>Example:</tt> + <blockquote> <tt> # web command example<br> + HTTP based<br> + *<br> + web<br> + http://hea-www.harvard.edu/RD/ds9/ref/index.html<br> + <br> + File based<br> + *<br> + web<br> + file:/home/joye/index.html<br> + </tt> </blockquote> + </blockquote> + <p><b><a name="Macros"></a>Macros</b></p> + <p>The following macros are macro-expanded to fill in user-defined + arguments before the command is executed. Strings that contain + $<macroname> that user does not want to be expanded may be + escaped by using $$<macroname>. All strings that contain + $<string> that are not a macro name will not be + affected.</p> + <p>For example:</p> + <blockquote> <tt>echo "$$data $foo" | $text</tt><br> + </blockquote> + <p>will display a text dialog that contains "$data $foo"</p> + <p><b>$width<br> + $height<br> + $depth</b></p> + <p>Substitute the width, height, or depth of the data file in the + command line. </p> + <tt>Syntax:<br> + </tt> <tt> $width</tt><br> + <tt> $height</tt><br> + <br> + <tt>Example:<br> + </tt> <tt> echo "$width $height $depth" | $text</tt> + <br> + <p><b>$bitpix</b></p> + <p>Substitute the bitpix of the data file in the command line. </p> + <tt>Syntax:<br> + </tt> <tt> $bitpix</tt> <br> + <br> + <tt>Example:<br> + </tt> <tt> echo "$bitpix" | $text</tt> + <p><b>$data</b></p> + <p>Data from the current frame becomes the input data to the + command string. This data is in the form of a FITS image. This + macro can only used at the beginning of the command string. </p> + <tt>Syntax:<br> + </tt> <tt> $data</tt> <br> + <br> + <tt>Example:<br> + </tt> <tt> $data | dosomething | $text</tt> + <p><b>$entry</b></p> + <p>Display an entry modal dialog. The returned string is + substituted. If <tt>cancel</tt> is selected, the command line + is not executed. </p> + <tt>Syntax:<br> + </tt> <tt> $entry(<message>)</tt><br> + <br> + <tt>Example:<br> + </tt> <tt> echo "$entry(Enter something here)" + | $text</tt> + <p><b>$env</b></p> + <p>Substitute the value of a shell environment variable. </p> + <tt>Syntax:<br> + </tt> <tt> $env(<shell variable>)</tt><br> + <br> + <tt>Example:<br> + </tt> <tt> echo "$env(PATH)" | $text</tt> + <p><b>$filedialog</b></p> + <p>Display the standard file dialog. Substitutes the returned + pathname. Argument specifies if an open file or save file dialog + is invoked.</p> + <tt>Syntax:<br> + </tt> <tt> $filedialog([open|save])</tt><br> + <br> + <tt>Example:<br> + </tt> <tt> echo "$filedialog(open)" | $text</tt><br> + <p><b>$filename</b></p> + <p>Substitute the filename of the data file in the command line. A + full filename includes any absolute or relative path. A root + filename contains no path. A (2D) subsection defines a subimage + from <tt>xmin,ymin</tt> to <tt>xmax,ymax</tt>. For Frame3D, a + 2D subsection will also include the current slice (PLANE=) + parameter if not 1. A 3D subsection defines a subimage from <tt>xmin,ymin,zmin</tt> + to <tt>xmax,ymax,zmax</tt> and no PLANE parameter.<br> + </p> + <tt>Syntax:<br> + </tt> <tt> $filename # filename with extname, + (2d) subsections, filters</tt><br> + <tt> $filename(root|root,base) # root filename + with </tt><tt>with extname, </tt><tt>no subsections, no + filters)</tt> <br> + <tt> $filename(full|full,base) # full filename </tt><tt>with + + extname, </tt><tt>no subsections, no filters)</tt> <br> + <br> + <tt>Example:<br> + </tt> <tt> dosomething $filename | $text</tt> <br> + <tt> dosomething $filename(root) | $text<br> + </tt><br> + <b>$filename[$regions]</b> + <p>Combination of <tt>$filename </tt>and <tt>$regions </tt>macros. + +Generates +a + + + + + series of filenames, each with a region. </p> + <tt>Syntax:<br> + </tt> <tt> $filename[$regions]</tt> <br> + <tt> $filename[$regions(<options>)]</tt> <br> + <br> + <tt>Example:<br> + </tt> <tt> dosomething $filename[$regions] | + $text</tt> + <p><b>$geturl</b></p> + <p>This macro differs from all other macros, including $<tt>url</tt>, + in that no subprocess pipe is created. Only HTTP is supported. + The contents of the url are retrieved and sent to $<tt>text</tt>, + $<tt>plot</tt>, or $<tt>image.</tt> No other processing is + allowed. The primary purpose of this macro is to support + external analysis for the Windows platform, which has no + subprocess support. </p> + <tt>Syntax:<br> + </tt> <tt> + $geturl(http://<hostname>:<port>/<query>)</tt> + <br> + <br> + <tt>Example:<br> + </tt> <tt> $geturl(http://foo.bar.edu/foo.html) + | $text</tt><br> + <p><b>$image</b></p> + <p>The resulting image data is display in a DS9 frame. This macro + should be the last macro of a command line. Optional parameter + indicates if a new frame and what type of frame is created for + the new data. The macro is removed from the command line before + execution. </p> + <tt>Syntax:<br> + </tt> <tt> $image</tt> <br> + <tt> $image([new|rgb|3d|current])</tt> <br> + <br> + <tt>Example:<br> + </tt> <tt> doit | $image(new)</tt> + <p><b>$message</b></p> + <p>Display a message dialog box, with option buttons. After + displaying the message, the macro is removed from the command + line before execution. If <tt>cancel</tt> or <tt>no</tt> is + selected, the command line is not executed. </p> + <tt>Syntax:<br> + </tt> <tt> $message(<message>)</tt> <br> + <tt> + $message([ok|okcancel|yesno],<message>)</tt><br> + <br> + <tt>Example:<br> + </tt> <tt> $message(okcancel,This is a + Message)| doit | $text</tt> + <p><b>$null</b></p> + <p>Expect no output or results from analysis task. Note: no error + message will be returned if the analysis task fails to execute + correctly. </p> + <tt>Syntax:<br> + </tt> <tt> $null</tt><br> + <br> + <tt>Example:<br> + </tt> <tt> echo "Hello, world" > foo | $null</tt> + <p><b>$pan</b></p> + <p>Substitute current pan location of the particular data file are + returned. The default coordinate system is <tt>physical</tt>. </p> + <tt>Syntax:<br> + </tt> <tt> $pan<br> + </tt> <tt> $pan(<coordinate + system>,<format>)</tt> <br> + <p>where:</p> + <tt> coordinate system = + [image|physical|detector|amplifier|wcs|wcsa...wcsz]</tt> <br> + <tt> sky + frame = + [fk4|fk5|icrs|galactic|ecliptic]</tt> <br> + <tt> sky + format = + [hms|sexagesimal|degrees]</tt><br> + <br> + <tt>Example:<br> + </tt> <tt> echo $pan(fk5,sexagesimal) | $text</tt><br> + <p><b>$plot</b></p> + <p>Display data in plot window. This macro should be the last + macro of a command line. The data is read via <tt>STDIN</tt> + and consist of a pair of coordinates, with option error values. + (<tt>xy, xyex, xyey, xyexe</tt>y) Default dimension is <tt>xy.</tt> + The macro is removed from the command line before execution. </p> + <p>For <tt>$plot(stdin)</tt> only: </p> + <p>The title, x axis label, and y axis label are assumed to be on + the first line of input, delimited with a new-line. However, if + the data starts with $<tt>BEGINTEXT</tt>, all text between $<tt>BEGINTEXT</tt> + and $<tt>ENDTEXT</tt> will be removed from the data and + displayed in a separate text dialog window, with the remaining + data, including the title, x axis label, and y axis label, will + be displayed in a plot window. Furthermore, if the data contains + the string $<tt>ERROR,</tt> an error is assumed to have occurred + and a text dialog window is displayed only. </p> + <tt>Syntax:<br> + </tt> <tt> $plot</tt> <br> + <tt> $plot(,,,)</tt> <br> + <tt> $plot(<title>,<x axis + label>,<y axis label>,[xy|xyex|xyey|xyexey])</tt> <br> + <tt> $plot(stdin)</tt> <br> + <br> + <tt>Example:<br> + </tt> <tt> doit | $plot(This is aTitle,X Axis,Y + Axis)<br> + </tt> <tt> doit | $plot(stdin)</tt> + <p><b>$regions</b></p> + <p>Substitute region definition in specified region format, + coordinate system, and coordinate format. The default coordinate + system is <tt>physical</tt>, default coordinate format <tt>degrees</tt>, + and default region format <tt>DS9</tt>. Arguments may appear in + any order, as long as they are separated by ',' and no spaces. + If one or more properties are specified, only regions with + all of the specified properties will be substituted. </p> + <tt>Syntax:<br> + </tt> <tt> $regions</tt> <br> + <tt> $regions(<options>)</tt> + <p>where options are one of the following: </p> + <tt> regions format = + [ds9|ciao|saotng|saoimage|pros|xy]</tt> <br> + <tt> + property = + [include|exclude|source|background]</tt> <br> + <tt> coordinate system = + [image|physical|detector|amplifier|wcs]</tt> <br> + <tt> sky + frame = + [fk4|fk5|icrs|galactic|ecliptic]</tt> <br> + <tt> sky + format = + [sexagesimal|degrees]</tt> + <p>also, the old <i>SAOTNG</i> formats are also supported: </p> + <tt> $regions_pixels</tt> <br> + <tt> $regions_degrees</tt> <br> + <tt> $regions_hms</tt> <br> + <tt> $include_regions</tt> <br> + <tt> $include_regions_pixels</tt> <br> + <tt> $include_regions_degrees</tt> <br> + <tt> $include_regions_hms</tt> <br> + <tt> $exclude_regions</tt> <br> + <tt> $exclude_regions_pixels</tt> <br> + <tt> $exclude_regions_degrees</tt> <br> + <tt> $exclude_regions_hms<br> + </tt> <br> + <tt>Example:<br> + </tt> <tt> dosomething $regions | $text</tt> <br> + <tt> dosomething $regions(pros) | $text</tt> <br> + <tt> dosomething $regions(source,wcs,fk5) | + $text</tt> <br> + <tt> dosomething + $regions(saotng,background,exclude,ecliptic,sexagesimal) | $text</tt> + <p><b>$text</b></p> + <p>Display text in a text dialog window. This macro should be the + last macro of a command line. To display text from only STDOUT + use '|' as the pipe command. To display text from both STDOUT + and STDERR, use '|&' as the pipe command. No parameters are + required. The macro is removed from the command line before + execution. </p> + <tt>Syntax:<br> + </tt> <tt> $text</tt> <br> + <br> + <tt>Example:<br> + </tt> <tt> doit | $text # stdout<br> + doit |& $text # stdout and stderr<br> + </tt> + <p><b>$url</b></p> + <p>URLs are processed and stored in a temporary file. Only HTTP + and anonymous FTP are supported. </p> + <tt>Syntax:<br> + </tt> <tt> + $url(http://<hostname>:<port>/<query>)</tt> <br> + <tt> + $url(ftp://<hostname>/<filename>)</tt><br> + <br> + <tt>Example:<br> + </tt> <tt> + $url(http://legacy.gsfc.nasa.gov/rosat/data/p000s26b.img.Z) | + uncompress | $image</tt> <br> + <tt> + $url(ftp://legacy.gsfc.nasa.gov/rosat/data/hri/images/rh100193_img.fits) + | $image<br> + </tt> + <p><b>$vo_method</b></p> + <p>Returns the vo method. </p> + <tt>Syntax:<br> + </tt> <tt> $vo_method</tt> <br> + <br> + <tt>Example:<br> + </tt> <tt> echo '$vo_method' | $text</tt><br> + <p><b>$value<br> + </b></p> + <p>Substitute the value at the location of the cursor of an bind + event.<br> + </p> + <tt>Syntax:<br> + </tt> <tt> $value<br> + <br> + Example:<br> + echo "$value" | $text</tt><br> + <p><b>$x<br> + $y<br> + $z<br> + </b></p> + <p>Substitute coordinates of an bind event. When a bind event is + triggered, the <i>x,y </i>coordinates of the mouse of the + particular data file are returned. The default coordinate system + is <tt>physical</tt>. This macro is only available for bind + commands. For datacubes, the z coordinate is returned based on + the current slice selected.<br> + </p> + <tt>Syntax:<br> + </tt> <tt> $x</tt> <br> + <tt> $x(<coordinate + system>,<format>)</tt> <br> + <tt> $y</tt> <br> + <tt> $y(<coordinate + system>,<format>)<br> + $z<br> + $z(<coordinate system>)<br> + </tt> + <p>where:</p> + <tt> coordinate system = + [image|physical|detector|amplifier|wcs|wcsa...wcsz]</tt> <br> + <tt> sky + frame = + [fk4|fk5|icrs|galactic|ecliptic]</tt> <br> + <tt> sky + format = + [hms|sexagesimal|degrees]</tt> <br> + <br> + <tt>Example:<br> + </tt><tt> echo "$x $y" | $text<br> + echo "$x $y $z" | $text<br> + echo "$x(fk5,sexagesimal) + $y(fk5,sexagesimal)" | $text<br> + </tt><tt> echo "$x(wcs) $y(wcs) $z(wcs)" | $text</tt><br> + <p><b>$xpa</b></p> + <p>Returns the xpa access point name. </p> + <tt>Syntax:<br> + </tt> <tt> $xpa</tt> <br> + <br> + <tt>Example:<br> + </tt> <tt> echo '$xpa' | $text</tt> + <p><b>$xpa_method</b></p> + <p>Returns the xpa method. </p> + <tt>Syntax:<br> + </tt> <tt> $xpa_method</tt> <br> + <br> + <tt>Example:<br> + </tt> <tt> echo '$xpa_method' | $text</tt> + <p><b><a name="Help"></a>Help</b></p> + <p>The user may define his own <tt>HELP</tt> message. This + message will be available to the user as a menu item. An + optional label maybe specified. The default label is <tt>Help</tt>. + When invoked, an text dialog window will appear, containing the + message. Multiple <tt>HELP</tt> items maybe defined within a + menu or across hierarchical menus. </p> + <tt>Example:</tt> + <blockquote><tt>help Main Help</tt> <br> + <tt>A help message may contain</tt> <br> + <tt>multiple lines of description of the tasks</tt> <br> + <tt>in the menu or menus</tt> <br> + <tt>endhelp</tt> </blockquote> + <p><b><a name="Parameters"></a>Parameters</b></p> + <p>The user may define his own macros or parameters to be + evaluated before the command line is executed. To do this, the + user defines a param segment that is referenced in the command + line. The param definition has the follow format: </p> + <blockquote> <tt>param <name></tt> <br> + <tt><variable> <entry | checkbox | menu> + <title> <default> <{comment}></tt> <br> + <tt>...</tt> <br> + <tt>endparam</tt> </blockquote> + <p>or </p> + <blockquote> <tt>param <name></tt> <br> + <tt>@<iraf param filename></tt> <br> + <tt>end</tt> </blockquote> + <p>The definition either consisted of a number of variables, one + per row, or the name of a IRAF style parameter file. DS9 will + look for the IRAF parameter file in: </p> + <blockquote> <tt>./<filename></tt> <br> + <tt>$UPARM/<filename></tt> <br> + <tt>$HOME/iraf/<filename></tt> </blockquote> + <tt>Example:<br> + </tt> + <blockquote> <tt>param foobar</tt> <br> + <tt>var1 entry {Variable 1} default {this is a entry}</tt> <br> + <tt>var2 checkbox {Variable 2} 1 {this is a checkbox}</tt> <br> + <tt>var3 menu {Variable 3} AAA|BBB|CCC {this is a menu}</tt> <br> + <tt>endparam</tt> </blockquote> + <p>To use parameters, specify the param name at the beginning of + your command line: </p> + <blockquote> <tt>Parameter Test</tt> <br> + <tt>*</tt> <br> + <tt>menu</tt> <br> + <tt>$param(foobar); echo "$var1 $var2 $var3" | $text</tt> </blockquote> + <p>When the menu item is selected, the user will be presented with + a dialog box that contains <i>entry, checkbox, or menu </i>choices + + + + + for each variable specified. If the user clicks ok, the values + are substituted in the command line before execution. </p> + <p><b><a name="HierarchicalMenus"></a>Hierarchical Menus</b></p> + <p>The user may define hierarchical menus. Use this to organized + crowded menus. To do this, frame menu entries with <tt>hmenu + <label> </tt>and <tt>endhmenu</tt>. Hierarchical menu + labels may contain spaces. Multiple levels maybe implemented. </p> + <tt>Example:<br> + </tt> + <blockquote> <tt>hmenu Stuff</tt> <br> + <tt> hello</tt> <br> + <tt> *</tt> <br> + <tt> menu</tt> <br> + <tt> echo "Hello" | $text</tt> + <p><tt> world</tt> <br> + <tt> *</tt> <br> + <tt> menu</tt> <br> + <tt> echo "World" | $text</tt> </p> + <p><tt> hmenu More Stuff</tt> <br> + <tt> hello world</tt> + <br> + <tt> *</tt> <br> + <tt> menu</tt> <br> + <tt> echo "Hello + World" | $text</tt> <br> + <tt> endhmenu</tt> <br> + <tt>endhmenu</tt></p> + </blockquote> + <p>Will create an hierarchical menu with two members, <tt>hello</tt> + and <tt>world</tt>. </p> + <p><b><a name="Sample"></a>Sample</b></p> + <tt>#<br> + # Analysis command descriptions:<br> + # menu label<br> + # file templates<br> + # menu/bind<br> + # analysis command line<br> + <br> + param foo<br> + var1 entry entry 40 {this is a entry}<br> + var2 checkbox checkbox 1 {this is a checkbox}<br> + var3 menu menu AAA|BBB|CCC {this is a menu}<br> + endparam<br> + <br> + param bar<br> + @analysis.par<br> + endparam<br> + <br> + param foobar<br> + @tvdisply.par<br> + endparam<br> + <br> + param ltc<br> + bins entry "Enter number of [t1:t2:]bins" 0 + "('0' for default number of bins)"<br> + endparam<br> + <br> + # Help Main Help<br> + <br> + help Main Help<br> + These menus contain a test for each possible feature<br> + <br> + supported by the ds9 (blank line above)<br> + endhelp<br> + ---<br> + <br> + hmenu Test Web<br> + help Web Help<br> + Help for web features<br> + endhelp<br> + <br> + Web Test url<br> + *<br> + web<br> + http://hea-www.harvard.edu/RD/ds9/<br> + <br> + Web Test file<br> + *<br> + web<br> + file:/home/joye/saods9/ds9/tests/hv.html<br> + endhmenu<br> + <br> + hmenu Test Basics<br> + help Basic Help<br> + Help for basic features<br> + endhelp<br> + ---<br> + Test escape char # this is a comment<br> + *<br> + menu<br> + echo "this is not a macro $$xpa" | $text<br> + <br> + Test pass thru # this is a comment<br> + *<br> + menu<br> + echo "this is not a macro $foo" | $text<br> + <br> + Test $xpa # this is a comment<br> + *<br> + menu<br> + echo $xpa | $text<br> + <br> + Test $xpa_method<br> + *<br> + menu<br> + echo $xpa_method | $text<br> + </tt><tt><br> + Test $vo_method<br> + *<br> + menu<br> + echo $vo_method | $text<br> + <br> + </tt><tt> Test $filename<br> + *.fits<br> + menu<br> + echo $filename | $text<br> + <br> + Test $filename(root)<br> + *.fits<br> + menu<br> + echo $filename(root) | $text<br> + <br> + Test $xdim $ydim $bitpix<br> + *.fits<br> + menu<br> + echo "$xdim $ydim $bitpix" | $text<br> + <br> + </tt><tt> Test $xcen $ycen<br> + *.fits<br> + menu<br> + echo "$xcen $ycen" | $text<br> + <br> + </tt><tt> Test $env<br> + *<br> + menu<br> + echo $env(PATH) | $text<br> + endhmenu<br> + <br> + hmenu Test Regions<br> + help Regions Help<br> + Help for regions features<br> + endhelp<br> + ---<br> + Test $regions<br> + *.fits<br> + menu<br> + echo "$regions + ds9_s:$regions(ds9,source,image) + ciao_b:$regions(ciao,background) + saotng_i:$regions(saotng,include,wcs,fk5) + pros_e:$regions(pros,exclude,wcs,fk5,sexagesimal) + xy_be:$regions(xy,background,exclude,wcs,fk4,hms)" | $text<br> + <br> + Test $regions wcs<br> + *.fits<br> + menu<br> + echo "$regions(ds9,wcs) + $regions(ds9,wcs,fk5,sexagesimal) $regions(ds9,wcsa) " | $text<br> + <br> + Test $include_regions_pixels<br> + *.fits<br> + menu<br> + echo "ds9_s: $source_regions ds9_b: + $background_regions_pixels ds9_i: $include_regions_degrees + ds9_e: $exclude_regions_hms" | $text<br> + <br> + Test $filename $regions<br> + *.fits<br> + menu<br> + echo "$filename[$regions]" | $text<br> + <br> + Test $filename $regions()<br> + *.fits<br> + menu<br> + echo "$filename[$regions()]" | $text<br> + endhmenu<br> + <br> + hmenu Test Output<br> + help Output Help<br> + Help for output features<br> + endhelp<br> + ---<br> + Test $null<br> + *<br> + menu<br> + echo "This is Text" > /dev/null | $null<br> + <br> + Test $text<br> + *<br> + menu<br> + echo "This is Text" | $text<br> + <br> + Test $text stderr<br> + *<br> + menu<br> + ls foofoofoo | $text<br> + <br> + Test $plot<br> + *<br> + menu<br> + cat xy.dat | $plot<br> + <br> + Test $plot(title,x,y,xyey)<br> + *<br> + menu<br> + cat xye.dat | $plot(Title,X Axis,Y Axis,xyey)<br> + <br> + Test $plot(title,x,y,xyexey)<br> + *<br> + menu<br> + cat xyee.dat | $plot(Title,X Axis,Y + Axis,xyexey)<br> + <br> + Test $plot(title,x,y,4)<br> + *<br> + menu<br> + cat xyey.dat | $plot(Title,X Axis,Y Axis,4)<br> + <br> + Test $plot(title,x,y,5)<br> + *<br> + menu<br> + cat xyeye.dat | $plot(Title,X Axis,Y Axis,5)<br> + <br> + Test $plot(stdin)<br> + *<br> + menu<br> + cat xye.stdin.dat | $plot(stdin)<br> + <br> + Test $plot(stdin) text<br> + *<br> + menu<br> + cat xye.stdin.text.dat | $plot(stdin)<br> + <br> + Test $plot(stdin) error<br> + *<br> + menu<br> + cat xy.stdin.error.dat | $plot(stdin)<br> + <br> + Test $data<br> + *.fits<br> + menu<br> + $data | $image(new)<br> + <br> + Test $image<br> + *<br> + menu<br> + cat img16.fits | $image<br> + endhmenu<br> + <br> + hmenu Test Dialogs<br> + help Dialogs Help<br> + Help for dialog features<br> + endhelp<br> + ---<br> + Test $message(message)<br> + *<br> + menu<br> + $message(ok,This is a Message) | echo "hello" + | $text<br> + <br> + Test $message(ok,message)<br> + *<br> + menu<br> + $message(ok,This is a Message) | echo "World" + | $text<br> + <br> + Test $entry(message)<br> + *<br> + menu<br> + echo "$entry(Enter Something)" | $text<br> + endhmenu<br> + <br> + hmenu Test Params<br> + help Param Help<br> + Help for param features<br> + endhelp<br> + ---<br> + Test $param<br> + *<br> + menu<br> + $param(foo); echo "$var1 $var2 $var3" | $text<br> + <br> + Test $param @file<br> + *<br> + menu<br> + $param(bar); echo "$var1 $var2 $var3" | $text<br> + endhmenu<br> + <br> + hmenu Test Network<br> + help Network Help<br> + Help for network features<br> + endhelp<br> + ---<br> + Test $url(http://)<br> + *<br> + menu<br> + + $url(http://legacy.gsfc.nasa.gov/FTP/rosat/data/cdrom/vol1/IMAGES/00h/p000s26b.img.Z) + +| +gunzip + + + + + | $image<br> + <br> + Test $url(ftp://)<br> + *<br> + menu<br> + + $url(ftp://legacy.gsfc.nasa.gov/rosat/data/hri/images/fits/rh100193_img.fits) + + + + + | $image<br> + <br> + Test $geturl $text<br> + *<br> + menu<br> + +$geturl(http://hea-www.harvard.edu/RD/saord-cgi/funtools?funcnts+$filename+$regions(source,,)+$regions(background,,))|$text<br> + <br> + Test $geturl $plotstd<br> + *<br> + menu<br> + $param(ltc); +$geturl(http://hea-www.harvard.edu/RD/saord-cgi/funtools?funhist_plot+$filename[$regions]+time+$bins)|$plot(stdin)<br> + endhmenu<br> + <br> + hmenu Test Other<br> + help Other Help<br> + Help for other features<br> + endhelp<br> + ---<br> + Test $param @tvdisply<br> + *<br> + menu<br> + $param(foobar); echo "$frame $erase" | $text<br> + <br> + hmenu Test MultiLevel<br> + test<br> + *<br> + menu<br> + echo "Hello World" | $text<br> + endhmenu<br> + endhmenu<br> + <br> + $x $y<br> + *.fits<br> + bind x<br> + echo "$x $y" | $text<br> + <br> + $x(fk5,hms) $y(fk5,hms)<br> + *.fits<br> + bind y<br> + echo "$x(fk5,hms) $y(fk5,hms)" | $text<br> + <br> + $x(wcs,fk5,hms) $y(wcs,fk5,hms)<br> + *.fits<br> + bind z<br> + echo "$x(wcs,fk5,hms) $y(wcs,fk5,hms)" | $text<br> + </tt> </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/backup.html b/ds9/doc/ref/backup.html new file mode 100644 index 0000000..63bc304 --- /dev/null +++ b/ds9/doc/ref/backup.html @@ -0,0 +1,60 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=ISO-8859-1"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Backup</title> + </head> + <body alink="#ff0000" bgcolor="#ffffff" link="#0000ee" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" align="middle" width="100" + height="98"> Backup and Restore</h3> + <blockquote> + <p>DS9 now supports Backup and Restore. When a backup is invoked, + DS9 will save in a backup save set all files needed to restore + DS9 to that state, including geometry, data files, colormaps, + catalogs, contours, and regions.<br> + </p> + <p><b>Backup Save Set</b></p> + <p>A backup save set consists of a text file, called a backup + script, and an optional directory, which will contain auxiliary + data files needed to restore DS9 to a previous state. The backup + file and the auxiliary directory maybe moved across file + systems, or even platforms, but must remain together in the same + directory. <br> + </p> + <p><b>Image data files</b></p> + <p>By default, all data image files are save within the backup + save set. However, the user has the option, via the Preferences, + to only save only an absolute pathname to the data file, and not + the data file itself. This option will dramatically reduce the + size of a backup save set, but will restrict the usage to a + particular file system and platform.<br> + </p> + <p>Image files that have been loaded into DS9 via XPA, SAMP, or + from URL will always be saved into the save set.<br> + </p> + <p><b>Caveats</b></p> + <p>There are several caveats in the usage of Backup and Restore. + In particular:<br> + </p> + <blockquote> + <p> <tt>Currently, there is no support for masks.<br> + External Analysis menus will not be saved.<br> + Plot Tool windows will not be saved.<br> + IIS frames (IRAF) will not be saved.<br> + SAMP and XPA sessions will not be saved.</tt></p> + </blockquote> + <p>And finally, if the image data had been loaded into DS9 via + XPA, SAMP, or from a URL, the following complex load operations + are not supported:</p> + <blockquote> <tt>Open Mosaic IRAF Image<br> + Open Mosaic IRAF Segment Open Mosaic WCS Image<br> + Open Mosaic WCS Segment Open Mosaic WFPC2 Open RGB Fits Image + Open RGB Fits Cube Open RGB Array Open Multi Ext Data Cube + Open Multi Ext Multiple Frames </tt></blockquote> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/bin.html b/ds9/doc/ref/bin.html new file mode 100644 index 0000000..966d3ba --- /dev/null +++ b/ds9/doc/ref/bin.html @@ -0,0 +1,53 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=ISO-8859-1"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Bin</title> + </head> + <body alink="#ff0000" bgcolor="#ffffff" link="#0000ee" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" align="middle" height="98" + width="100"> Binning</h3> + <blockquote> + <p>To create an image from a FITS Bin Table, the user needs to + specify a binning factor, binning buffer size, and the binning + function.<br> + </p> + <p>The Binning (or Block) Factor is defined as the following: A + value greater or equal to zero. This value indicates the number + of pixel values that will fall into a particular bin.<br> + </p> + <p>The Bin Buffer Size is overall size of the image generated. + This has no relation to min and max values of the columns used + to create the image. <br> + </p> + <p>The Bin Function is defined as the following: Average - all + pixel values that fall into one pixel bin are averaged. Sum - + all pixel values that fall into one pixel bin are summed.<br> + </p> + <p>Bin to Fit Frame will calculate a bin block factor as a power + of 2 that will allow the entire data space to be displayed in + the current frame. </p> + <p>By default, DS9 will bin about the center of the image. To + determine the center of the image, DS9 will look for the + following keywords in order:</p> + <blockquote> <tt>TDMIN/TDMAX<br> + TLMIN/TLMAX<br> + TALEN<br> + AXLEN</tt> </blockquote> + <p>If no valid keywords are found, DS9 will define the center as + the middle of the possible data space based on the coordinate + data type.</p> + <br> + <p><br> + </p> + <blockquote> </blockquote> + <p><br> + </p> + <br> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/catalog.html b/ds9/doc/ref/catalog.html new file mode 100644 index 0000000..3cd39c8 --- /dev/null +++ b/ds9/doc/ref/catalog.html @@ -0,0 +1,147 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Catalogs</title> + </head> + <body link="#0000ee" alink="#ff0000" bgcolor="#ffffff" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" height="98" align="middle" + width="100"> Catalogs</h3> + <blockquote> + <p>DS9 provides full support for loading, displaying, filtering, + and saving catalogs. DS9 allows you to overlay symbols from + multiple catalogs on the current image.</p> + <p>Local and on-line catalog access is supported. Most major + catalogs can be retrieved from online servers. Both the CDS and + SDSS catalog servers are now supported. Local catalog files in + starbase (rdb) or CSV (with or without header) are supported.</p> + <p>On-line catalogs are available via services provided by the + VizieR catalog access tool, CDS, Strasbourg, France (VizieR is a + joint effort of the Centre de Donnees Astronomiques de + Strasbourg and ESA-ESRIN Information Systems Division) and by + the Sloan Digital Sky Survey.</p> + <p>A selection of popular catalogs is provided in the Analysis + menu. In addition, you can search for other catalogs based on + title, keywords, mission, wavelength, and object type.</p> + <p>When a catalog is overlayed on an image, each displayed catalog + symbol consists of a shape, color, and text. An advanced symbol + editor is available that allows you to specify the shape, size, + color, and text of each symbol, based on catalog column values. + These symbol expressions can be saved for future use.</p> + <p>Along with the overlay display, a catalog list is provided in a + separate window. It displays the column values for each catalog + object. The catalog list can be sorted and filtered, and the + catalog display will be automatically updated. Advanced + filtering options are available. Catalogs can be loaded and + saved as local files in ASCII Starbase format. Each catalog + contains header information which can be displayed. The list can + be printed separately from the image.</p> + <p>An interactive connection between the displayed catalog symbols + and the catalog list is provided. When you select one or more + rows within the catalog list, the corresponding symbols are + highlighted on the image display. Conversely, selecting multiple + symbols on the image display will highlight the corresponding + rows within the catalog list. Catalog symbols can be converted + to regions for use with analysis tasks.</p> + <p><b>Filter Option</b></p> + <p>The catalog list can be sorted and filtered, and the catalog + display will be automatically updated. A filter is conditional + expression, when evaluated for each row of the catalog, if true, + the row is displayed, and if false, the row is not displayed. + The conditional expression can be any valid TCL expression. The + value of a column may be indicated with <tt>$<column + name></tt>.</p> + <blockquote> <tt>$_RAJ2000>180. && $_RAJ2000<270.</tt><br> + <tt>$Jmag>11</tt><br> + <tt>log($Kmag*10)<.3<br> + </tt><tt>[string equal $OTYPE_S SNR]</tt><br> + </blockquote> + <p><b>Advanced Symbol Editor</b></p> + <p>An advanced symbol editor is available that allows you to + specify the shape, size, color, and text of each symbol, based + on catalog column values. For each row of the catalog, one or + more conditional expressions are evaluated. For the first + expression to evaluate true, a given symbol is displayed, with + the specified shape, color, size and text properties. As with + the filter, the value of a particular column can be indicated as + <tt>$<column name>.</tt></p> + <p>For the condition entry, the expression you type in is + automatically evaluated via TCL <tt>expr</tt> after macro + expansion.</p> + <blockquote> <tt>1 # + + + always</tt><br> + <tt>0 # + + + never</tt><br> + <tt>true # + + + always</tt><br> + <tt>false # + + + never</tt><br> + <tt>$Jmag>2 # + + + conditional</tt><br> + <tt>sin($Jmag)>.5 + + + + # conditional</tt><br> + <tt>[string equal $Class + SNR] # conditional</tt><br> + <tt>[regexp {*SNR*} + $Class] # + conditional</tt><br> + </blockquote> + <p>For the size, size2, and angle entries, the expression you type + in is also automatically evaluated via TCL <tt>expr</tt> after + macro expansion.</p> + <blockquote> <tt>2 # + + + value of '2' is used</tt><br> + <tt>$Jmag # + + + value of column Jmag is used</tt><br> + <tt>$Jmag/2. # + value of column Jmag div 2 is used</tt><br> + <tt>(4+2)/3 # + + + value of '2' is used</tt><br> + </blockquote> + <p>For the text portion, this is not true. It is assumed to be + text, unless you explicitly use an <tt>expr </tt>operator.</p> + <blockquote> <tt>foo # + + + will put 'foo' above the symbol</tt><br> + <tt>$Jmag # + + + will put the value of column Jmag above the symbol</tt><br> + <tt>(4+2)/3 # + + + will put the text '(4+2)/3' above the symbol</tt><br> + <tt>[expr (4+2)/3] # will put the text '2' above the + symbol</tt><br> + <tt>[expr $Jmag/2.] # will take the value of Jmag and div + by 2</tt><br> + </blockquote> + <p>And finally, one special case for shape = text and text = + empty. In this case, the row number is displayed. </p> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/colorbar.html b/ds9/doc/ref/colorbar.html new file mode 100644 index 0000000..ee432cd --- /dev/null +++ b/ds9/doc/ref/colorbar.html @@ -0,0 +1,71 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=ISO-8859-1"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Color</title> + </head> + <body alink="#ff0000" bgcolor="#ffffff" link="#0000ee" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" align="middle" width="100" + height="98"> Colorbar<br> + </h3> + <blockquote> + <p><b>Color Tags</b></p> + <p>The purpose of color tags are to highlight (or hide) certain + values of data, regardless of the color map selected. The user + creates, edits, and deletes color tags via the GUI. To create a + color tag, enter the Colorbar Mode, and click once on the + colorbar. This creates a default color tag. Click and drag to + change the values. Click and drag on one side to increase or + decrease the value. Double click to manually edit the values and + color. Place the cursor over the color tag and press the delete + key to delete it. From the color parameters dialog, the user can + load, save, and delete all color tags for that frame.<br> + </p> + <p><b>Visuals</b></p> + <p>DS9 supports a number of color environments. Not all color + environments, or visuals, are available on most machines. In + fact, you may be restricted to one or two, base on the color + graphics hardware your computer has. A color visual is composed + of two parts, the color model and the bit depth. Pseudo color + uses a color lookup table to derive the correct color, True + color uses the value directly as a RGB triplet, to derive the + correct color. The follow is a list of the color visuals DS9 + currently supports:</p> + <blockquote> <tt>pseudo color, 8 bit<br> + true color, 8 bit <br> + true color, 15 bit <br> + true color, 16 bit <br> + true color, 24 bit</tt> </blockquote> + <p> You can use the <tt>xdpyinfo</tt> command to see if one of + these visual are available. NOTE: Linux Users-- if your desired + visual is not available, use the Xconfigarator command (Red Hat) + or similar command under other versions of linux, to configure + your X window visuals.</p> + <p>When DS9 is invoked, by default, it will use the default + visual. You can find out what the default visual is by using the + <tt>xdpyinfo</tt> command. You can also force DS9 to use another + visual by command line option. If you specify a visual, and it + is not available, DS9 will exit with an error message. </p> + <blockquote><tt>$ds9 + + + # default visual, default depth<br> + $ds9 -visual pseudo # + pseudo color, default depth <br> + $ds9 -visual pseudocolor # pseudo color, default depth <br> + $ds9 -visual pseudocolor8 # pseudo color 8 <br> + $ds9 -visual + true # true + color, default depth <br> + $ds9 -visual truecolor # true color, default + depth <br> + $ds9 -visual truecolor8 # true color 8 <br> + $ds9 -visual truecolor16 # true color 16 <br> + $ds9 -visual truecolor24 # true color 24</tt> </blockquote> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/command.html b/ds9/doc/ref/command.html new file mode 100644 index 0000000..6da067d --- /dev/null +++ b/ds9/doc/ref/command.html @@ -0,0 +1,5025 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Command Line Options</title> + </head> + <body alink="#ff0000" link="#0000ff" vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" align="middle" height="98" + width="100"> Command Line Options</h3> + <blockquote> + <p>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:</p> + <tt>$ds9 -tile foo.fits -cmap Heat -zscale bar.fits -cmap I8</tt> + <p>First DS9 is put in tile mode, then <tt>foo.fits</tt> is + loaded. Then the colormap for <tt>foo.fits</tt> is changed to <tt>Heat</tt> + and the scale changed to <tt>zscale</tt>. Next, <tt>bar.fits</tt> + is loaded and the colormap for <tt>bar.fits</tt> is changed to + <tt>I8.</tt> </p> + <tt> <a href="#2mass">2mass</a><br> + <a href="#3d">3d</a><br> + <a href="#about">about</a><br> + <a href="#align">align</a><br> + <a href="#analysis">analysis</a><br> + <a href="#array">array</a><br> + <a href="#asinh">asinh</a><br> + <a href="#background">background</a><br> + <a href="#backup">backup</a><br> + <a href="#bin">bin</a><br> + <a href="#blink">blink</a><br> + <a href="#block">block</a><br> + <a href="#blue">blue</a><br> + <a href="#catalog">catalog</a><br> + <a href="#cd">cd</a><br> + <a href="#cmap">cmap</a><br> + <a href="#colorbar">colorbar</a><br> + <a href="#console">console</a><br> + <a href="#contour">contour</a><br> + <a href="#crop">crop</a><br> + <a href="#crosshair">crosshair</a><br> + <a href="#cube">cube</a><br> + <a href="#cursor">cursor</a><br> + <a href="#dsssao">dsssao</a><br> + <a href="#dsseso">dsseso</a><br> + <a href="#dssstsci">dssstsci</a><br> + <a href="#envi">envi</a><br> + <a href="#exit">exit</a><br> + <a href="#export">export</a><br> + <a href="#fifo">fifo</a><br> + <a href="#fifo_only">fifo_only</a><br> + <a href="#fits">fits</a><br> + <a href="#frame">frame</a><br> + <a href="#geometry">geometry</a><br> + <a href="#gif">gif</a><br> + <a href="#green">green</a><br> + <a href="#geometry">grid</a><br> + <a href="#header">header</a><br> + <a href="#height">height</a><br> + <a href="#help">help</a><br> + <a href="#histequ">histequ</a><br> + <a href="#iconify">iconify</a><br> + <a href="#import">import</a><br> + <a href="#inet_only">inet_only</a><br> + <a href="#invert">invert</a><br> + <a href="#iis">iis</a><br> + <a href="#jpeg">jpeg</a><br> + <a href="#language">language</a><br> + <a href="#linear">linear</a><br> + <a href="#lock">lock</a><br> + <a href="#log">log</a><br> + <a href="#lower">lower</a><br> + <a href="#magnifier">magnifier</a><br> + <a href="#mask">mask</a><br> + <a href="#match">match</a><br> + <a href="#mecube">mecube</a><br> + <a href="#minmax">minmax</a><br> + <a href="#mode">mode</a><br> + <a href="#mosaic">mosaic</a><br> + <a href="#mosaicimage">mosaicimage</a><br> + <a href="#movie">movie</a><br> + <a href="#msg">msg</a><br> + <a href="#multiframe">multiframe</a><br> + <a href="#nameserver">nameserver</a><br> + <a href="#nan">nan</a><br> + <a href="#nrrd">nrrd</a><br> + <a href="#nvss">nvss</a><br> + <a href="#orient">orient</a><br> + <a href="#pagesetup">pagesetup</a><br> + <a href="#pan">pan</a><br> + <a href="#pixeltable">pixeltable</a><br> + <a href="#plot">plot</a><br> + <a href="#png">png</a><br> + <a href="#prefs">prefs</a><br> + <a href="#preserve">preserve</a><br> + <a href="#psprint">psprint</a><br> + <a href="#print">print</a><br> + <a href="#private">private</a><br> + <a href="#port">port</a><br> + <a href="#port_only">port_only</a><br> + <a href="#pow">pow</a><br> + <a href="#exit">quit</a><br> + <a href="#raise">raise</a><br> + <a href="#regions">regions</a><br> + <a href="#red">red</a><br> + <a href="#restore">restore</a><br> + <a href="#rgb">rgb</a><br> + <a href="#rgbarray">rgbarray</a><br> + <a href="#rgbcube">rgbcube</a><br> + <a href="#rgbimage">rgbimage</a><br> + <a href="#rotate">rotate</a><br> + <a href="#samp">samp</a><br> + <a href="#save">save</a><br> + <a href="#saveimage">saveimage</a><br> + <a href="#scale">scale</a><br> + <a href="#shm">shm</a><br> + </tt><tt><tt><a href="#sia">sia</a><br> + </tt> <a href="#single">single</a><br> + <a href="#sinh">sinh</a><br> + <a href="#skyview">skyview</a><br> + <a href="#sleep">sleep</a><br> + <a href="#slice">slice</a><br> + <a href="#smooth">smooth</a><br> + <a href="#squared">squared</a><br> + <a href="#sqrt">sqrt</a><br> + <a href="#source">source</a><br> + <a href="#tcl">tcl</a><br> + <a href="#threads">threads</a><br> + <a href="#tiff">tiff</a><br> + <a href="#tile">tile</a><br> + <a href="#title">title</a><br> + <a href="#unix">unix</a><br> + <a href="#unix_only">unix_only</a><br> + <a href="#update">update</a><br> + <a href="#url">url</a><br> + <a href="#version">version</a><br> + <a href="#view">view</a><br> + <a href="#visual">visual</a><br> + <a href="#vla">vla</a><br> + </tt><tt><tt><a href="#vlss">vlss</a><br> + </tt><a href="#vo">vo</a><br> + <a href="#wcs">wcs</a><br> + <a href="#web">web</a><br> + <a href="#width">width</a><br> + <a href="#xpa">xpa</a><br> + <a href="#zmax">zmax</a><br> + <a href="#zoom">zoom</a><br> + <a href="#zscale">zscale</a><br> + </tt> + <p><b><a name="2mass"></a>2mass </b></p> + <p>Support for 2MASS Digital Sky Survey.</p> + <tt> Syntax: <br> + -2mass []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> + <dec> degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [survey j|h|k] <br> + [open|close]<br> + <br> + Example:<br> + $ds9 -2mass<br> + $ds9 -2mass m31 <br> + $ds9 -2mass name m31 <br> + $ds9 -2mass coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + $ds9 -2mass size 60 60 arcmin<br> + $ds9 -2mass save yes<br> + $ds9 -2mass frame current<br> + $ds9 -2mass update frame<br> + $ds9 -2mass survey j<br> + $ds9 -2mass open<br> + $ds9 -2mass close<br> + </tt> + <p><b><a name="3d"></a>3d </b></p> + <p>Support for 3D frame.</p> + <tt> Syntax: <br> + </tt><tt>-3d []<br> + [view <az> <el>]<br> + [az <az>]<br> + [el <el>]<br> + [scale <scale>]<br> + [method mip|aip]</tt><br> + <tt><tt> [background none|azimuth|elevation]<br> + </tt> </tt><tt> [border yes|no]<br> + [border color]<br> + </tt><tt> [highlite yes|no]<br> + [highlite color]<br> + </tt><tt> [open|close]<br> + </tt><tt> <br> + Example:<br> + $ds9 -3d # create new 3D frame<br> + $ds9 -3d view 45 30<br> + $ds9 -3d az 45<br> + $ds9 -3d el 30<br> + $ds9 -3d scale 10<br> + $ds9 -3d method mip</tt><br> + <tt>$ds9 -3d background azimuth<br> + </tt><tt>$ds9 -3d border yes<br> + $ds9 -3d border color red<br> + </tt> <tt>$ds9 -3d highlite yes<br> + $ds9 -3d highlite color red<br> + </tt> <tt>$ds9 -3d open<br> + $ds9 -3d close</tt><br> + <p><b><a name="about"></a>about</b></p> + <p>Get DS9 credits.</p> + <tt> Syntax: <br> + -about <br> + <br> + Example: <br> + $ds9 -about<br> + </tt> + <p><b> <a name="align"></a>align</b></p> + <p>Controls the World Coordinate System alignment for the current + frame.</p> + <tt> Syntax: <br> + -align [yes|no]<br> + <br> + Example: <br> + $ds9 -align yes <br> + </tt> + <p><b> <a name="analysis"></a>analysis</b></p> + <p>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. </p> + <tt> Syntax: <br> + -analysis [<task number>]<br> + + [<filename>]<br> + [task <task + number>|<task name>]<br> + [load + <filename>]<br> + [clear] <br> + + [clear][load <filename>] <br> + [message + ok|okcancel|yesno <message>]<br> + [entry + <message>] <br> + [text]</tt><tt><tt><tt><tt><tt><br> + </tt></tt> </tt></tt><br> + Example:<br> + $ds9 -analysis 0 # invoke first analysis task<br> + $ds9 -analysis task 0<br> + </tt><tt>$ds9 -analysis task foobar<br> + </tt><tt>$ds9 -analysis task "{foo bar}"<br> + $ds9 -analysis my.ans<br> + $ds9 -analysis load my.ans <br> + $ds9 -analysis clear <br> + $ds9 -analysis clear load my.ans<br> + $ds9 -analysis message '{This is a message}'<br> + $ds9 -analysis message okcancel '{This is a message}'<br> + $ds9 -analysis text '{This is text}'</tt><tt><br> + </tt> + <p><b> <a name="array"></a>array</b></p> + <p>Load raw data array into current frame.<br> + </p> + <tt> Syntax:<br> + -array +<filename>[[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,endian=[little|big]]<br> + <br> + Example: <br> + $ds9 -array foo.arr[dim=512,bitpix=-32,endian=little]</tt><br> + <tt>$cat foo.arr | ds9 -array -[dim=512,bitpix=-32,endian=little]</tt><tt><br> + </tt> + <p><b> <a name="asinh"></a></b><b>asinh</b> </p> + <p>Select ASINH scale function for the current frame.</p> + <tt> Syntax:<br> + -asinh <br> + <br> + Example: <br> + $ds9 -asinh</tt><br> + <p><b><a name="background"></a>bg<br> + background</b></p> + <p>Set image background color. </p> + <tt> Syntax: <br> + -bg <color><br> + <br> + Example:<br> + $ds9 -background red<br> + $ds9 -bg red</tt><br> + <p><b> <a name="backup"></a>backup</b></p> + <p>Create a backup save set. </p> + <tt> Syntax: <br> + -backup <filename><br> + <br> + Example:<br> + $ds9 -backup ds9.bck</tt><br> + <p><b> <a name="bin"></a>bin</b></p> + <p>Controls binning factor, binning buffer size, and binning + function for binning FITS bin tables. </p> + <tt> Syntax: <br> + -bin [about <x> <y>] <br> + [about center]<br> + [buffersize <value>] <br> + [cols <x> <y>]<br> + [colsz <x> <y> <z>]<br> + [factor <value> [<value>]] + <br> + [depth <value>] <br> + [filter <string>] <br> + [function average|sum] <br> + [in]<br> + [out]<br> + [to fit] <br> + [match]<br> + [lock [yes|no]]<br> + [open|close]<br> + <br> + Example: <br> + $ds9 -bin about 4096 4096<br> + $ds9 -bin about center<br> + $ds9 -bin buffersize 512<br> + $ds9 -bin cols detx dety<br> + $ds9 -bin colsz detx dety time<br> + $ds9 -bin factor 4<br> + $ds9 -bin factor 4 2<br> + $ds9 -bin depth 10<br> + $ds9 -bin filter 'pha > 5'<br> + $ds9 -bin filter ''<br> + $ds9 -bin function sum<br> + </tt><tt><tt>$ds9 -bin in<br> + $ds9 -bin out<br> + </tt>$ds9 -bin to fit<br> + $ds9 -bin match<br> + $ds9 -bin lock yes<br> + $ds9 -bin open<br> + $ds9 -bin close<br> + </tt> + <p><b> <a name="blink"></a>blink</b></p> + <p>Blink mode parameters. Interval is in seconds.</p> + <tt> Syntax: <br> + -blink []<br> + [yes|no]<br> + [interval <value>]<br> + <br> + Example: <br> + $ds9 -blink<br> + $ds9 -blink yes<br> + $ds9 -blink interval 1</tt><br> + <p><b> <a name="block"></a>block</b></p> + <p>Controls blocking parameters. </p> + <tt> Syntax: <br> + -block</tt><tt><tt> [<value>] <br> + [<value> + <value>]<br> + [to <value>] <br> + [to <value> + <value>]<br> + [in]<br> + [out]<br> + </tt> [to fit] <br> + [match]<br> + [lock [yes|no]]<br> + [open|close]<br> + <br> + Example: <br> + </tt><tt>$ds9 </tt><tt><tt><tt>-block</tt></tt> 4<br> + $ds9 </tt><tt><tt><tt>-block</tt></tt> 4 2<br> + </tt><tt><tt><tt>$ds9 </tt><tt><tt><tt>-block</tt></tt> to 4<br> + $ds9 </tt><tt><tt><tt>-block</tt></tt> to 4 2<br> + </tt>$ds9 </tt><tt><tt><tt>-block</tt></tt> in<br> + </tt></tt><tt><tt><tt>$ds9 </tt><tt><tt><tt>-block</tt></tt> + out<br> + </tt></tt>$ds9 </tt><tt><tt><tt>-block</tt></tt> to fit<br> + $ds9 </tt><tt><tt><tt>-block</tt></tt> match<br> + $ds9 </tt><tt><tt><tt>-block</tt></tt> lock yes<br> + $ds9 </tt><tt><tt><tt>-block</tt></tt> open<br> + $ds9 </tt><tt><tt><tt>-block</tt></tt> close</tt><tt><br> + </tt> <b> </b> + <p><b> <a name="blue"></a>blue</b></p> + <p>For RGB frames, sets the current color channel to blue.</p> + <tt> Syntax: <br> + -blue<br> + <br> + Example: <br> + $ds9 -blue foo.fits<br> + </tt> + <p><b> <a name="catalog"></a>catalog<br> + cat</b></p> + <p>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.</p> + <tt> Syntax: <br> + </tt><tt>-catalog []<br> + + [ned|simbad|denis|skybot]<br> + + [ascss|cmc|gsc1|gsc2|gsc3|ac|nomad|ppmx|sao|sdss5|sdss6|</tt><tt>sdss7|sdss8|</tt><tt>tycho|ua2|ub1|ucac2]<br> + [2mass|iras]<br> + [csc|xmm|rosat]<br> + [first|nvss]<br> + + [chandralog|cfhtlog|esolog|stlog|xmmlog]<br> + [cds <catalogname>]<br> + [cds + <catalogid>]<br> + <br> + [load <filename>]<br> + [import sb|tsv + <filename>]<br> + <br> + </tt><tt> [<ref>] [allcols]<br> + </tt><tt> </tt><tt> + [<ref>] [allrows]<br> + </tt><tt> [<ref>] + [cancel]<br> + </tt><tt> [<ref>] + [clear]<br> + </tt><tt> [<ref>] [close]</tt><br> + <tt> [<ref>] + [coordinate <ra> <dec> <coordsys>]</tt><tt><br> + </tt><tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [crosshair]</tt><br> + <tt> [<ref>] [dec + <col>]</tt><br> + <tt> [<ref>] [edit + yes|no]</tt><br> + <tt> [<ref>] + [export sb|tsv <filename>]<br> + </tt><tt> [<ref>] + [filter <string>]<br> + [<ref>] [filter load + <filename>]</tt><br> + <tt> [<ref>] + [header]</tt><br> + <tt> [<ref>] [hide]</tt><br> + <tt> [<ref>] [location + <code>]</tt><br> + <tt> [<ref>] + [match <ref> <ref>]<br> + </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match error <value> degrees|arcmin|arcsec]</tt><br> + <tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match function 1and2|1not2|2not1]<br> + </tt><tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match return 1and2|1only|2only]</tt><br> + <tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match unique yes|no]</tt><br> + <tt> [<ref>] [maxrows + <number>]</tt><br> + <tt> [<ref>] [name + <object>]<br> + </tt><tt> [<ref>] + [panto yes|no]</tt><br> + <tt> [<ref>] [plot + <xcol> <ycol> <xerrcol> <yerrcol>]</tt><br> + <tt> [<ref>] [print]</tt><br> + <tt> [<ref>] [psky + <skyframe>]</tt><br> + <tt> [<ref>] [psystem + <coordsys>]</tt><br> + <tt> [<ref>] [ra + <col>]</tt><br> + <tt><tt> [<ref>] + [regions]</tt><br> + <tt> </tt> [<ref>] + [retrieve]<br> + </tt><tt> [<ref>] + [samp]<br> + [<ref>] [samp + broadcast]<br> + [<ref>] [samp + send <application>]</tt><tt><br> + </tt><tt> [<ref>] + [save <filename>]</tt><br> + <tt> [<ref>] + [server cds|sao|cadc|adac|iucaa|bejing|cambridge|ukirt]</tt><br> + <tt> [<ref>] [show]</tt><br> + <tt> [<ref>] [size + <width> <height> degrees|arcmin|arcsec]</tt><br> + <tt> </tt><tt> [<ref>] + [sky <skyframe>]<br> + </tt><tt> [<ref>] + [skyformat <skyformat>]<br> + </tt><tt> [<ref>] [sort + <col> incr|decr]</tt><br> + <tt> [<ref>] [symbol + [#] + condition|shape|color|text|font|fontsize|fontweight|fontslant + <value>] <br> + </tt><tt> [<ref>] + [symbol [#] text|size|size2|units|angle <value>] <br> + </tt><tt> [<ref>] + [symbol shape {circle point}|{box point}|{diamond point}|<br> + + {cross point}|{x + point}|{arrow point}|{boxcircle point}|<br> + + circle|ellipse|box|text]<br> + [<ref>] [symbol + add| [#] remove]<br> + [<ref>] [symbol + save|load <filename>]</tt><br> + <tt> [<ref>] [system + <coordsys>]</tt><tt><br> + </tt><tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [update]</tt><br> + <tt> [<ref>] [x + <col>]</tt><br> + <tt> [<ref>] [y + <col>]</tt><br> + <tt><br> + Example:<br> + </tt><tt>$ds9 -catalog<br> + $ds9 -catalog 2mass<br> + $ds9 -catalog cds 2mass<br> + $ds9 -catalog cds "I/252"<br> + <br> + </tt><tt>$ds9 -catalog load foo.xml<br> + $ds9 -catalog import tsv foo.tsv<br> + <br> + </tt><tt>$ds9 -catalog allrows<br> + $ds9 -catalog allcols<br> + </tt><tt>$ds9 -catalog cancel<br> + </tt><tt>$ds9 -catalog clear<br> + </tt><tt>$ds9 -catalog close<br> + </tt><tt>$ds9 -catalog coordinate 202.48 47.21 fk5<br> + </tt><tt>$ds9 -catalog crosshair<br> + </tt><tt>$ds9 -catalog dec DEC<br> + </tt><tt>$ds9 -catalog edit yes<br> + </tt><tt>$ds9 -catalog export tsv bar.tsv<br> + </tt><tt>$ds9 -catalog filter </tt><tt>'\$Jmag>15'</tt><tt><br> + $ds9 -catalog filter load foo.flt<br> + $ds9 -catalog header<br> + </tt><tt>$ds9 -catalog hide<br> + </tt><tt>$ds9 -catalog location 500</tt><br> + <tt>$ds9 -catalog match error 2 arcsec<br> + $ds9 -catalog match function 1and2<br> + $ds9 -catalog match unique no<br> + $ds9 -catalog match return 1only<br> + $ds9 -catalog match 2mass csc<br> + </tt><tt>$ds9 -catalog maxrows 2000<br> + </tt><tt>$ds9 -catalog name m51<br> + $ds9 -catalog panto no<br> + </tt><tt>$ds9 -catalog plot </tt><tt>'\$Jmag' '\$Hmag' '\$e_Jmag' + '\$e_Hmag'</tt><tt><br> + </tt><tt>$ds9 -catalog print</tt><br> + <tt>$ds9 -catalog psky fk5</tt><br> + <tt>$ds9 -catalog psystem wcs</tt><br> + <tt>$ds9 -catalog ra RA</tt><br> + <tt><tt>$ds9 -catalog regions<br> + </tt><tt> </tt>$ds9 -catalog retrieve<br> + </tt><tt> $ds9 -catalog samp broadcast<br> + $ds9 -catalog samp send aladin<br> + $ds9 -catalog save foo.xml<br> + </tt><tt>$ds9 -catalog server sao<br> + </tt><tt>$ds9 -catalog show</tt><br> + <tt> $ds9 -catalog size 1 1 degrees</tt><br> + <tt>$ds9 -catalog symbol condition '\$Jmag>15'<br> + $ds9 -catalog symbol 2 shape "boxcircle point"<br> + $ds9 -catalog symbol color red<br> + $ds9 -catalog symbol font times<br> + </tt><tt>$ds9 -catalog symbol fontsize 14<br> + </tt><tt>$ds9 -catalog symbol fontweight bold<br> + </tt><tt>$ds9 -catalog symbol fontslant italic<br> + </tt><tt>$ds9 -catalog symbol add<br> + $ds9 -catalog symbol 2 remove<br> + $ds9 -catalog symbol load foo.sym<br> + $ds9 -catalog symbol save bar.sym</tt><tt><br> + $ds9 -catalog sky fk5<br> + $ds9 -catalog skyformat degrees<br> + </tt><tt>$ds9 -catalog sort "Jmag" incr<br> + </tt><tt>$ds9 -catalog system wcs</tt><tt><br> + </tt><tt>$ds9 -catalog update<br> + </tt><tt>$ds9 -catalog x RA<br> + $ds9 -catalog y DEC</tt><br> + <p><b><a name="cd"></a>cd</b></p> + <p>Sets the current working directory. </p> + <tt> Syntax: <br> + cd [<directory>] <br> + <br> + Example: <br> + $ds9 -cd /home/mrbill<br> + </tt> + <p><b> <a name="cmap"></a>cmap</b></p> + <p>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. </p> + <tt> Syntax: <br> + -cmap [<colormap>] <br> + [file]<br> + [load <filename>] <br> + [save <filename>]<br> + [invert yes|no] <br> + [value <contrast> + <bias>] <br> + </tt><tt> [tag [load|save] + <filename>]<br> + [tag delete]</tt><br> + <tt> [match]<br> + [lock [yes|no]]</tt><br> + <tt> [open|close]<br> + <br> + Example: <br> + $ds9 -cmap Heat <br> + $ds9 -cmap load foo.sao <br> + $ds9 -cmap save bar.sao<br> + $ds9 -cmap invert yes <br> + $ds9 -cmap value 5 .5<br> + $ds9 -cmap tag load foo.tag<br> + $ds9 -cmap tag save foo.tag<br> + $ds9 -cmap tag delete<br> + </tt><tt>$ds9 -cmap match<br> + $ds9 -cmap lock yes</tt><br> + <tt> $ds9 -cmap open<br> + $ds9 -cmap close<br> + </tt> + <p><b><a name="colorbar"></a>colorbar</b></p> + <p>Controls colorbar parameters.</p> + <tt> Syntax: <br> + -colorbar []<br> + [yes|no]<br> + + [horizontal|vertical]<br> + [orientation + horizontal|vertical]<br> + [numerics + yes|no]<br> + [space + value|distance]<br> + [font + times|helvetica|courier]<br> + [fontsize + <value>]<br> + + [fontweight normal|bold]<br> + [fontslant + roman|italic]<br> + [size]<br> + [ticks]<br> + <br> + Example: <br> + $ds9 -colorbar yes<br> + $ds9 -colorbar vertical<br> + $ds9 -colorbar orientation vertical<br> + $ds9 -colorbar numerics yes<br> + $ds9 -colorbar space value<br> + $ds9 -colorbar font times<br> + $ds9 -colorbar fontsize 14<br> + $ds9 -colorbar fontweight bold<br> + $ds9 -colorbar fontslant italic<br> + $ds9 -colorbar size 20<br> + $ds9 -colorbar ticks 11<br> + </tt> + <p><b> <a name="console"></a>console</b></p> + <p>Display tcl console window.</p> + <tt> Syntax: <br> + -console<br> + <br> + Example:<br> + $ds9 -console<br> + </tt> + <p><b> <a name="contour"></a>contour<br> + </b></p> + <p>Controls contours in the current frame. </p> + <tt> Syntax: <br> + -contour []<br> + [yes|no]<br> + [clear]<br> + [generate]<br> + [load + <filename> [<color> <width> yes|no]]<br> + [save + <filename> <coordsys> <skyframe>]<br> + [convert]<br> + [loadlevels + <filename>]</tt><br> + <tt><tt> + [savelevels <filename>]<br> + </tt> [copy]<br> + [paste + <coordsys> [<color> <width> yes|no]]<br> + [color + <color>]<br> + [width + <width>]<br> + [dash yes|no]<br> + [smooth + <smooth>]<br> + [method + block|smooth]<br> + [nlevels <number + of levels>]<br> + [scale + linear|log|pow|squared|sqrt|asinh|sinh|histequ]<br> + [log exp + <value>]<br> + [mode + minmax|<value>|zscale|zmax]<br> + [limits <min> + <max>]<br> + [levels + <value value value...>] <br> + [open|close]<br> + <br> + Example: <br> + $ds9 -contour<br> + $ds9 -contour yes<br> + $ds9 -contour generate<br> + $ds9 -contour clear<br> + $ds9 -contour load ds9.ctr<br> + $ds9 -contour load ds9.ctr red 2 yes<br> + $ds9 -contour save ds9.ctr wcs fk5<br> + $ds9 -contour convert<br> + $ds9 -contour loadlevels ds9.ctr<br> + </tt><tt><tt>$ds9 -contour savelevels ds9.lev<br> + </tt>$ds9 -contour copy<br> + $ds9 -contour paste wcs red 2 no<br> + $ds9 -contour color yellow<br> + $ds9 -contour width 2<br> + $ds9 -contour dash yes<br> + $ds9 -contour smooth 5<br> + $ds9 -contour method smooth<br> + $ds9 -contour nlevels 10<br> + $ds9 -contour scale sqrt<br> + $ds9 -contour log exp 1000<br> + $ds9 -contour mode zscale<br> + $ds9 -contour limits 1 100<br> + $ds9 -contour levels "1 10 100 1000"<br> + $ds9 -contour open<br> + $ds9 -contour close<br> + </tt> + <p><b><a name="crop"></a>crop</b> </p> + <p>Set current image display area. </p> + <tt> Syntax: <br> + -crop [<x> <y> <width> <height> +[<coordsys>][<skyframe>][<skyformat>][degrees|arcmin|arcsec]<br> + </tt><tt> [match <coordsys>]<br> + [lock <coordsys>|none]</tt><tt> + <br> + <br> + Example: <br> + $ds9 foo.fits -crop 40 30 10 20 # set crop in physical coords<br> + $ds9 foo.fits -crop +104:51:06.915 +68:33:40.761 28.144405 + 22.000204 wcs galactic arcsec<br> + $ds9 foo.fits -crop match wcs<br> + $ds9 foo.fits -crop lock wcs<br> + </tt> + <p><b> <a name="crosshair"></a>crosshair</b></p> + <p>Controls the current position of the crosshair in the current + frame. DS9 is placed in crosshair mode when the crosshair is + set. </p> + <tt> Syntax: <br> + -crosshair [<x> <h> <coordsys> + [<skyframe>][<skyformat>]]<br> + </tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match <coordsys>]<br> + [lock + <coordsys>|none]</tt><br> + <tt> <br> + Example: <br> + $ds9 -crosshair 100 100 physical # set crosshair in physical <br> + $ds9 -crosshair 345 58.8 wcs fk5 # set crosshair in wcs coords <br> + $ds9 -crosshair 23:01:00 +58:52:51 wcs fk5<br> + $ds9 -crosshair match<br> + $ds9 -crosshair lock wcs<br> + </tt> + <p><b><a name="cube"></a>cube<br> + </b></p> + <p>Controls FITS cube. </p> + <tt> Syntax: <br> + -cube [play|stop|next|prev|first|last]<br> + [<slice> + [<coordsys>][<axis>]]<br> + [interval <numeric>]<br> + [axis <axis>]<br> + </tt><tt> [match <coordsys>]<br> + [lock <coordsys>|none]<br> + [order 123|132|213|231|312|321]<br> + [axes lock [yes|no]]<br> + </tt> <tt> [open|close]<br> + <br> + Example: <br> + $ds9 -cube play<br> + $ds9 -cube last<br> + $ds9 -cube 3<br> + $ds9 -cube 4.5 wcs 3<br> + $ds9 -cube interval 2<br> + $ds9 -cube axis 3<br> + $ds9 -cube match wcs<br> + $ds9 -cube lock wcs<br> + $ds9 -cube order 123<br> + $ds9 -cube axes lock yes<br> + $ds9 -cube open<br> + $ds9 -cube close</tt><br> + <p><b> <a name="cursor"></a>cursor</b></p> + <p>Move mouse pointer or crosshair in image pixels in the current + frame. Note, this will move selected Regions also. </p> + <tt> Syntax: <br> + -cursor [<x> <h>] <br> + <br> + Example: <br> + $ds9 -cursor 10 10</tt><tt><br> + </tt> + <p><b><a name="dsssao"></a>dsssao<br> + dss<br> + </b></p> + <p>Support for Digital Sky Survey at SAO.</p> + <tt> Syntax: <br> + -dsssao []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> + <dec> degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update + frame|crosshair]<br> + [open|close]<br> + <br> + Example:<br> + $ds9 -dsssao <br> + $ds9 -dsssao m31 <br> + $ds9 -dsssao name m31 <br> + $ds9 -dsssao coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + $ds9 -dsssao size 60 60 arcmin<br> + $ds9 -dsssao save yes<br> + $ds9 -dsssao frame current<br> + $ds9 -dsssao update frame<br> + $ds9 -dsssao open<br> + $ds9 -dsssao close<br> + </tt> + <p><b><a name="dsseso"></a>dsseso </b></p> + <p>Support for Digital Sky Survey at ESO.</p> + <tt> Syntax:<br> + -dsseso []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> + <dec> degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update + frame|crosshair]<br> + [survey + DSS1|DSS2-red|DSS2-blue|DSS2-infrared]<br> + [open|close]<br> + <br> + Example:<br> + $ds9 -dsseso <br> + $ds9 -dsseso m31 <br> + $ds9 -dsseso name m31 <br> + $ds9 -dsseso coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + $ds9 -dsseso size 60 60 arcmin<br> + $ds9 -dsseso save yes<br> + $ds9 -dsseso frame current<br> + $ds9 -dsseso update frame <br> + $ds9 -dsseso survey DSS2-red<br> + $ds9 -dsseso open<br> + </tt><tt>$ds9 -dsseso close</tt><br> + <p><b><a name="dssstsci"></a>dssstsci </b></p> + <p>Support for Digital Sky Survey at STSCI.</p> + <tt> Syntax:<br> + -dssstsci []<br> + [<object>]<br> + [name + <object>]<br> + [coord + <ra> <dec> degrees|sexagesimal] # in wcs fk5<br> + [size + <width> <height> degrees|arcmin|arcsec]<br> + [save + yes|no]<br> + [frame + new|current]<br> + [update + frame|crosshair]<br> + [survey + poss2ukstu_red|poss2ukstu_ir|poss2ukstu_blue] <br> + [survey + poss1_blue|poss1_red]<br> + [survey + all|quickv|phase2_gsc2|phase2_gsc1]<br> + [open|close]<br> + <br> + Example:<br> + $ds9 -dssstsci <br> + $ds9 -dssstsci m31 <br> + $ds9 -dssstsci name m31 <br> + $ds9 -dssstsci coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + $ds9 -dssstsci size 60 60 arcmin<br> + $ds9 -dssstsci save yes<br> + $ds9 -dssstsci frame current<br> + $ds9 -dssstsci update frame <br> + $ds9 -dssstsci survey all<br> + $ds9 -dssstsci open<br> + $ds9 -dssstsci close</tt><br> + <p><b> <a name="envi"></a>envi</b></p> + <p>Load an ENVI header and file. Optional parameter: array endian.<br> + </p> + <tt> Syntax: <br> + -envi <header> [<filename>]<br> + <br> + Example:<br> + </tt><tt><tt><tt><tt>$ds9 -envi foo.hdr</tt></tt><tt><tt><tt><tt><tt><tt><br> + </tt></tt></tt></tt></tt></tt> <b> </b>$ds9 -envi + foo.hdr foo.bsq</tt></tt><tt><tt><tt><tt><tt><tt><br> + </tt></tt></tt></tt></tt></tt> + <p><b> <a name="exit"></a>exit<br> + quit</b></p> + <p>Quits DS9. </p> + <tt> Syntax: <br> + -exit <br> + -quit <br> + <br> + Example: <br> + $ds9 -exit<br> + </tt> + <p><b> <a name="export"></a>export<br> + </b></p> + <p>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.<br> + </p> + <tt> Syntax: <br> + -export [array|nrrd|envi|gif|tiff|jpeg|png] <filename></tt><tt><br> + </tt><tt><tt>-export array <filename></tt><tt> </tt><tt>[big|little</tt><tt>|native]<br> + </tt>-export nrrd <filename> </tt><tt>[big|little</tt><tt>|native]</tt><br> + <tt>-export envi <header> [<filename>] </tt><tt>[big|little</tt><tt>|native]</tt><tt> + </tt><tt><br> + </tt><tt>-export <filename></tt><tt>.jpeg [1-100]<br> + </tt><tt>-export <filename></tt><tt>.tiff + [none|jpeg|packbits|deflate]</tt><br> + <tt> <br> + Example:<br> + $ds9 -export array foo.arr little<br> + $ds9 -export nrrd foo.nrrd little<br> + $ds9 -export envi foo.hdr little<br> + </tt><tt><tt>$ds9 -export envi foo.hdr foo.bsq little<br> + </tt>$ds9 -export tiff foo.tiff jpeg<br> + $ds9 -export jpeg foo.jpeg 75<br> + $ds9 -export png foo.png</tt><br> + <p><b><a name="fifo"></a>fifo</b></p> + <p>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. + </p> + <tt> Syntax: <br> + -fifo name <br> + <br> + Example: <br> + $ds9 -fifo /dev/imt1 </tt> + <p><b> <a name="fifo_only"></a>fifo_only</b></p> + <p>Only use IRAF input and output fifos. Same as -port 0 -unix + none. </p> + <tt> Syntax: <br> + -fifo_only <br> + <br> + Example: <br> + $ds9 -fifo_only<br> + </tt> + <p><b> <a name="fits"></a>fits</b></p> + <p>Load a FITS image into the current frame.<br> + </p> + <tt> Syntax: <br> + -fits </tt><tt><tt><filename></tt></tt><tt><br> + <br> + Example: <br> + </tt><tt>$ds9 -fits foo.fits<br> + $ds9 -fits bar.fits[bin=detx,dety]<br> + $cat foo.fits | ds9 -fits -<br> + $cat bar.fits | ds9 -fits -[bin=detx,dety]</tt><tt><br> + </tt> + <p><b><a name="frame"></a>frame</b></p> + <p>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. </p> + <tt> Syntax: <br> + -frame [center [#|all]]<br> + [clear [#|all]]<br> + [new [rgb]]<br> + [delete [#|all]] <br> + [reset [#|all]]<br> + [refresh [#|all]]<br> + [hide [#|all]]<br> + [show [#|all]]<br> + [move first]<br> + [move back]<br> + [move forward]<br> + [move last]<br> + [first]<br> + [prev]<br> + [next]<br> + [last]<br> + [frameno #]<br> + [#]<br> + [match <coordsys>]<br> + [lock + <coordsys>|none]<br> + <br> + Example: <br> + $ds9 -frame center # center current frame<br> + $ds9 -frame center 1 # center 'Frame1' <br> + $ds9 -frame center all # center all frames <br> + $ds9 -frame clear # clear current frame<br> + $ds9 -frame new # create new frame <br> + $ds9 -frame new rgb # create new rgb frame<br> + $ds9 -frame delete # delete current frame <br> + $ds9 -frame reset # reset current frame <br> + $ds9 -frame refresh # refresh current frame <br> + $ds9 -frame hide # hide current frame <br> + $ds9 -frame show 1 # show frame 'Frame1'<br> + $ds9 -frame move first # move frame to first in order<br> + $ds9 -frame move back # move frame back in order<br> + $ds9 -frame move forward # move frame forward in order<br> + $ds9 -frame move last # move frame to last in order<br> + $ds9 -frame first # goto first frame <br> + $ds9 -frame prev # goto prev frame <br> + $ds9 -frame next # goto next frame<br> + $ds9 -frame last # goto last frame<br> + $ds9 -frame frameno 4 # goto frame 'Frame4', create if needed<br> + $ds9 -frame 3 # goto frame 'Frame3', create if needed<br> + $ds9 -frame lock wcs</tt><br> + <p><b> <a name="gif"></a>gif</b></p> + <p>Import gif file. </p> + <tt> Syntax: <br> + -gif <filename><br> + <br> + Example: <br> + $ds9 -gif foo.gif<br> + $cat foo.gif | ds9 -gif -<br> + </tt> + <p><b> <a name="geometry"></a>geometry</b></p> + <p>Define the initial window geometry. This includes all of the + ds9 window, not just the image space. see X(1). </p> + <tt> Syntax: <br> + -geometry value <br> + <br> + Example: <br> + $ds9 -geometry 640x480 </tt> + <p><b> <a name="green"></a>green</b></p> + <p>For RGB frames, sets the current color channel to green.</p> + <tt> Syntax: <br> + -green<br> + <br> + Example: <br> + $ds9 -green foo.fits </tt> + <p><b> <a name="grid"></a>grid</b></p> + <p>Controls coordinate grid. For grid numeric format syntax, + click <a href="grid.html#Format">here</a>.</p> + <tt> Syntax: <br> + -grid []<br> + [yes|no] <br> + [type analysis|publication] <br> + [system <coordsys>]<br> + [sky <skyframe>] <br> + [skyformat <skyformat>]<br> + [grid yes|no]<br> + [grid color <color>]<br> + [grid width <value>]<br> + [grid style 0|1]<br> + [grid gap1 <value>]<br> + [grid gap2 <value>]<br> + [axes yes|no]<br> + [axes color <color>]<br> + [axes width <value>]<br> + [axes style 0|1]<br> + [axes type interior|exterior]<br> + </tt><tt> [axes origin + lll|llu|lul|luu|ull|ulu|uul|uuu]</tt><br> + <tt> [format1 <format>]<br> + [format2 <format>]<br> + [tickmarks yes|no]<br> + [tickmarks color <color>]<br> + [tickmarks width <value>]<br> + [tickmarks style 0|1]<br> + [border yes|no]<br> + [border color <color>]<br> + [border width <value>]<br> + [border style 0|1]<br> + [numerics yes|no]<br> + [numerics font + times|helvetica|courier]<br> + [numerics fontsize <value>]<br> + [numerics fontweight normal|bold]<br> + [numerics fontslant roman|italic]<br> + [numerics color <color>]<br> + [numerics gap1 <value>]<br> + [numerics gap2 <value>]<br> + [numerics type interior|exterior]<br> + [numerics vertical yes|no]<br> + [title yes|no]<br> + [title text <text>]<br> + [title def yes|no]<br> + [title gap <value>]<br> + [title font + times|helvetica|courier]<br> + [title fontsize <value>]<br> + [title fontweight normal|bold]<br> + [title fontslant roman|italic]<br> + [title color <color>]<br> + [labels yes|no]<br> + [labels text1 <text>]<br> + [labels def1 yes|no]<br> + [labels gap1 <value>]<br> + [labels text2 <text>]<br> + [labels def2 yes|no]<br> + [labels gap2 <value>]<br> + [labels font + times|helvetica|courier]<br> + [labels fontsize <value>]<br> + [labels fontweight normal|bold]<br> + [labels fontslant roman|italic]<br> + [labels color <color>]<br> + [reset]<br> + [load <filename>] <br> + [save <filename>] <br> + [open|close]<br> + <br> + Example: <br> + $ds9 -grid <br> + $ds9 -grid yes<br> + $ds9 -grid type analysis <br> + $ds9 -grid system wcs <br> + $ds9 -grid sky fk5 <br> + $ds9 -grid skyformat degrees<br> + $ds9 -grid grid yes<br> + $ds9 -grid grid color red<br> + $ds9 -grid grid width 2<br> + $ds9 -grid grid style 1<br> + $ds9 -grid grid gap1 10<br> + $ds9 -grid grid gap2 10<br> + $ds9 -grid axes yes<br> + $ds9 -grid axes color red<br> + $ds9 -grid axes width 2<br> + $ds9 -grid axes style 1<br> + $ds9 -grid axes type exterior<br> + $ds9 -grid axes origin lll<br> + $ds9 -grid format1 d.2<br> + $ds9 -grid format2 d.2<br> + $ds9 -grid tickmarks yes<br> + $ds9 -grid tickmarks color red<br> + $ds9 -grid tickmarks width 2<br> + $ds9 -grid tickmarks style 1<br> + $ds9 -grid border yes<br> + $ds9 -grid border color red<br> + $ds9 -grid border width 2<br> + $ds9 -grid border style 1<br> + $ds9 -grid numerics yes<br> + $ds9 -grid numerics font courier<br> + $ds9 -grid numerics fontsize 12<br> + $ds9 -grid numerics fontweight bold<br> + $ds9 -grid numerics fontslant italic<br> + $ds9 -grid numerics color red<br> + $ds9 -grid numerics gap1 10<br> + $ds9 -grid numerics gap2 10<br> + $ds9 -grid numerics type exterior<br> + $ds9 -grid numerics vertical yes<br> + $ds9 -grid title yes<br> + $ds9 -grid title text {Hello World}<br> + $ds9 -grid title def yes<br> + $ds9 -grid title gap 10<br> + $ds9 -grid title font courier<br> + $ds9 -grid title fontsize 12<br> + $ds9 -grid title fontweight bold<br> + $ds9 -grid title fontslant italic<br> + $ds9 -grid title color red<br> + $ds9 -grid labels yes<br> + $ds9 -grid labels text1 {Hello World}<br> + $ds9 -grid labels def1 yes<br> + $ds9 -grid labels gap1 10<br> + $ds9 -grid labels text2 {Hello World}<br> + $ds9 -grid labels def2 yes<br> + $ds9 -grid labels gap2 10<br> + $ds9 -grid labels font courier<br> + $ds9 -grid labels fontsize 12<br> + $ds9 -grid labels fontweight bold<br> + $ds9 -grid labels fontslant italic<br> + $ds9 -grid labels color red<br> + $ds9 -grid reset<br> + $ds9 -grid load foo.grd <br> + $ds9 -grid save foo.grd <br> + $ds9 -grid open<br> + $ds9 -grid close<br> + </tt> + <p><b> <a name="header"></a>header</b></p> + <p>Display current fits header dialog. Optional extension number + maybe specified.</p> + <tt> Syntax: <br> + -header [<ext>]<br> + [close [<ext>]]<br> + [save [<ext>] + <filename>]<br> + <br> + Example:<br> + $ds9 -header <br> + $ds9 -header 2<br> + $ds9 -header close<br> + $ds9 -header save 1 foo.txt<br> + </tt> + <p><b> <a name="height"></a>height</b></p> + <p>Set the height of the image display window. Use the <a + href="command.html#geometry">geometry</a> command to set the + overall width and height of the ds9 window.</p> + <tt> Syntax: <br> + -height [<value>]<br> + <br> + Example: <br> + $ds9 -height 512<br> + </tt> + <p><b> <a name="help"></a>help</b></p> + <p>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.</p> + <tt> Syntax: <br> + -help # Display brief help message and exit.<br> + --help # Display command line options within help facility.<br> + -? # Display command line options within help facility.<br> + <br> + Example: <br> + $ds9 -help # Display brief help message and exit.<br> + $ds9 --help # Display command line options within help facility<br> + $ds9 -? # Display command line options within help facility.<br> + </tt> + <p><b> <a name="histequ"></a>histequ</b></p> + <p>Select histogram equalization scale function for the current + frame. </p> + <tt> Syntax: <br> + -histequ<br> + <br> + Example: <br> + $ds9 -histequ<br> + </tt> + <p><b> <a name="iconify"></a>iconify</b></p> + <p>Toggles iconification. </p> + <tt> Syntax: <br> + -iconify []<br> + [yes|no] <br> + <br> + Example: <br> + $ds9 -iconify<br> + $ds9 -iconify yes</tt><br> + <p><b> <a name="invert"></a>invert</b></p> + <p>Invert Colormap. </p> + <tt> Syntax: <br> + -invert <br> + <br> + Example: <br> + $ds9 -invert<br> + </tt> + <p><b><a name="iis"></a>iis</b></p> + <p>Set IIS Filename. Optional mosaic number maybe supplied.</p> + <tt> Syntax: <br> + -iis [filename <filename> [#]]<br> + <br> + Example: <br> + $ds9 -iis filename foo.fits<br> + $ds9 -iis filename bar.fits 4</tt><br> + <p><b> <a name="jpeg"></a>jpeg</b></p> + <p>Load JPEG image into current frame.</p> + <tt> Syntax:<br> + -jpeg <filename><br> + <br> + Example: <br> + </tt><tt>$ds9 -jpeg foo.jpeg</tt><br> + <tt>$cat foo.jpeg | ds9 -jpeg -</tt><br> + <p><b> <a name="language"></a>language</b></p> + <p>Select current language. </p> + <tt> Syntax: <br> + -language [locale|da|de|es|en|fr|ja|pt]<br> + <br> + Example: <br> + $ds9 -language fr<br> + </tt> + <p><b> <a name="linear"></a>linear</b></p> + <p>Select linear scale function for the current frame. </p> + <tt> Syntax: <br> + -linear <br> + <br> + Example: <br> + $ds9 -linear </tt> + <p><b> <a name="lock"></a>lock</b></p> + <p>Lock all other frames to the current frame. </p> + <tt> Syntax: <br> + </tt><tt>-lock</tt><tt> </tt><tt>[frame <coordsys>|none]<br> + </tt><tt>[crosshair + <coordsys>|none] </tt><tt><br> + </tt><tt> [crop <coordsys>|none]</tt><br> + <tt> [slice <coordsys>|none]</tt><br> + <tt> </tt><tt> [bin [yes|no]]<br> + [axes [yes|no]]<br> + [scale [yes|no]]<br> + [scalelimits [yes|no]]<br> + [colorbar [yes|no]]<br> + [block [yes|no]]<br> + [smooth [yes|no]]</tt><br> + <tt><br> + </tt><tt> </tt><tt>Example: </tt><tt><br> + $ds9 -lock frame wcs</tt><tt><br> + </tt><tt>$ds9 -lock crosshair wcs</tt><tt><br> + </tt><tt>$ds9 -lock crop wcs</tt><br> + <tt>$ds9 -lock slice wcs</tt><br> + <tt>$ds9 -lock bin yes<br> + $ds9 -lock axes yes<br> + </tt><tt>$ds9 -lock scale yes<br> + $ds9 -lock scalelimits yes<br> + </tt><tt>$ds9 -lock colorbar yes</tt><tt><br> + $ds9 -lock block yes<br> + $ds9 -lock smooth yes<br> + </tt> + <p><b> <a name="log"></a>log</b></p> + <p>Select log scale function for the current frame. <br> + </p> + <tt> Syntax: <br> + -log <br> + <br> + Example: <br> + $ds9 -log </tt> + <p><b> <a name="lower"></a>lower</b></p> + <p>Lower in the window stacking order. </p> + <tt> Syntax: <br> + -lower <br> + <br> + Example: <br> + $ds9 -lower<br> + </tt> + <p><b> <a name="magnifier"></a>magnifier</b></p> + <p>Controls the magnifier settings. </p> + <tt> Syntax: <br> + magnifier [color <color>]<br> + [zoom + <value>]<br> + [cursor + yes|no]<br> + [region + yes|no]<br> + <br> + Example: <br> + $ds9 -magnifier color yellow<br> + $ds9 -magnifier zoom 2<br> + $ds9 -magnifier cursor no<br> + $ds9 -magnifier region no<br> + </tt> + <p><b> <a name="mask"></a>mask<br> + nomask<br> + </b></p> + <p>Controls mask parameters. </p> + <tt> Syntax: <br> + -mask [color <color>]<br> + [mark 1|0]<br> + [transparency <value>]<br> + [clear]<br> + [open|close]<br> + -nomask<br> + <br> + Example: <br> + $ds9 -mask color red<br> + $ds9 -mask mark 0<br> + $ds9 -mask transparency 50<br> + $ds9 -mask clear<br> + $ds9 -mask open<br> + $ds9 -mask close<br> + $ds9 -nomask<br> + </tt> + <p><b> <a name="match"></a>match</b></p> + <p>Match all other frames to the current frame. </p> + <tt> Syntax: <br> + </tt><tt>-match </tt><tt>[frame <coordsys>]<br> + </tt><tt>[crosshair + <coordsys>] </tt><tt><br> + </tt><tt> [crop + <coordsys>]</tt><br> + <tt> [slice <coordsys>]</tt><br> + <tt> </tt><tt> [bin]<br> + [axes]<br> + [scale]<br> + [scalelimits]<br> + [colorbar]<br> + [block]<br> + [smooth]<br> + </tt><tt> <br> + Example: <br> + </tt><tt>$ds9 -match frame wcs <br> + </tt><tt>$ds9 -match crosshair wcs<br> + </tt><tt>$ds9 -match crop wcs</tt><br> + <tt> $ds9 -match slice wcs</tt> <br> + <tt>$ds9 -match bin<br> + $ds9 -match axes<br> + $ds9 -match scale<br> + $ds9 -match scalelimits<br> + $ds9 -match colorbar<br> + $ds9 -match block<br> + $ds9 -match smooth<br> + <br> + </tt><b><a name="mecube"></a>mecube</b> + <p>Load FITS multiple extension file as data cube.<br> + </p> + <tt> Syntax:<br> + mecube <filename><br> + <br> + Example: <br> + $ds9 -mecube foo.fits</tt><tt><tt><br> + </tt>$cat foo.fits | ds9 -mecube -</tt><br> + <p><b> <a name="minmax"></a>minmax</b></p> + <p>This is how DS9 determines the min and max data values + from the data. <tt>SCAN</tt> will scan all data.</p> + <tt> Syntax: <br> + -minmax [scan|sample|datamin|irafmin] <br> + [mode + scan|sample|datamin|irafmin]<br> + [interval #]<br> + <br> + Example: <br> + $ds9 -minmax scan <br> + $ds9 -minmax mode scan<br> + $ds9 -minmax interval 100<br> + </tt> + <p><b> <a name="mode"></a>mode</b></p> + <p>Select the current mode. </p> + <tt> Syntax: <br> + -mode + [none|region|crosshair|colorbar|pan|zoom|rotate|catalog|examine] + <br> + <br> + Example: <br> + $ds9 -mode crosshair</tt><br> + <p><b> <a name="mosaic"></a>mosaic</b></p> + <p>Load FITS mosaic segment into current frame.</p> + <tt> Syntax:<br> + -mosaic [wcs|wcsa...wcsz|iraf] <filename><br> + <br> + Example: </tt><tt><br> + $ds9 -mosaic foo.fits</tt><br> + <tt><tt>$ds9 -mosaic wcs foo.fits</tt></tt><tt><tt><tt><br> + </tt></tt>$cat foo.fits | ds9 -mosaic -</tt> <br> + <tt><tt>$cat foo.fits | ds9 -mosaic wcs -</tt></tt><tt><br> + </tt> + <p><b> <a name="mosaicimage"></a>mosaicimage</b></p> + <p>Load FITS mosaic image into current frame.</p> + <tt> Syntax:<br> + -mosaicimage [wcs|wcsa...wcsz|iraf|wfpc2] <filename><br> + <br> + Example: </tt><tt><br> + $ds9 -mosaicimage foo.fits</tt><br> + <tt><tt>$ds9 -mosaicimage wcs foo.fits</tt></tt><tt><tt><tt><br> + </tt></tt>$cat foo.fits | ds9 -mosaicimage</tt><br> + <tt><tt>$cat foo.fits | ds9 -mosaiimage wcs</tt></tt><tt><br> + </tt> + <p><b><a name="movie"></a>movie<br> + savempeg<br> + </b></p> + <p>Create mpeg1 movie from snap shots of the DS9 window. A <tt>slice</tt> + movie cycles though all slices of a cube. A <tt>frame</tt> + movie cycles through all active frames. A <tt>3d</tt> movie + cycles through specified viewing angles. The default is <tt>frame</tt>. + Optional parameters for <tt>3d</tt>: number of frames, azimuth + from/to, elevation from/to, slice from/to, oscillate/repeat + times.<br> + </p> + <tt> Syntax:<br> + -movie [slice|frame|3d] <filename><br> + -movie 3d <filename> + [number|azfrom|azto|elfrom|elto|slfrom|slto|oscillate|repeat + <#>]<br> + <br> + Example:<br> + $ds9 -movie slice ds9.mpg<br> + $ds9 -movie 3d ds9.mpg number 10 azfrom -60 azto 60 oscillate 1</tt><br> + <p><b> <a name="msg"></a>msg</b></p> + <p>Specify a directory of translation tables to be loaded.</p> + <tt> Syntax: <br> + -msg <directory><br> + <br> + Example: <br> + $ds9 -msg $HOME/msgs</tt><br> + <p><b> <a name="multiframe"></a>multiframe</b></p> + <p>Load FITS multiple extension file as multiple images.<br> + </p> + <tt> Syntax:<br> + multiframe <filename><br> + <br> + Example: <br> + $ds9 -multiframe foo.fits</tt><tt><tt><br> + </tt>$cat foo.fits | ds9 -multiframe -</tt><tt><br> + </tt> + <p><b><a name="nameserver"></a>nameserver</b></p> + <p>Support Name Server functions. Coordinates are in fk5. </p> + <tt> Syntax: <br> + -nameserver [<object>]<br> + [name <object>]<br> + [server + ned-sao|ned-eso|simbad-sao|simbad-eso] <br> + [skyformat + degrees|sexagesimal]<br> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [pan]<br> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [crosshair]<br> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [open|close]<br> + <br> + Example: <br> + $ds9 -nameserver m31<br> + $ds9 -nameserver name m31 <br> + $ds9 -nameserver server ned-sao <br> + $ds9 -nameserver skyformat sexagesimal<br> + $ds9 -nameserver pan<br> + $ds9 -nameserver crosshair<br> + $ds9 -nameserver open<br> + $ds9 -nameserver close<br> + </tt> + <p><b> <a name="nan"></a>nan</b></p> + <p>Set image not-a-number color. </p> + <tt> Syntax: <br> + -nan <color><br> + <br> + Example:<br> + $ds9 -nan red</tt><br> + <p><b> <a name="nrrd"></a>nrrd</b></p> + <p>Load an NRRD (Nearly Raw Raster Data) file.<br> + </p> + <tt> Syntax: <br> + -nrrd <filename><br> + <br> + Example:<br> + </tt><tt><tt>$ds9 -nrrd foo.nrrd</tt></tt><br> + <tt>$cat foo.nrrd | xpaset ds9 -nrrd</tt> - <tt><br> + </tt> + <p><b> <a name="nvss"></a>nvss</b></p> + <p>Support for NRAO VLA Sky Survey.</p> + <tt> Syntax: <br> + -nvss []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> <dec> + degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [open|close]<br> + <br> + Example:<br> + $ds9 -nvss<br> + $ds9 -nvss m31 <br> + $ds9 -nvss name m31 <br> + $ds9 -nvss coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + $ds9 -nvss size 60 60 arcmin<br> + $ds9 -nvss save yes<br> + $ds9 -nvss frame current<br> + $ds9 -nvss update frame<br> + $ds9 -nvss open<br> + $ds9 -nvess close<br> + </tt> + <p><b><a name="orient"></a>orient</b></p> + <p>Controls the orientation of the current frame. </p> + <tt> Syntax: <br> + -orient [none|x|y|xy] <br> + [open|close]<br> + <br> + Example: <br> + $ds9 -orient xy<br> + $ds9 -orient open<br> + $ds9 -orient close<br> + </tt> + <p><b> <a name="pagesetup"></a>pagesetup</b></p> + <p>Controls Page Setup options.<br> + </p> + <tt> Syntax: <br> + -pagesetup [orient portrait|landscape] <br> + + [scale <numberic>]</tt><br> + <tt> + [size letter|legal|tabloid|poster|a4]</tt><br> + <tt> <br> + Example: <br> + $ds9 -pagesetup orient portrait <br> + $ds9 -pagesetup scale 50<br> + $ds9 -pagesetup size poster</tt><br> + <p><b> <a name="pan"></a>pan</b></p> + <p>Controls the current image cursor location for the current + frame. </p> + <tt> Syntax: <br> + -pan [<x> <h> <coordsys> + [<skyframe>][<skyformat>] # relative<br> + [to <x> <h> + <coordsys> [<skyframe>][<skyformat>] # + absolute<br> + [open|close]<br> + <br> + Example: <br> + $ds9 -pan 200 200 image</tt><tt><tt> # pan relative </tt> <br> + $ds9 -pan to 400 400 physical</tt><tt><tt> # pan to physical + coords</tt> <br> + $ds9 -pan to 13:29:55 47:11:50 wcs fk</tt><tt><tt> # pan to wcs + coords</tt><br> + $ds9 -pan open<br> + $ds9 -pan close</tt><br> + <p><b><a name="pixeltable"></a>pixeltable</b></p> + <p>Display/Hide the pixel table. </p> + <tt> Syntax: <br> + -pixeltable []<br> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [yes|open]<br> + + [no|close]<br> + <br> + Example: <br> + $ds9 -pixeltable<br> + $ds9 -pixeltable yes<br> + $ds9 -pixeltable open<br> + $ds9 -pixeltable close<br> + </tt> + <p><b> <a name="plot"></a>plot</b></p> + <br> + <p>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:</p> + <blockquote>xy x and y coordinates<br> + xyex x,y coordinates with x errors<br> + xyey x,y coordinates with y errors<br> + xyexey x,y coordinates with x and y + errors<br> + </blockquote> + <p>To create a new plot, use the plot new command.</p> + <tt> Syntax: <br> + # create new empty plot window<br> + -plot<br> + -plot [bar|scatter]<br> + [new [name <plotname>] + [line|bar|scatter]]<br> + [new [name <plotname>] + [line|bar|scatter] <title> <xaxis label> <yaxis + label> </tt><tt>xy|xyex|xyey|xyexey</tt><tt>]<br> + <br> + </tt><tt><tt>-plot [<plotname>] load <filename> + [xy|xyex|xyey|xyexey]<br> + [<plotname>] save + <filename><br> + </tt> [<plotname>] clear<br> + </tt><tt><tt><tt><tt><tt><tt> </tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + duplicate<br> + </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </tt>[<plotname>] stats<br> + </tt></tt> </tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + list<br> + </tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + loadconfig <filename><br> + [<plotname>] saveconfig + <filename><br> + </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt> + [<plotname>] pagesetup orient + [portrait|landscape]<br> + [<plotname>] pagesetup size + [letter|legal|tabloid|poster|a4]</tt><br> + <tt> </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [<plotname>] print<br> + [<plotname>] print + destination [printer|file] <br> + [<plotname>] print + command <command><br> + [<plotname>] print + filename <filename><br> + [<plotname>] print color + [rgb|gray]<br> + </tt> </tt>[<plotname>] close<br> + <br> + </tt></tt></tt><tt><tt><tt><tt><tt><tt><tt> -plot </tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + mode [pointer|zoom]<br> + <br> + </tt></tt></tt></tt></tt></tt><tt># configure graph<br> + -plot [<plotname>] axis [x|y] grid [yes|no]<br> + [<plotname>] axis [x|y] log + [yes|no]<br> + </tt><tt> [<plotname>] axis [x|y] + flip [yes|no]</tt><br> + <tt><tt> [<plotname>] axis [x|y] auto + [yes|no]<br> + [<plotname>] axis [x|y] min + <value><br> + </tt><tt><tt> [<plotname>] axis [x|y] + max <value></tt><tt><br> + </tt> [<plotname>] axis [x|y] format + <string></tt><tt><br> + </tt> </tt><tt><tt>[<plotname>] + legend [yes|no]<br> + [<plotname>] legend position + [right|left|top|bottom]</tt><br> + </tt><tt><tt> [<plotname>] font + [title|labels|numbers] font [times|helvetica|courier]<br> + [<plotname>] font </tt></tt><tt><tt><tt><tt>[title|labels|numbers]</tt></tt> + size <value><br> + [<plotname>] font </tt></tt><tt><tt><tt><tt>[title|labels|numbers]</tt></tt> + weight [normal|bold]<br> + [<plotname>] font </tt></tt><tt><tt><tt><tt>[title|labels|numbers]</tt></tt> + slant [roman|italic]<br> + </tt></tt><tt> [<plotname>] title + <string></tt><br> + <tt><tt> [<plotname>] title [x|y] + <string></tt></tt><tt><tt><tt><br> + [<plotname>] barmode + [normal|stacked|aligned|overlap]<br> + <br> + # configure current dataset<br> + </tt>-plot [<plotname>] show [yes|no]<br> + </tt> </tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + shape + [circle|square|diamond|plus|splus|scross|triangle|arrow]</tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt> <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + shape fill [yes|no]</tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt> <tt> + </tt></tt><tt><tt><tt><tt>[<plotname>] + shape color <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + smooth + [step|linear|cubic|quadratic|catrom]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> + </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + color + <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + width + <value><br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + dash [yes|no]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> + </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error [yes|no]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error color + <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> + </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error width + <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + name + <string></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><br> + # select current dataset<br> + </tt></tt></tt>-plot [<plotname>] select <value><br> + <br> + Example: <br> + </tt><tt><tt> </tt></tt><tt># create new empty plot window<br> + $ds9 -plot<br> + $ds9 -plot scatter<br> + $ds9 -plot new<br> + $ds9 -plot new bar<br> + $ds9 -plot new name foo<br> + $ds9 -plot new name foo scatter<br> + </tt><tt><tt><br> + $ds9 -plot load foo.dat xy # load new dataset with dimension + xy<br> + $ds9 -plot save bar.dat # save current dataset<br> + </tt></tt><tt><tt>$ds9 -plot clear # clear all datasets<br> + $ds9 -plot duplicate # duplicate current dataset<br> + $ds9 -plot stats # display current dataset statistics<br> + $ds9 -plot list # list current dataset<br> + </tt></tt><tt><tt>$ds9 -plot loadconfig foo.plt # load plot + configuration <br> + $ds9 -plot saveconfig bar.plt # save current plot + configuration<br> + </tt></tt><tt><tt>$ds9 -plot pagesetup orient portrait<br> + $ds9 -plot pagesetup size letter<br> + </tt></tt><tt><tt>$ds9 -plot print<br> + $ds9 -plot print destination file<br> + $ds9 -plot print command "lp"<br> + $ds9 -plot print filename "foo.ps"<br> + $ds9 -plot print color rgb<br> + </tt>$ds9 -plot close # close current plot<br> + </tt><tt><tt><br> + $ds9 -plot mode pointer</tt><br> + </tt><tt><br> + # configure plot<br> + </tt><tt>$ds9 -plot axis x grid yes<br> + $ds9 -plot axis x log yes</tt><br> + <tt>$ds9 -plot axis x flip yes</tt><tt><br> + </tt><tt><tt>$ds9 -plot axis x auto no<br> + $ds9 -plot axis x min 0<br> + $ds9 -plot axis x max 100<br> + </tt><tt><tt>$ds9 -plot axis x format {%f}<br> + </tt></tt>$ds9 -plot legend yes # show legend<br> + </tt><tt>$ds9 -plot legend position left</tt><tt><tt><tt><tt><br> + </tt></tt>$ds9 -plot font numbers font times<br> + $ds9 -plot font numbers size 12<br> + $ds9 -plot font numbers weight bold<br> + $ds9 -plot font numbers slant italic<br> + </tt></tt><tt>$ds9 -plot title {The Title}<br> + $ds9 -plot title x {X Axis}<br> + $ds9 -plot barmode aligned<br> + <br> + # configure current dataset<br> + </tt><tt>$ds9 -plot show yes<br> + $ds9 -plot shape circle<br> + </tt><tt><tt>$ds9 -plot shape fill no<br> + </tt></tt><tt><tt><tt>$ds9 -plot shape color cyan<br> + </tt></tt></tt><tt><tt>$ds9 -plot smooth step<br> + </tt>$ds9 -plot color red<br> + $ds9 -plot width 2<br> + $ds9 -plot dash yes<br> + $ds9 -plot error yes<br> + $ds9 -plot error color red</tt><br> + <tt>$ds9 -plot error width 2</tt><br> + <tt>$ds9 -plot name {My Data}</tt><br> + <tt><br> + # select current dataset<br> + $ds9 -plot select 2</tt> + <p><b><b><a name="png"></a></b>png</b></p> + <p>Load PNG image into current frame.<br> + </p> + <tt> Syntax:<br> + -png <filename><br> + <br> + Example: </tt><br> + <tt>$ds9 png foo.png</tt><tt><tt><tt><br> + </tt></tt>$cat foo.png | ds9 -png -</tt><tt><br> + </tt> + <p><b> <a name="port"></a>port</b></p> + <p>Set the IRAF port number, used by IRAF to communicate with DS9. + The default is 5137, the standard IRAF port used by <i>ximtool</i>. + </p> + <tt> Syntax: <br> + -port number <br> + <br> + Example: <br> + $ds9 -port 5137 </tt> + <p><b> <a name="port_only"></a>port_only<br> + inet_only</b></p> + <p>Only use the IRAF port number. This is the same as -fifo none + -unix none. </p> + <tt> Syntax: <br> + -port_only <br> + <br> + Example: <br> + $ds9 -port_only<br> + </tt> + <p><b> <a name="pow"></a>pow</b></p> + <p>Select power scale function for the current frame. </p> + <tt> Syntax: <br> + -pow <br> + <br> + Example: <br> + $ds9 -pow </tt> + <p><b> <a name="prefs"></a>prefs</b></p> + <p>Controls various preference settings. </p> + <tt> Syntax: <br> + -prefs [clear]<br> + [irafalign yes|no]<br> + <br> + Example: <br> + $ds9 -prefs clear<br> + $ds9 -prefs irafalign yes<br> + </tt> + <p><b><a name="preserve"></a>preserve</b> </p> + <p>Preserve the follow attributes while loading a new image. </p> + <tt> Syntax: <br> + preserve [pan yes|no]<br> + [regions yes|no]<br> + <br> + Example: <br> + $ds9 -preserve pan yes<br> + $ds9 -preserve regions yes<br> + </tt> + <p><b><a name="psprint"></a>psprint</b></p> + <p>Invokes postscript printing. Please see <a + href="file:///Users/joye/saods9/ds9/doc/ref/command.html#print">print</a> + for further details.</p> + <p><b><a name="print"></a>print</b></p> + <p>Controls printing. Use print option to set printing options.<br> + </p> + <tt> Syntax: <br> + -print [destination printer|file] <br> + [command <command>] <br> + [filename <filename>] + <br> + </tt><tt> [color + rgb|cmyk|gray] <br> + [level 1|2] <br> + [resolution + 53|72|75|150|300|600] <br> + <br> + Example: <br> + $ds9 -print <br> + $ds9 -print destination file <br> + $ds9 -print command 'gv -' <br> + $ds9 -print filename foo.ps <br> + $ds9 -print color cmyk <br> + $ds9 -print level 2 <br> + $ds9 -print resolution 75 </tt> + <p><b> <a name="private"></a>private</b></p> + <p>use private colormap, valid for pseudocolor 8 mode. </p> + <tt> Syntax: <br> + -private <br> + <br> + Example: <br> + $ds9 -private </tt> + <p><b> <a name="raise"></a>raise</b></p> + <p>Raise in the window stacking order. </p> + <tt> Syntax: <br> + -raise <br> + <br> + Example: <br> + $ds9 -raise<br> + </tt> + <p><b> <a name="regions"></a>regions</b></p> + <p>Controls regions in the current frame. </p> + <tt> Syntax: <br> + -regions [<filename>]<br> + [load [all] + <filename>] <br> + [save + <filename>]<br> + [list [close]]<br> + [epsilon + <integer>]<br> + [show yes|no]<br> + [showtext yes|no]<br> + [centroid]<br> + [centroid auto + yes|no]<br> + [centroid + radius <value>|iteration <value>]<br> + [getinfo]<br> + [move front] <br> + [move back]<br> + [select all]<br> + [select none]<br> + [select invert]<br> + [delete all]<br> + [delete select]<br> + [format + ds9|xml|ciao|saotng|saoimage|pros|xy]<br> + [system + image|physical|wcs|wcsa...wcsz]<br> + [sky + fk4|fk5|icrs|galactic|ecliptic] <br> + [skyformat + degrees|sexagesimal]<br> + [strip yes|no]<br> + [shape + <shape>]<br> + [color + <color><br> + [width + <width>]<br> + </tt><tt> + [fixed|edit|rotate|delete yes|no]<br> + + [include|exclude|source|background]</tt><br> + <tt> </tt><tt> [delim + [nl|<char>]]<br> + [command + <marker command>]<br> + [composite]<br> + [dissolve]<br> + [template + <filename>]<br> + [template + <filename> at <ra> <dec> <coordsys> + <skyframe>]<br> + [savetemplate + <filename>]<br> + </tt><tt> [group new]<br> + </tt><tt> [group + <tag> new]<br> + [group + <tag> update]<br> + </tt><tt> [group + <tag> select]<br> + </tt><tt> [group + <tag> color <color>] <br> + [group <tag> + copy] <br> + [group <tag> + delete] <br> + [group <tag> + cut]<br> + [group <tag> + font <font>] <br> + [group <tag> + move <int> <int>]<br> + [group <tag> + movefront] <br> + [group <tag> + moveback] <br> + [group <tag> + property <property> yes|no] <br> + [copy]<br> + [cut]<br> + [paste + image|physical|wcs|wcsa...wcsz]<br> + [undo]<br> + <br> + Example: <br> + $ds9 -regions foo.reg <br> + $ds9 -regions -format ciao bar.reg # load as ciao format<br> + $ds9 -regions foo.fits # FITS regions files do not need a format + specification<br> + $ds9 -regions load foo.reg # load foo.reg into current frame<br> + $ds9 -regions load all foo.reg # load foo.reg into all frames<br> + $ds9 -regions load '*.reg'# expand *.reg and load into current + frame<br> + $ds9 -regions load all '*.reg' # expand *.reg and load into all + frames<br> + $ds9 -regions save foo.reg<br> + $ds9 -regions list <br> + $ds9 -regions list close<br> + $ds9 -regions epsilon 5<br> + $ds9 -regions show yes<br> + $ds9 -regions showtext no<br> + $ds9 -regions centroid<br> + $ds9 -regions centroid auto yes<br> + $ds9 -regions centroid radius 10<br> + $ds9 -regions centroid iteration 20<br> + $ds9 -regions getinfo<br> + $ds9 -regions move back<br> + $ds9 -regions move front<br> + $ds9 -regions select all <br> + $ds9 -regions select none<br> + $ds9 -regions select invert<br> + $ds9 -regions delete all<br> + $ds9 -regions delete select<br> + $ds9 -regions format ds9 <br> + $ds9 -regions system wcs<br> + $ds9 -regions sky fk5 <br> + $ds9 -regions skyformat degrees <br> + $ds9 -regions delim nl <br> + $ds9 -regions strip yes<br> + $ds9 -regions shape ellipse <br> + $ds9 -regions color red <br> + $ds9 -regions width 3<br> + </tt><tt>$ds9 -regions edit yes<br> + $ds9 -regions include<br> + </tt><tt>$ds9 -regions command "circle 100 100 20 # color=red"<br> + $ds9 -regions composite<br> + $ds9 -regions dissolve<br> + $ds9 -regions template foo.tpl<br> + $ds9 -regions template foo.tpl at 13:29:55.92 +47:12:48.02 fk5<br> + $ds9 -regions savetemplate foo.tpl<br> + $ds9 -regions group new<br> + $ds9 -regions group foo new<br> + $ds9 -regions group foo update<br> + $ds9 -regions group foo select<br> + $ds9 -regions group foo color red<br> + $ds9 -regions group foo copy<br> + $ds9 -regions group foo delete<br> + $ds9 -regions group foo cut<br> + $ds9 -regions group foo font {times 14 bold}<br> + $ds9 -regions group foo move 100 100<br> + $ds9 -regions group foo movefront<br> + $ds9 -regions group foo moveback<br> + $ds9 -regions group foo property delete no<br> + $ds9 -regions copy<br> + $ds9 -regions cut<br> + $ds9 -regions paste wcs<br> + $ds9 -regions undo<br> + </tt> + <p><b><a name="red"></a>red</b></p> + <p>For RGB frames, sets the current color channel to red.</p> + <tt> Syntax:<br> + -red<br> + <br> + Example: <br> + $ds9 -red foo.fits<br> + </tt> + <p><b> <a name="restore"></a>restore</b></p> + <p>Restore DS9 to a previous state from a backup save set. </p> + <tt> Syntax: <br> + -restore <filename><br> + <br> + Example:<br> + $ds9 -restore ds9.bck</tt><br> + <p><b> <a name="rgb"></a>rgb</b></p> + <p>Create RGB frame and control RGB frame parameters.</p> + <tt> Syntax: <br> + -rgb []<br> + [red|green|blue]<br> + [channel [red|green|blue]]<br> + [view [red|green|blue] [yes|no]]<br> + [system <coordsys>]<br> + [lock + wcs|crop|slice|bin|scale|scalelimits|colorbar|block|smooth + [yes|no]]<br> + [open|close]<br> + <br> + Example: <br> + $ds9 -rgb # create new rgb frame<br> + $ds9 -rgb red # set current channel to red<br> + $ds9 -rgb channel red # set current channel to red<br> + $ds9 -rgb view blue no # turn off blue channel<br> + $ds9 -rgb system wcs # set rgb coordinate system<br> + </tt><tt>$ds9 -rgb lock wcs yes</tt><br> + <tt>$ds9 -rgb lock crop yes</tt><br> + <tt>$ds9 -rgb lock slice yes</tt><br> + <tt>$ds9 -rgb lock bin yes</tt><br> + <tt> $ds9 -rgb lock scale yes<br> + $ds9 -rgb lock scalelimits yes<br> + $ds9 -rgb lock colorbar yes<br> + $ds9 -rgb lock block yes<br> + $ds9 -rgb lock smooth yes<br> + $ds9 -rgb open<br> + $ds9 -rgb close<br> + </tt><br> + <p><b> <a name="rgbarray"></a>rgbarray</b></p> + <p>Load raw data array cube into rgb frame.<br> + </p> + <tt> Syntax:<br> + -rgbarray +<filename>[[xdim=<x>,ydim=<y>|dim=<dim>],[zdim=3],bitpix=<b>,skip=<s>,endian=[little|big]]<br> + <br> + Example: <br> + $ds9 -rgbarray foo.arr[dim=512,zdim=3,bitpix=-32,endian=little]</tt><br> + <tt>$cat foo.arr | ds9 -rgbarray + -[dim=512,zdim=3,bitpix=-32,endian=little]</tt><br> + <p><b> <a name="rgbcube"></a>rgbcube</b></p> + <p>Load FITS rgbcube into rgb frame.<br> + </p> + <tt> Syntax:<br> + -rgbcube <filename><br> + <br> + Example: <br> + $ds9 -rgbcube foo.fits</tt><tt><tt><br> + </tt>$cat foo.fits | ds9 -rgbcube -</tt><br> + <p><b> <a name="rgbimage"></a>rgbimage</b></p> + <p>Load FITS rgbimage into rgb frame.<br> + </p> + <tt> Syntax:<br> + -rgbimage <filename><br> + <br> + Example: <br> + $ds9 -rgbimage foo.fits</tt><tt><tt><br> + </tt>$cat foo.fits | ds9 -rgbimage -</tt> <br> + <p><b> <a name="rotate"></a>rotate</b></p> + <p>Controls the rotation angle (in degrees) of the current frame. + </p> + <tt> Syntax: <br> + -rotate [<value>] <br> + [to <value>] <br> + [open|close]<br> + <br> + Example: <br> + $ds9 -rotate 45 <br> + $ds9 -rotate to 30<br> + $ds9 -rotate open<br> + $ds9 -rotate close<br> + </tt> + <p><b><a name="samp"></a>samp</b></p> + <p>Configure SAMP protocol. </p> + <tt> Syntax: <br> + -samp [yes|no|connect|disconnect] <br> + [broadcast [image|table]]<br> + [send [image|table] + <application>]<br> + <br> + Example: <br> + $ds9 -samp yes<br> + </tt><tt><tt>$ds9 -samp connect<br> + </tt>$ds9 -samp broadcast image<br> + $ds9 -samp send image aladin</tt><br> + <p><b> <a name="save"></a>save<br> + </b></p> + <p>Save loaded image data of current frame as FITS.</p> + <tt> Syntax: <br> + -save </tt><tt>[fits|rgbimage|rgbcube|mecube|mosaic|mosaicimage] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <filename> [image|table|slice]</tt> <br> + <tt> <br> + Example: <br> + $ds9 -save foo.fits</tt><br> + <tt>$ds9 -save fits foo.fits image</tt><br> + <tt>$ds9 -save fits foo.fits table<br> + $ds9 -save fits foo.fits slice</tt><br> + <tt>$ds9 -save rgbimage foo.fits<br> + </tt><tt>$ds9 -save rgbcube foo.fits</tt><br> + <tt>$ds9 -save mecube foo.fits</tt><br> + <tt>$ds9 -save mosaic foo.fits</tt><br> + <tt>$ds9 -save mosaicimage foo.fits</tt><br> + <p><b> <a name="saveimage"></a>saveimage</b></p> + <p>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: <tt>jpeg</tt> quality (1-100) and <tt>tiff</tt> + compression method. </p> + <tt> Syntax: <br> + -saveimage </tt><tt>[fits|eps|gif|tiff|jpeg|png] </tt><tt><filename><br> + -saveimage <filename>.jpeg [1-100]<br> + -saveimage <filename>.tiff [none|jpeg|packbits|deflate]<br> + <br> + Example: <br> + $ds9 -saveimage ds9.tiff<br> + $ds9 -saveimage jpeg ds9.jpeg 75</tt><tt><br> + </tt> + <p><b> <a name="scale"></a>scale</b></p> + <p>Controls the limits and color scale distribution. </p> + <tt> Syntax: <br> + -scale [linear|log|pow|sqrt|squared|asinh|sinh|histequ]<br> + [log exp <value>] <br> + [datasec yes|no] <br> + [limits <minvalue> + <maxvalue>] <br> + [mode + minmax|<value>|zscale|zmax] <br> + [scope local|global] <br> + [match]<br> + [match limits]<br> + [lock [yes|no]]<br> + [lock limits [yes|no]]<br> + [open|close]<br> + <br> + Example: <br> + $ds9 -scale linear<br> + $ds9 -scale log exp 100<br> + $ds9 -scale datasec yes <br> + $ds9 -scale histequ <br> + $ds9 -scale limits 1 100 <br> + $ds9 -scale mode zscale <br> + $ds9 -scale mode 99.5 <br> + $ds9 -scale scope local<br> + $ds9 -scale match<br> + $ds9 -scale match limits<br> + $ds9 -scale lock yes<br> + $ds9 -scale lock limits yes<br> + $ds9 -scale open<br> + $ds9 -scale close</tt><tt><br> + </tt> + <p><b> <a name="shm"></a>shm</b></p> + <p>Load a shared memory segment into the current frame. </p> + <tt> Syntax: <br> + -shm [<key> [<filename>]] <br> + [key <id> [<filename>]] <br> + [shmid <id> [<filename>]]<br> + [fits [key|shmid] <id> + [<filename>]]<br> + [mosaicimage + [iraf|wcs|wcsa...wcsz|wfpc2] [key|shmid] <id> + [<filename>]]<br> + [mosaicimagenext [wcs|wcsa...wcsz] + [key|shmid] <id> [<filename>]]<br> + [mosaic [iraf|wcs|wcsa...wcsz] + [key|shmid] <id> [<filename>]]<br> + [rgbcube [key|shmid] <id> + [<filename>]]<br> + [rgbimage [key|shmid] <id> + [<filename>]]<br> + [rgbarray [key|shmid] <id> +[xdim=<x>,ydim=<y>|dim=<dim>,zdim=3],bitpix=<b>,[skip=<s>]]<br> + [array [key|shmid] <id> +[xdim=<x>,ydim=<y>|dim=<dim>],bitpix=<b>,[skip=<s>]]<br> + <br> + Example: <br> + $ds9 -shm 102 <br> + $ds9 -shm key 102 <br> + $ds9 -shm shmid 102 foo<br> + $ds9 -shm fits 100 foo<br> + $ds9 -shm mosaicimage iraf key 100 foo <br> + $ds9 -shm mosaicimage wcs key 100 foo <br> + $ds9 -shm mosaicimage wcsa key 100 foo <br> + $ds9 -shm mosaicimage wfpc2 key 100 foo <br> + $ds9 -shm mosaicimagenext wcs key 100 foo <br> + $ds9 -shm mosaic iraf key 100 foo<br> + $ds9 -shm mosaic wcs key 100 foo<br> + $ds9 -shm rgbcube key 100 foo<br> + $ds9 -shm rgbimage key 100 foo<br> + $ds9 -shm rgbarray shmid 102 [dim=32,zdim=3,bitpix=-32]<br> + $ds9 -shm array shmid 102 [dim=32,bitpix=-32]<br> + </tt> + <p><b> <a name="sia"></a>sia<br> + </b></p> + <p>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.</p> + <tt> Syntax: <br> + </tt><tt>-sia </tt><tt><tt>[2mass|akari|astrowise|cadc|cxc|mast|sdss|skyview|tgssadr</tt><tt>]</tt><br> + <br> + </tt><tt> </tt><tt> </tt><tt> + [<ref>] [cancel]<br> + </tt><tt> [<ref>] [clear]<br> + </tt><tt> [<ref>] [close]</tt><br> + <tt> [<ref>] [coordinate <ra> + <dec> <coordsys>]</tt><tt><br> + </tt><tt> </tt><tt>[<ref>] + [crosshair]</tt><br> + <tt> [<ref>] [export sb|tsv + <filename>]<br> + </tt><tt> [<ref>] [name <object>]<br> + </tt><tt> [<ref>] [print]</tt><br> + <tt> [<ref>] [retrieve]<br> + </tt><tt> [<ref>] [save + <filename>]</tt><br> + <tt> [<ref>] [size <width> + <height> degrees|arcmin|arcsec]</tt><br> + <tt> </tt><tt> [<ref>] [sky + <skyframe>]<br> + </tt><tt> [<ref>] [skyformat + <skyformat>]<br> + </tt><tt> [<ref>] [system + <coordsys>]</tt><tt><br> + </tt><tt> </tt><tt>[<ref>] [update]</tt><br> + <tt><br> + Example:<br> + </tt><tt>$ds9 -sia 2mass<br> + </tt><tt>$ds9 -sia cancel<br> + </tt><tt>$ds9 -sia clear<br> + </tt><tt>$ds9 -sia close<br> + </tt><tt>$ds9 -sia coordinate 202.48 47.21 fk5<br> + </tt><tt>$ds9 -sia crosshair<br> + </tt><tt>$ds9 -sia export tsv bar.tsv<br> + </tt><tt>$ds9 -sia name m51<br> + </tt><tt>$ds9 -sia print</tt><br> + <tt>$ds9 -sia retrieve<br> + </tt><tt> $ds9 -sia save foo.xml<br> + </tt><tt>$ds9 -sia size 1 1 degrees</tt><br> + <tt>$ds9 -sia sky fk5<br> + $ds9 -sia skyformat degrees<br> + </tt><tt>$ds9 -sia system wcs</tt><tt><br> + </tt><tt>$ds9 -sia update<br> + <br> + </tt><b><a name="single"></a>single</b> + <p>Set display mode to single. </p> + <tt> Syntax: <br> + -single <br> + <br> + Example: <br> + $ds9 -single<br> + </tt> + <p><b><a name="skyview"></a>skyview </b></p> + <p>Support for SkyView image server at HEASARC. </p> + <tt> Syntax: <br> + -skyview []<br> + [<object>]<br> + [name + <object>]<br> + [coord + <ra> <dec> degrees|sexagesimal] # in wcs fk5<br> + [size + <width> <height> degrees|arcmin|arcsec]<br> + [pixels + <width> <height>]<br> + [save yes|no]<br> + [frame + new|current]<br> + [update + frame|crosshair]<br> + [survey <survey>] <br> + [open|close]<br> + <br> + Example:<br> + $ds9 -skyview<br> + $ds9 -skyview m31 <br> + $ds9 -skyview name m31 <br> + $ds9 -skyview coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + $ds9 -skyview size 60 60 arcmin<br> + $ds9 -skyview pixels 600 600<br> + $ds9 -skyview save yes<br> + $ds9 -skyview frame current<br> + $ds9 -skyview update frame <br> + $ds9 -skyview survey sdssi<br> + $ds9 -skyview open<br> + $ds9 -skyview close<br> + </tt> + <p><b><a name="sleep"></a>sleep </b></p> + <p>Delays execution for specified number of seconds. Default is 1 + second.</p> + <tt> Syntax: <br> + -sleep [#]<br> + <br> + Example:<br> + $ds9 -sleep <br> + $ds9 -sleep 2<br> + </tt> + <p><b> <a name="slice"></a>slice<br> + noslice<br> + </b></p> + <p>Indicates next files loaded are to treated as slices of a cube. + Can be disabled with <tt>noslice</tt> command.<br> + </p> + <tt> Syntax: <br> + -slice <filename><br> + -noslice<br> + <br> + Example: <br> + $ds9 -slice *.fits<br> + $ds9 -noslice<br> + </tt> + <p><b><a name="smooth"></a>smooth</b></p> + <p>Smooth current image or set smooth parameters.</p> + <tt> Syntax:<br> + -smooth []<br> + [yes|no]<br> + [function + boxcar|tophat|gaussian]<br> + [radius <int>]<br> + [open|close]<br> + [match]<br> + [lock [yes|no]]<br> + <br> + Example:<br> + $ds9 -smooth<br> + $ds9 -smooth yes<br> + $ds9 -smooth function tophat<br> + $ds9 -smooth radius 4<br> + $ds9 -smooth open<br> + $ds9 -smooth close<br> + $ds9 -smooth match<br> + $ds9 -smooth lock yes<br> + </tt> + <p><b> <a name="squared"></a>squared</b></p> + <p>Select squared scale function for the current frame. </p> + <tt> Syntax: <br> + -squared <br> + <br> + Example: <br> + $ds9 -squared </tt> + <p><b> <a name="sqrt"></a>sqrt</b></p> + <p>Select square soot scale function for the current frame. </p> + <tt> Syntax: <br> + -sqrt <br> + <br> + Example: <br> + $ds9 -sqrt </tt> + <p><b> <a name="source"></a>source</b></p> + <p>Source TCL code from a file. </p> + <tt> Syntax: <br> + -source <filename><br> + <br> + Example: <br> + $ds9 -source extensions.tcl<br> + </tt> + <p><b> <a name="tcl"></a>tcl</b></p> + <p>Execute one TCL command. Note: this a different behavior from + previous versions of DS9.<br> + </p> + <tt> Syntax:<br> + -tcl <tcl command><br> + <br> + Example: <br> + $ds9 -tcl 'puts "Hello, World"'</tt><br> + <p><b> <a name="threads"></a>threads</b></p> + <p>Set number of process threads for functions which are + multi-threaded. </p> + <tt> Syntax:<br> + -threads #<br> + <br> + Example: <br> + $ds9 -threads 8</tt><br> + <br> + <b><a name="tiff"></a>tiff</b><br> + <p>Load TIFF image into current frame.<br> + </p> + <tt> Syntax:<br> + -tiff <filename><br> + <br> + Example: <br> + </tt><tt>$ds9 -tiff foo.tiff</tt><tt><tt><tt><tt><br> + </tt></tt> </tt></tt><tt><tt>$cat foo.fits | ds9 -tiff -</tt></tt><tt><br> + </tt> + <p><b> <a name="tile"></a>tile</b></p> + <p>Controls the tile display mode. </p> + <tt> Syntax: <br> + -tile []<br> + [yes|no] <br> + [mode grid|column|row] <br> + [grid] <br> + [grid mode automatic|manual] <br> + [grid direction x|y]<br> + [grid layout <col> + <row>] <br> + [grid gap <pixels>] <br> + [row] <br> + [column] <br> + <br> + Example: <br> + $ds9 -tile <br> + $ds9 -tile yes <br> + $ds9 -tile mode row <br> + $ds9 -tile grid <br> + $ds9 -tile grid mode manual<br> + $ds9 -tile grid direction x <br> + $ds9 -tile grid layout 5 5 <br> + $ds9 -tile grid gap 10 <br> + $ds9 -tile row <br> + $ds9 -tile column </tt> + <p><b> <a name="title"></a>title</b></p> + <p>Changes the display window title to the specified name. </p> + <tt> Syntax: <br> + -title name <br> + <br> + Example: <br> + $ds9 -title Voyager </tt> + <p><b> <a name="unix"></a>unix</b></p> + <p>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. </p> + <tt> Syntax: <br> + -unix name <br> + <br> + Example: <br> + $ds9 -unix "/tmp/.IMT%d" </tt> + <p><b> <a name="unix_only"></a>unix_only</b></p> + <p>Only use the IRAF unix socket name. This is the same as -fifo + none -port 0. </p> + <tt> Syntax: <br> + -unix_only <br> + <br> + Example: <br> + $ds9 -unix_only<br> + </tt> + <p><b> <a name="update"></a>update</b></p> + <p>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. </p> + <tt> Syntax: <br> + -update [] <br> + [# x1 y1 x2 y2]<br> + [now] <br> + [now # x1 y1 x2 y2]<br> + <br> + Example: <br> + $ds9 -update <br> + $ds9 -update 1 100 100 300 400 <br> + $ds9 -update now <br> + $ds9 -update now 1 100 100 300 400</tt><br> + <p><b> <a name="url"></a>url</b></p> + <p>Load FITS from URL into the current frame</p> + <tt> Syntax: <br> + -url <url><br> + <br> + Example: <br> + $ds9 -url http://foo.bar.edu/foo.fits</tt><tt> </tt> + <p><b> <a name="version"></a>version</b></p> + <p>Returns the current version of DS9 and exits. </p> + <tt> Syntax: <br> + -version <br> + <br> + Example: <br> + $ds9 -version </tt> + <p><b> <a name="view"></a>view</b></p> + <p>Controls the GUI and visible RGB frame color channels. </p> + <tt> Syntax: <br> + -view [layout horizontal|vertical]<br> + [keyvalue <string>]<br> + [info yes|no] <br> + [panner yes|no] <br> + [magnifier yes|no] <br> + [buttons yes|no] <br> + [colorbar yes|no]<br> + [graph horizontal|vertical + yes|no]<br> + [filename yes|no]<br> + [object yes|no]<br> + [keyword yes|no]<br> + [minmax yes|no]<br> + [lowhigh yes|no]<br> + [units yes|no]<br> + [image|physical|wcs|wcsa...wcsz + yes|no]<br> + </tt><tt><tt><tt> [frame yes|no] <br> + </tt></tt> [red yes|no]<br> + [green yes|no]<br> + [blue yes|no]</tt><tt><tt><br> + </tt> <br> + Example: <br> + $ds9 -view layout vertical<br> + $ds9 -view keyvalue BITPIX<br> + $ds9 -view info yes<br> + $ds9 -view panner yes<br> + $ds9 -view magnifier yes<br> + $ds9 -view buttons yes<br> + $ds9 -view colorbar yes<br> + $ds9 -view graph horizontal yes<br> + $ds9 -view filename yes<br> + $ds9 -view object yes<br> + $ds9 -view keyword yes<br> + $ds9 -view minmax yes<br> + $ds9 -view lowhigh yes<br> + $ds9 -view wcsa yes<br> + </tt><tt>$ds9 -view frame yes</tt><br> + <tt>$ds9 -view red yes<br> + $ds9 -view green yes<br> + $ds9 -view blue yes</tt><tt><br> + </tt> + <p><b> <a name="visual"></a>visual</b></p> + <p>Force DS9 to use the specified color visual. This argument MUST + be the first argument listed. Requires the visual be available. + </p> + <tt> Syntax: <br> + -visual + [pseudocolor|pseudocolor8|truecolor|truecolor8|truecolor16|truecolor24] + <br> + Example: <br> + $ds9 -visual truecolor24<br> + </tt> + <p><b> <a name="vla"></a>vla</b></p> + <p>Support for VLA Sky Survey.</p> + <tt> Syntax: <br> + -vla []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> + <dec> degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [survey first|stripe82]<br> + [open|close]<br> + <br> + Example:<br> + $ds9 -vla<br> + $ds9 -vla m31 <br> + $ds9 -vla name m31 <br> + $ds9 -vla coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + $ds9 -vla size 60 60 arcmin<br> + $ds9 -vla save yes<br> + $ds9 -vla frame current<br> + $ds9 -vla update frame<br> + $ds9 -vla survey stripe82<br> + $ds9 -vla open<br> + $ds9 -vla close</tt><br> + <p><b> <a name="vlss"></a>vlss</b></p> + <p>Support for NRAO VLSS Sky Survey.</p> + <tt> Syntax: <br> + -vlss []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> <dec> + degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [open|close]<br> + <br> + Example:<br> + $ds9 -vlss<br> + $ds9 -vlss m31 <br> + $ds9 -vlss name m31 <br> + $ds9 -vlss coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + $ds9 -vlss size 60 60 arcmin<br> + $ds9 -vlss save yes<br> + $ds9 -vlss frame current<br> + $ds9 -vlss update frame<br> + $ds9 -vlss open<br> + $ds9 -nvess close</tt> + <p><b> <a name="vo"></a>vo</b></p> + <p>Invoke an connection to a Virtual Observatory site. </p> + <tt> Syntax: <br> + -vo [method xpa|mime]<br> + [server <url>]<br> + [internal yes|no]<br> + [delay #]<br> + [<url>]<br> + [connect <url>]<br> + [disconnect <url>]<br> + [open|close]<br> + <br> + Example:<br> + $ds9 -vo method xpa<br> + $ds9 -vo server "http://foo.bar.edu/list.txt"<br> + $ds9 -vo internal yes<br> + $ds9 -vo delay 15 # keep-alive delay<br> + $ds9 -vo chandra-ed<br> + $ds9 -vo connect chandra-ed<br> + $ds9 -vo disconnect chandra-ed<br> + $ds9 -vo open<br> + $ds9 -vo close<br> + </tt> + <p><b> <a name="wcs"></a>wcs</b></p> + <p>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 <a href="file.html#WCS">WCS</a> + for more information. </p> + <tt> Syntax: <br> + -wcs [[system] wcs|wcsa...wcsz] <br> + [[sky] fk4|fk5|icrs|galactic|ecliptic] + <br> + [[skyformat] degrees|sexagesimal] <br> + [align yes|no] <br> + [reset [#]] <br> + [replace [#] <filename>] <br> + [append [#] <filename>] <br> + [open|close]<br> + <br> + Example: <br> + $ds9 -wcs wcs <br> + $ds9 -wcs system wcs<br> + </tt><tt>$ds9 -wcs fk5 <br> + </tt><tt>$ds9 -wcs sky fk5 <br> + </tt><tt>$ds9 -wcs sexagesimal <br> + </tt><tt>$ds9 -wcs skyformat sexagesimal <br> + $ds9 -wcs align yes <br> + $ds9 -wcs reset <br> + $ds9 -wcs reset 3<br> + $ds9 -wcs replace foo.wcs <br> + $ds9 -wcs replace 3 foo.wcs <br> + $ds9 -wcs append foo.wcs<br> + $ds9 -wcs append 3 foo.wcs<br> + $ds9 -wcs open<br> + $ds9 -wcs close<br> + </tt> + <p><b> <a name="web"></a>web</b></p> + <p>Display specified URL in the web display. </p> + <tt> Syntax:<br> + -web [new|<webname>] [<url>]<br> + [<webname>] [click + back|forward|stop|reload|#]<br> + [<webname>] [clear]<br> + [<webname>] [close]<br> + <br> + Example: <br> + $ds9 -web www.cnn.com<br> + $ds9 -web new www.cnn.com<br> + $ds9 -web hvweb www.apple.com<br> + $ds9 -web click back<br> + $ds9 -web click 2<br> + $ds9 -web clear<br> + $ds9 -web close<br> + </tt> + <p><b> <a name="width"></a>width</b></p> + <p>Set the width of the image display window. Use the <a + href="command.html#geometry">geometry</a> command to set the + overall width and height of the ds9 window.</p> + <tt> Syntax: <br> + -width [<value>]<br> + <br> + Example: <br> + $ds9 -width 512<br> + </tt> + <p><b> <a name="xpa"></a>xpa</b></p> + <p>Configure XPA.</p> + <tt> Syntax:<br> + -xpa [yes|no] <br> + [inet|local|unix|localhost] <br> + [noxpans]<br> + [connect]<br> + [disconnect]<br> + [info]<br> + <br> + Example: <br> + $ds9 -xpa no <br> + $ds9 -xpa local <br> + $ds9 -xpa noxpans<br> + $ds9 -xpa connect<br> + $ds9 -xpa disconnect<br> + $ds9 -xpa info<br> + </tt> + <p><b> <a name="zmax"></a>zmax</b></p> + <p>Set Scale Limits based on the <i>IRAF</i> algorithm and + maximum data value. </p> + <tt> Syntax: <br> + -zmax <br> + <br> + Example: <br> + $ds9 -zmax </tt> + <p><b> <a name="zscale"></a>zscale</b></p> + <p>Set Scale Limits based on the <i>IRAF</i> algorithm. </p> + <tt> Syntax: <br> + -zscale []<br> + [contrast]<br> + [sample]<br> + [line]<br> + <br> + Example: <br> + $ds9 -zscale<br> + $ds9 -zscale contrast .25<br> + $ds9 -zscale sample 600<br> + $ds9 -zscale line 120<br> + </tt> + <p><b> <a name="zoom"></a>zoom</b></p> + <p>Controls the current zoom value for the current frame. </p> + <tt> Syntax: <br> + -zoom [<value>]<br> + [<value> <value>]<br> + [to <value>]<br> + [to <value> <value>] + <br> + [in]<br> + [out]<br> + [to fit] <br> + [open|close]<br> + <br> + Example: <br> + $ds9 -zoom 2<br> + $ds9 -zoom 2 4<br> + $ds9 -zoom to 4<br> + $ds9 -zoom to 2 4 <br> + $ds9 -zoom in<br> + $ds9 -zoom out<br> + $ds9 -zoom to fit<br> + $ds9 -zoom open<br> + $ds9 -zoom close<br> + <br> + </tt> </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/contour.html b/ds9/doc/ref/contour.html new file mode 100644 index 0000000..25dc20d --- /dev/null +++ b/ds9/doc/ref/contour.html @@ -0,0 +1,189 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Contours</title> + </head> + <body link="#0000ee" alink="#ff0000" bgcolor="#ffffff" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" height="98" align="middle" + width="100"> Contours</h3> + <blockquote> + <p>DS9 can create and display contours as an overlay on an image. + The Analysis Contours menu is used to display contours. To + create, copy, paste, and configure contours, use the + Analysis Contour Parameters menu.</p> + <p><b>Contour Parameters </b></p> + <p>When creating a new contour, a dialog box appears, in which the + user selects the number of contour levels, smoothness, and the + distribution of the contours. </p> + <p><b> Contour Levels</b></p> + <p>Specifies the number of contour levels to be generated. A + typical number is between 1 and 10. Note: large numbers of + contours can take a long time to generate. </p> + <p><b> Contour Smoothness</b></p> + <p>Specifies how smooth the contours are. A smoothness level of 1 + will evaluate the contour at each image pixel. A level of 2 will + evaluate the contour at every other pixel. The larger the + number, the quicker the contour will be generated, and the less + detail will be available. </p> + <p><b> Contour Scale</b></p> + <p>Specifies the distribution of the contour levels. <br> + </p> + <p><b> Contour Method</b></p> + <p>There are two methods that are available to calculate the + contour lines. The first, BLOCK, blocks down the image, by the + smoothness factor, before contours are calculated. As a result, + the larger the smoothness, the faster the result. The second + method, SMOOTH, smooths the image before calculating contours. + As a result, the larger the smoothness, the slower the result.<br> + </p> + <p><b> <a name="ContourFiles"></a>Contour Files</b></p> + <p>A contour file is an ASCII file containing a header, global + properties, coordinate system, contour levels, and contour + points. <br> + </p> + <blockquote> + <p><b> Header</b></p> + <p>A DS9 contour file may start with the following optional + header: </p> + <blockquote> <tt># Contour file format: DS9 version 7.5<br> + </tt></blockquote> + <p><b> Global Properties</b></p> + <p>Global properties affect all contour levels unless a line + level attribute is specified. The <tt>global</tt> keyword is + first, followed by a list of keyword = value pairs. Multiple + global property lines may be used within a region file. </p> + <blockquote> <tt>global color=green width=1 dash=1 dashlist=8 3<br> + </tt></blockquote> + <p><b> Coordinate Systems</b></p> + <p>For each contour file, it is important to specify the + coordinate system used to interpret the contour points, i.e., + to set the context in which the positions are interpreted. For + this purpose, the following keywords are recognized: </p> + <blockquote> <tt>PHYSICAL + +# + + + + + + + + + pixel coords of original file using LTM/LTV</tt> <br> + <tt>IMAGE + +# + + + + + + + + + pixel coords of current file</tt> <br> + <tt><tt><tt>FK4,B1950 + + # sky coordinate systems</tt> <br> + FK5,J2000 +# + + + + + + + + + sky coordinate systems</tt> <br> + </tt><tt><tt><tt>ICRS + +# + sky coordinate systems</tt> <br> + </tt>GALACTIC + +# + + + + + + + + + sky coordinate systems</tt> <br> + <tt>ECLIPTIC + +# + + + + + + + + + sky coordinate systems</tt> <br> + <tt>WCS + + # primary WCS<br> + </tt><tt>WCSA + # + secondary WCS<br> + </tt><tt>LINEAR + +# + + + + + + + + + linear primary WCS</tt> <tt><br> + </tt></blockquote> + </blockquote> + <blockquote> + <p><b> Contour Level</b></p> + <p>Each contour level is composed of a line value, line + attributes and one or more contours. Line attributes are + specified at the start of a new level and only affect contours + within that level . </p> + <blockquote> <tt>level=15.78775 color=pink width=2 dash=yes dashlist=2 + 2<br> + </tt></blockquote> + <p><b> Contour</b></p> + <p>Each contour is composed of one or more X,Y coordinates, with + a deliminator of space or comma, starting with "(" and + ending with ")". Contours are not closed.<br> + </p> + </blockquote> + <blockquote> + <blockquote><tt>(</tt><tt>202.4836468 47.22380226</tt><tt><br> + </tt><tt> 202.4833538 47.2239185</tt><tt><br> + </tt><tt> 202.4831634 47.22409874</tt><tt><br> + </tt><tt> 202.4829883 47.22428858</tt><tt>)</tt><br> + </blockquote> + </blockquote> + <blockquote> + <p><br> + </p> + <blockquote> </blockquote> + </blockquote> + <p><br> + </p> + <blockquote> + <blockquote> </blockquote> + <blockquote> </blockquote> + <blockquote> </blockquote> + </blockquote> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/file.html b/ds9/doc/ref/file.html new file mode 100644 index 0000000..379eee3 --- /dev/null +++ b/ds9/doc/ref/file.html @@ -0,0 +1,825 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>File Formats</title> + </head> + <body link="#0000ee" alink="#ff0000" bgcolor="#ffffff" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" height="98" align="middle" + width="100"> File Formats</h3> + <blockquote> <a href="#FITS">FITS</a><br> + <a href="#FITSImage">FITS Image</a><br> + <a href="#FITSBinaryEventsTable">FITS Binary Events Table</a><br> + <a href="#FITSHEALPIXTable">FITS HEALPIX Table</a><br> + <a href="#FITSDataCube">FITS Data Cube</a><br> + <a href="#FITSMultipleExtensionDataCube">FITS Multiple Extension + Data Cube</a><br> + <a href="#FITSMultipleExtensionMultipleFrames">FITS Multiple + Extension Multiple Frames</a><br> + <a href="#FITSMosaic">FITS Mosaic</a><br> + <a href="#FITSMosaicDataCube">FITS Mosaic Data Cube</a><br> + <a href="#FITSRGB">FITS RGB </a><br> + <a href="#SplitFITS">Split FITS</a><br> + <a href="#array">Array</a> <br> + <a href="file:///Users/joye/saods9/doc/ref/file.html#nrrd">NRRD</a><br> + <a href="#envi">ENVI</a><br> + <a href="#gif">GIF</a><br> + <a href="#tiff">TIFF</a><br> + <a href="#jpeg">JPEG</a><br> + <a href="#png">PNG</a><br> + <a href="#ExternalFileSupport">External Format Support</a> <br> + <a href="#ExternalAnalysisSupport">External Analysis Support</a> <br> + <a href="#RegionFiles">Region Files</a><br> + <a href="#ContourFiles">Contour Files</a> <br> + <a href="#ColorLookupTable">Color Lookup Table</a> <br> + <a href="#WCS">WCS</a> <br> + <a href="#PreferenceFile">Preference File</a> <br> + <a href="#StartupFile">Startup File</a> <br> + <a href="#TCL">TCL</a><br> + <p><b><a name="FITS"></a>FITS</b></p> + DS9 supports FITS images and FITS binary tables. The following + algorithm is used to locate and to load the FITS image or table if + no additional information is provide: + <blockquote> + <ul> + <li> <tt> Examine primary HDU, if IMAGE, load.<br> + </tt></li> + <li><tt>Examine each extension HDU</tt></li> + <ul> + <li><tt>If IMAGE, load.<br> + </tt></li> + <li><tt>If BINARY TABLE, create IMAGE if the following is + true:</tt></li> + <ul> + <li><tt>FITS COMPRESSED: keyword ZIMAGE is T.</tt></li> + <li><tt>FITS EVENTS: keyword EXTNAME is EVENTS,STDEVT, or + RAYEVENT, column names X and Y are present.</tt></li> + <li><tt>FITS HEALPIX: keyword PIXTYPE is HEALPIX.</tt><br> + </li> + </ul> + </ul> + <li><tt> If DS9 traverses the entire FITS file without + satisfying one of the above, an error is generated.</tt> </li> + </ul> + </blockquote> + FITS keyword inheritance is supported. All valid FITS <tt>BITPIX</tt> + values are supported, along with <tt>-16,</tt> for <tt>UNSIGNED + SHORT</tt>. The following FITS keywords are supported: + <blockquote> <tt> OBJECT<br> + UNITS<br> + BSCALE / BZERO<br> + BLANK<br> + DATASEC<br> + LTV / LTM for physical coords<br> + DTV / DTM for detector coords<br> + ATV / ATM for amplifier coords<br> + WCS keywords<br> + WCS# keywords </tt> </blockquote> + <p><b> <a name="FITSImage"></a>FITS Image</b></p> + At load time, the user may provide just a file name or a file name + along with FITS extension name/number and image section + specification. FITS extension names are case insensitive. When + specifying an extension, be sure to quote strings correctly to + pass both the shell and DS9 parser. A image section specification + is used to specify the x,y limits of an image subsection. By + default, x and y coordinates are in <tt>IMAGE</tt>, use a <tt>'p'</tt> + as the last character to indicate <tt>PHYSICAL</tt> coordinates. + A <tt>'*'</tt> indicates use the default for that axis only. + Block is optional and defaults to 1.<br> + <blockquote> <tt> Syntax:<br> + filename<br> + filename[ext]<br> + filename[ext][sect]<br> + filename[sect]<br> + filename[ext,sect]<br> + <br> + where</tt><tt><br> + <br> + ext:<br> + [extension name | extension #]<br> + <br> + sect:<br> + [x0:x1</tt><tt>,y0:y1[p]]<br> + </tt><tt><tt><tt>[x0:x1</tt></tt></tt><tt><tt><tt>,y0:y1</tt></tt></tt><tt><tt><tt><tt>,block</tt></tt></tt></tt><tt><tt><tt><tt>[p]</tt>]<br> + </tt>[x0:x1</tt></tt><tt><tt>,y0:y1</tt></tt><tt><tt>,z0:z1</tt></tt><tt><tt><tt>[p]</tt>]<br> + </tt></tt><tt><tt><tt>[x0:x1</tt></tt></tt><tt><tt><tt>,y0:y1</tt></tt></tt><tt><tt><tt>,block,z0:z1</tt></tt></tt><tt><tt><tt><tt>[p]</tt>]</tt></tt></tt><br> + <tt><tt><tt>[*,y0:y1</tt></tt></tt><tt><tt><tt><tt>[p]</tt>]<br> + </tt><tt><tt><tt>[*,y0:y1</tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>,block</tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>[p]</tt>]<br> + </tt>[*,y0:y1</tt></tt></tt></tt><tt><tt><tt><tt>,z0:z1</tt></tt></tt></tt><tt><tt><tt><tt><tt>[p]</tt>]<br> + </tt></tt><tt><tt><tt>[*,y0:y1</tt></tt></tt></tt></tt><tt><tt><tt><tt><tt>,block,z0:z1</tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>[p]</tt>]</tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt>[x0:x1</tt></tt></tt></tt></tt><tt><tt><tt><tt><tt>,*</tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>[p]</tt>]<br> + </tt><tt><tt><tt>[x0:x1</tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt>,*</tt></tt></tt><tt><tt><tt><tt>,block</tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt>]<br> + </tt>[x0:x1</tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>,*,z0:z1</tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt>]<br> + </tt></tt><tt><tt><tt>[x0:x1</tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt>,*,block,z0:z1</tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt>]</tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[*,*</tt></tt></tt><tt><tt><tt><tt>,block</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>]<br> + </tt>[*,*,z0:z1</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>]<br> + </tt></tt><tt><tt><tt>[*,*,block,z0:z1</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>]</tt></tt></tt><br> + <br> + </tt></tt></tt></tt></tt></tt>[dim1@xcen,dim2@ycen</tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>]<br> + </tt></tt><tt><tt><tt><tt><tt><tt>[dim1@xcen,dim2@ycen,block</tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>]<br> + </tt></tt>[dim1@xcen,dim2@ycen,dim3@zcen</tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>]<br> + </tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>[dim1@xcen,dim2@ycen,block,dim3@zcen</tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>]</tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt>[*,dim2@ycen</tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>]<br> + </tt></tt><tt><tt><tt><tt><tt><tt>[*,dim2@ycen,block</tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>]<br> + </tt></tt>[*,dim2@ycen,dim3@zcen</tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>]<br> + </tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>[*,dim2@ycen,block,dim3@zcen</tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>]</tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[dim1@xcen,*</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>]<br> + </tt></tt><tt><tt><tt><tt><tt><tt>[dim1@xcen,*,block</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>]<br> + </tt></tt>[dim1@xcen,*,dim3@zcen</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>]<br> + </tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>[dim1@xcen,*,block,dim3@zcen</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[p]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>[*,*,block]<br> + </tt></tt>[*,*,dim3@zcen]<br> + </tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>[*,*,block,dim3@zcen]</tt></tt></tt></tt></tt></tt><br> + <br> + </tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt>[dim@xcen@ycen]</tt></tt><tt><tt><br> + </tt></tt>[dim@xcen@ycen,block]</tt></tt><br> + <tt><tt><tt><tt>[dim@xcen@ycen,zdim@zcen]</tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt>[dim@xcen@ycen,block,zdim@zcen]</tt></tt></tt></tt></tt></tt></tt></tt><tt><br> + <br> + Example:<br> + $ds9 foo.fits # default load <br> + $ds9 foo.fits[1] # load first extension<br> + $ds9 foo.fits[BCKGRD] # load extension named 'BCKGRD'<br> + $ds9 foo.fits[10:200,40:100] # image section<br> + </tt><tt><tt>$ds9 foo.fits[10:200,40:100,2] # image section, + blocked by 2<br> + </tt>$ds9 foo.fits[*,40:100] # only section y axis<br> + $ds9 foo.fits[256@512@512] # section box at 512,512<br> + $ds9 foo.fits[2][100:200,100:200] # second extension, image + section<br> + </tt><tt><tt>$ds9 foo.fits[2][100:200,100:200,2] # second + extension, image section, blocked by 2<br> + </tt>$ds9 foo.fits[10:200,40:100,5:20] # cube section<br> + $ds9 foo.fits[*,40:100,5:20] # only section y and z axes<br> + $ds9 foo.fits[256@512@512] # section cube at 512,512<br> + $ds9 foo.fits[2][100:200,100:200,5:20] # second extension, + cube section</tt><br> + <tt>$ds9 foo.fits[2][100:200,100:200,2,5:20] # second extension, + cube section, blocked by 2</tt> </blockquote> + <b><a name="FITSBinaryEventsTable"></a>FITS Binary Events Table<br> + <br> + </b> At load time, the user may provide just a file name or a file + name along with FITS extension name/number, image section + specification, and binnng parameters. DS9 will automatically + convert an FITS binary events table into a 2D image for display. + FITS extension names and parameters are case insensitive. The + users may specify a number of parameters on how to construct the + image and how to filter data. When specifying a filter, be sure to + quote strings correctly to pass both the shell and DS9 parser. </blockquote> + <blockquote> + <blockquote> <tt><tt><tt><tt>Syntax: <br> + </tt></tt></tt></tt><tt><tt>filename<br> + filename[ext]<br> + filename[ext][sect]<br> + filename[sect]<br> + filename[ext,sect]<br> + </tt><br> + filename[ext][bin]<br> + </tt><tt><tt><tt><tt><tt>filename[ext][bin][sect]<br> + </tt></tt></tt></tt>filename[ext][sect][bin]<br> + </tt><tt><tt><tt><tt>filename[bin]<br> + </tt></tt></tt>filename[bin][sect]<br> + </tt><tt><tt>filename[sect][bin]<br> + </tt></tt><tt>filename[ext,bin]<br> + <br> + </tt><tt>where:<br> + ext: see <a href="FITSImage">FITS Image</a><br> + sect: see <a href="FITSImage">FITS Image</a><br> + <br> + bin:<br> + [bin=colx,coly] # bin counts <br> + </tt><tt><tt>[bin=colx,coly,filter] # bin counts with filter<br> + </tt>[bin=colx,coly,colz] # bin on colz <br> + </tt><tt><tt>[bin=colx,coly,colz,filter] # bin on colz with + filter<br> + </tt></tt><tt><tt>[bin=colz] # bin cols 'x', 'y', and colz <br> + </tt></tt><tt><tt>[bin=colz,filter] # bin cols 'x', 'y', and + colz with filter<br> + </tt>[key=colx,coly] <br> + [binkey=colx,coly]<br> + </tt><br> + (see <a + href="http://hea-www.harvard.edu/saord/funtools/filters.html">Introduction + + + + + + + + + + + + + + + + to Filtering</a>)<br> + <br> + <tt>Example: </tt><br> + <tt> $ds9 foo.fits # default load </tt><br> + <tt> $ds9 foo.fits[1] # load first extension </tt><br> + <tt> $ds9 foo.fits[BCKGRD] # load extension named 'BCKGRD' </tt><br> + <tt> $ds9 foo.fits[bin=detx,dety] # bin on detx,dety </tt><br> + <tt> $ds9 foo.fits[2][bin=rawx,rawy] # load ext 2, cols + rawx,rawy </tt><br> + <tt> $ds9 foo.fits[bg_events,bin=rawx,rawy] # load ext + bg_events, cols rawx,rawy </tt><br> + <tt> $ds9 foo.fits[bin=x,y,pha] # bin on x,y,pi </tt><br> + <tt> $ds9 foo.fits[bin=pi] # bin on x,y,pi</tt><br> + <tt> $ds9 'foo.fits[ccd_id==3&&energy>4000]' # quoted + filter</tt><br> + <tt> $ds9 '"foo.fits[ccd_id==3 && energy>4000]"' # + double quoted filter</tt><br> + <tt> $ds9 'foo.fits[events][pha>5,pi<2]' # load extension + 'events' and filter</tt></blockquote> + </blockquote> + <blockquote> + <blockquote> </blockquote> + <p>The shell environment variable <tt>DS9_BINKEY </tt>may be + used to specify default bin cols for FITS bin tables. Example:</p> + <blockquote> <tt>$ export DS9_BINKEY='[bin=rawx,rawy]'</tt> <br> + <tt>$ ds9 foo.fits # load FITS bin table, bin on rawx, rawy<br> + </tt></blockquote> + <p><b> <a name="FITSHEALPIXTable"></a>FITS HEALPIX Table<br> + </b></p> + At load time, the user may provide just a file name or a file name + along with FITS extension name/number, image section + specification, and Healpix parameters. DS9 will automatically + convert a FITS HEALPIX binary or ascii table into a 2D image for + display. FITS extension names and parameters are case insensitive. + The users may specify a number of parameters on how to construct + the image. Any table with keyword PIXTYPE=HEALPIX or NSIDE=x will + be processed as an HEALPIX image. The following FITS keywords will + be used if present and not overwritten by a command line option: + NSIDE, COORDSYS, ORDER.<br> + <blockquote> + <blockquote> </blockquote> + <tt><tt><tt><tt>Syntax: <br> + </tt></tt></tt></tt><tt><tt>filename<br> + filename[ext]<br> + filename[ext][sect]<br> + filename[sect]<br> + filename[ext,sect]<br> + <br> + </tt></tt><tt><tt><tt>filename[ext][hpx]<br> + </tt><tt><tt><tt><tt><tt>filename[ext][hpx][sect]<br> + </tt></tt></tt></tt>filename[ext][sect][hpx]<br> + </tt><tt><tt><tt><tt>filename[hpx]<br> + </tt></tt></tt>filename[hpx][sect]<br> + </tt><tt><tt>filename[sect][hpx]<br> + </tt></tt><tt>filename[ext,hpx]<br> + <br> + </tt>where:<br> + </tt></tt><tt><tt><tt><tt><tt><tt><tt>ext: see <a + href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS + + + + + + Image</a><br> + </tt></tt></tt></tt></tt>sect: see <a + href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS + + + + + + Image</a><br> + <br> + hpx:<br> + </tt></tt><tt>[order=ring|nested] # default ring<br> + [layout=equatorial|north|south] # default equatorial<br> + [col=<column number>] # defaut 1<br> + [quad=<quadurant number>] # (1-4) default 1<br> + [system=equatorial|galactic|ecliptic|unknown] # default + unknown</tt><br> + <br> + <tt>Example: </tt><tt><br> + $ds9 foo.fits # default load </tt><tt><br> + $ds9 foo.fits[1] # load first extension </tt><tt><br> + $ds9 + foo.fits[order=ring,layout=equatorial,col=1,quad=1,system=unknown]<br> + </tt><tt>$ds9 foo.fits[1,order=nested] # first extension, nested + order</tt><br> + </blockquote> + <blockquote> </blockquote> + <p><b><a name="FITSDataCube"></a>FITS Cube</b></p> + A FITS Cube is a FITS image which contains more than 2 axes + (NAXES>2). DS9 will automatically detect if a cube is present + and will load all additional images. In addition, individual + images can be loaded one at a time into a cube. DS9 will display + the Cube dialog box which allows the user to select which 2 image + to be displayed. + <p><b><a name="FITSMultipleExtensionDataCube"></a>FITS Multiple + Extension Cube</b></p> + A FITS Multiple Extension Data Cube file is a FITS file with one + or more extensions, that is to be displayed as a data cube. Each + image does not have to be the same size, however, only the + coordinate systems from the first extension will be used for + contours and grids. <br> + <blockquote><tt> Example:</tt><br> + <tt> $ds9 -mecube foo.fits # load multiple extension fits file + as data cube</tt></blockquote> + <p><b><a name="FITSMultipleExtensionMultipleFrames"></a>FITS + Multiple Extension Multiple Frames</b></p> + Load a multiple extension FITS file into multiple frames. Please + note that files loaded via standard-in or the xpa fits command can + not be displayed using this method. <br> + <blockquote><tt> Example:</tt><br> + <tt> $ds9 -multiframe foo.fits # load multiple extension fits + file as multiple frames</tt></blockquote> + <p><b><a name="FITSMosaic"></a>FITS Mosaic</b></p> + A FITS mosaic image may exist as a series of FITS files, or as one + FITS file with many extensions. A FITS mosaic may be loaded all a + one time, or by the segment. Once loaded, the multiple FITS images + are treated as one FITS image. <br> + <br> + DS9 supports three forms of mosaics: + <center> + <table align="center" border="1" cellpadding="2" cellspacing="2" + width="50%"> + <tbody> + <tr> + <td valign="top"><tt>IRAF</tt><br> + </td> + <td valign="top"> <tt>contains the DETSEC and DETSIZE + keywords.<br> + See <a + href="http://iraf.noao.edu/projects/ccdmosaic/imagedef/imagedef.html">NOAO + +IRAF +Mosaic +Data + + + + + + + + + + + + + + + + Structures</a></tt> <br> + </td> + </tr> + <tr> + <td align="left" valign="top"> <tt>WCS</tt><br> + </td> + <td align="left" valign="top"><tt>each FITS image contains + a valid WCS.</tt><br> + </td> + </tr> + <tr> + <td align="left" valign="top"> <tt>HST WFPC2</tt><br> + </td> + <td align="left" valign="top"> <tt>valid HST WFPC2 data + cube, consisting of 4 planes, along with a fits ascii + table containing wcs information. </tt></td> + </tr> + </tbody> + </table> + </center> + <tt></tt> + <blockquote><tt>Example:</tt><br> + <tt> $ds9 -mosaicimage iraf foo.fits # load mosaic iraf from one + fits file with multiple exts</tt><br> + <tt> $ds9 -mosaic iraf foo.fits bar.fits wow.fits # load mosaic + iraf from 3 files</tt><br> + <tt> $ds9 -mosaicimage wcs foo.fits # load mosaic wcs from one + fits file with multiple exts</tt><br> + <tt> $ds9 -mosaic wcs foo.fits bar.fits wow.fits # load mosaic + wcs from 3 files</tt><br> + <tt> $ds9 -mosaicimage wfpc2 bar.fits # load wfpc2 mosaic</tt><br> + <tt> $ds9 -mosaic foo.fits bar.fits wow.fits # load mosaic (wcs) + from 3 files</tt><br> + <tt> </tt></blockquote> + <p><b><a name="FITSMosaicDataCube"></a>FITS Mosaic Data Cube</b></p> + A FITS Mosaic Data Cube is a FITS mosaic image which contains more + than 2 axes (NAXES>2). DS9 will automatically detect if a + mosaic data cube is present and will load all additional images. + At the same time, DS9 will display the data cube dialog box which + allows the user to select which 2 image to be displayed. + <p><b><a name="FITSRGB"></a>FITS RGB</b></p> + A FITS RGB image may exist as three of FITS images, one FITS file + with three extensions, or as a FITS 3D Data cube, with three + slices, each representing the red, green, and blue channel. A FITS + RGB image may be loaded all a one time, or by the channel. Once + loaded, the multiple FITS images are treated as one FITS image.<br> + <blockquote><tt>Example:</tt><br> + <tt> $ds9 -rgbimage rgb.fits # load rgb image consisting of one + fits file with 3 image exts</tt><br> + <tt> $ds9 -rgbcube cube.fits # load rgb image consisting of one + fits data cube</tt><br> + <tt> $ds9 -rgb -red foo.fits -green bar.fits -blue wow.fits # + rgb image from 3 fits images</tt><br> + <tt> </tt></blockquote> + <p><b><a name="SplitFITS"></a>Split FITS</b></p> + A split fits is a valid fits file in which two files contain the + header and data segments. + <p><b><a name="array"></a>Array</b></p> + Raw data arrays are supported. To load an array, the user must + provide the dimensions, pixel depth, and optional header size and + architecture type. + <blockquote> <tt> Syntax:<br> + </tt><tt><tt><tt><tt><tt><tt><tt>filename[arr]<br> + </tt></tt></tt>filename[arr][sect]<br> + </tt><tt><tt>filename[sect][arr]<br> + </tt></tt></tt></tt><br> + where</tt><br> + <tt><tt><tt>sect: see <a + href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS + + + + + + Image</a><br> + </tt></tt>arr:<br> + </tt> + <blockquote><tt> xdim=value </tt><br> + <tt> ydim=value </tt><br> + <tt> zdim=value # default is a depth of 1</tt><br> + <tt> dim=value </tt><br> + <tt> dims=value </tt><br> + <tt> bitpix=[8|16|-16|32|64|-32|-64] </tt><br> + <tt> skip=value # must be even, most must be factor of 4 </tt><br> + <tt> arch|endian=[big|bigendian|little|littleendian]</tt><br> + </blockquote> + <tt> Example:<br> + $ds9 -array bar.arr[xdim=512,ydim=512,zdim=1,bitpix=16] # load + 512x512 short<br> + $ds9 -array bar.arr[dim=256,bitpix=-32,skip=4] # load 256x256 + float with 4 byte head<br> + $ds9 -array bar.arr[dim=512,bitpix=32,arch=little] # load + 512x512 long, intel<br> + </tt> + <p>or alternate format:</p> + <tt>filename[array(<type><dim><:skip><endian>)]<br> + <br> + where:<br> + type: + <blockquote> 'b' 8 -bit unsigned char<br> + 's' 16-bit short int<br> + 'u' 16-bit unsigned short int<br> + 'i' 32-bit int<br> + 'l' 64-bit int<br> + 'r' 32-bit float<br> + 'f' 32-bit float<br> + 'd' 64-bit float </blockquote> + dim: + <blockquote> int # x,y dim<br> + int.int # x,y dim<br> + int.int.int # x,y,z dim<br> + </blockquote> + skip: + <blockquote> int # number of bytes to + skip </blockquote> + endian: + <blockquote> 'l' little endian<br> + 'b' big endian<br> + </blockquote> + Example:<br> + $ds9 -array bar.arr[array(s512)] # load 512x512 + short<br> + $ds9 -array bar.arr[array(r256:4)] # load 256x256 float with 4 + byte head<br> + $ds9 -array bar.arr[array(i512l)] # load 512x512 long, + intel </tt> + <p>The shell environment variable <tt>DS9_ARRAY </tt>may be + used to specify default array parameters. </p> + <tt> Example:<br> + $export DS9_ARRAY='[dim=256,bitpix=-32]'<br> + $ds9 -array foo.arr # load 256x256 float<br> + </tt></blockquote> + <p><b><a name="nrrd"></a>NRRD (Nearly Raw Raster Data)</b><br> + </p> + Images in NRRD are supported directly. Encodings supported: <tt>raw, + + + + + + + + + gzip<br> + </tt><br> + <tt>Syntax:<br> + </tt><tt><tt><tt><tt><tt><tt><tt>filename<br> + </tt></tt></tt>filename[sect]<br> + </tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt>where:<br> + sect: see <a + href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS + + + + + + Image</a><br> + </tt></tt> </tt><tt><tt><br> + </tt></tt></tt></tt></tt><tt>Example:</tt><br> + <tt>$ds9 -nrrd foo.nrrd<br> + $ds9 -nrrd foo.nrrd[100:200,100:200] # cropped</tt><br> + <p><b><a name="envi"></a>ENVI</b><br> + </p> + Images in ENVI are supported directly. Encodings supported: <tt>BIL, + + + + + + + BIP, BSQ.<br> + </tt><br> + <tt>Syntax:<br> + </tt><tt><tt><tt><tt><tt><tt><tt>filename<br> + </tt></tt></tt>filename[sect]<br> + <br> + where:</tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt>sect: see <a + href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS + + + + + + Image</a><br> + </tt></tt> </tt><tt><tt><br> + </tt></tt></tt></tt></tt> <tt>Example:</tt><br> + <tt>$ds9 -envi foo.hdr foo.bsq<br> + $ds9 -envi foo.hdr foo.bsq[100:200,100:200] # cropped<br> + </tt> + <p><b><a name="gif"></a>GIF</b><br> + </p> + Images in GIF are supported directly. For a <tt>Frame</tt>, the + average of the luminosity is used. For <tt>Frame RGB</tt>, each + channel is loaded directly.<br> + <tt><br> + Syntax:<br> + </tt><tt><tt><tt><tt><tt><tt><tt>filename<br> + </tt></tt></tt></tt></tt></tt></tt><br> + <tt>Example:<br> + </tt> <tt>$ ds9 -gif foo.gif</tt><br> + <p><b><a name="tiff"></a>TIFF</b><br> + </p> + Images in TIFF are supported directly. For a <tt>Frame</tt>, the + average of the luminosity is used. For <tt>Frame RGB</tt>, each + channel is loaded directly.<br> + <br> + <tt>Syntax:<br> + </tt><tt><tt><tt><tt><tt><tt><tt>filename<br> + </tt></tt></tt></tt></tt></tt></tt><br> + <tt>Example:</tt><br> + <tt>$ ds9 -tiff foo.tiff</tt><br> + <p><b><a name="jpeg"></a>JPEG</b><br> + </p> + Images in JPEG are supported directly. For a <tt>Frame</tt>, the + average of the luminosity is used. For <tt>Frame RGB</tt>, each + channel is loaded directly.<br> + <tt><br> + Syntax:<br> + </tt><tt><tt><tt><tt><tt><tt><tt>filename<br> + </tt></tt></tt></tt></tt></tt></tt><br> + <tt>Example:</tt><br> + <tt>$ ds9 -jpeg foo.jpeg</tt><br> + <p><b><a name="png"></a>PNG</b><br> + </p> + Images in PNG are supported directly. For a <tt>Frame</tt>, the + average of the luminosity is used. For <tt>Frame RGB</tt>, each + channel is loaded directly.<br> + <br> + <tt>Syntax:<br> + </tt><tt><tt><tt><tt><tt><tt><tt>filename<br> + </tt></tt></tt></tt></tt></tt></tt><br> + <tt>Example:</tt><br> + <tt>$ ds9 -png foo.png</tt><br> + <p><b> <a name="ExternalFileSupport"></a>External File Support</b></p> + DS9 supports external file formats via an ASCII description file. + When loading a file into DS9, these descriptions are referenced + for instructions for loading the file, based on the file + extension. If found, the command is executed and the result, a + FITS image or FITS Binary Table, is read into DS9 via stdin. <br> + At start-up, DS9 first searches for the ASCII file, named <tt>.ds9.fil</tt>in + + +the +local +directory, + + + + + + + + + + + + + + + + then in the users home directory. <br> + The file command first is macro-expanded to fill in user-defined + arguments and then is executed externally. <br> + The ASCII file that defines the known image files consists of one + or more file descriptors, each of which has the following format: + <blockquote> <tt> Help description<br> + A space-separated list of templates<br> + A space-separated list of file types (not currently used)<br> + The command line for the loading this file type<br> + </tt> </blockquote> + Note that blank lines separate the file descriptions and should + not be used as part of a description. Also, the '#' character is a + comment character. <br> + <br> + The following macros are supported: <tt>$filename</tt><br> + <blockquote><tt> For Example: </tt><br> + <tt> # File access descriptions:</tt><br> + <tt> # help explanation</tt><br> + <tt> # file template</tt><br> + <tt> # file type</tt><br> + <tt> # access command</tt><br> + <tt> IRAF IMH files</tt><br> + <tt> *.imh</tt><br> + <tt> IMH</tt><br> + <tt> i2f -s $filename </tt></blockquote> + <p><b> <a name="ExternalAnalysisSupport"></a>External Analysis + Support</b></p> + For more information about external analysis support files, see <a + href="analysis.html">Analysis</a>. + <p><b> <a name="RegionFiles"></a>Region Files</b></p> + DS9 can read and write a number of region file formats. See <a + href="region.html">Regions</a> documentation for more + information. + <blockquote> <tt> <a href="region.html#RegionDescriptions">DS9</a><br> + <a href="region.html#FUNTools">FUNTools</a><br> + <a href="region.html#Ciao">Ciao</a><br> + <a href="region.html#SAOimage">SAOimage</a><br> + <a href="region.html#IRAFPROS">IRAF PROS</a><br> + <a href="region.html#FITSREGIONBinaryTable">FITS REGION Binary + Table</a><br> + <a href="region.html#XY">X Y</a><br> + </tt></blockquote> + <p> <b><a name="ContourFiles"></a>Contour Files</b></p> + <b> </b>See <a + href="file:///Users/joye/saods9/ds9/doc/ref/contour.html#ContourFiles">Contours</a> + documentation for more information. <br> + <b></b> + <blockquote><tt> </tt> </blockquote> + <p><b> <a name="ColorLookupTable"></a>Color Lookup Table</b></p> + DS9 has a number of default colormaps available to the user. DS9 + also supports reading and writing color lookup table formats from + the following programs: + <blockquote> <tt> <a +href="http://tdc-www.harvard.edu/software/saoimage/saoimage.color.html#cmap">SAOimage</a><br> + <a + href="http://hea-www.harvard.edu/RD/saotng/adding_cmaps.html">SAOtng</a><br> + XImtool<br> + </tt> </blockquote> + DS9 uses the file extension to determine the color table format: + <center> + <table nosave="" border="1" cellpadding="2" cellspacing="2" + width="50%"> + <tbody> + <tr nosave=""> + <td nosave=""> + <center><tt>Ext</tt></center> + </td> + <td> + <center><tt>Format</tt></center> + </td> + </tr> + <tr> + <td><tt>.lut</tt></td> + <td><tt>XImtool, SAOtng</tt></td> + </tr> + <tr> + <td><tt>.sao</tt></td> + <td><tt>DS9, SAOimage</tt></td> + </tr> + <tr> + <td><tt>any other</tt></td> + <td><tt>DS9</tt></td> + </tr> + </tbody> + </table> + </center> + <p><b> <a name="WCS"></a>WCS</b></p> + 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 via XPA. The + format of the specification is a set of valid FITS keywords that + describe a WCS. + <blockquote> <tt> Example: <br> + CRPIX1 + = + + + + + + + + + + + + + + + + 257.75<br> + CRPIX2 + = + + + + + + + + + + + + + + + + 258.93<br> + CRVAL1 + = -201.94541667302 <br> + CRVAL2 + = + + + + + + + + + + + + + + + + -47.45444<br> + CDELT1 + = -2.1277777E-4 <br> + CDELT2 + = 2.1277777E-4 + <br> + CTYPE1 = 'RA---TAN' <br> + CTYPE2 = 'DEC--TAN' <br> + </tt> </blockquote> + Note that the WCS definitions can contain standard FITS 80 + character WCS card images, as shown above, or free-form name/value + pairs without the intervening "=" sign: + <blockquote> <tt> CRPIX1 + 257.75 <br> + CRPIX2 258.93 <br> + CRVAL1 -201.94541667302 <br> + CRVAL2 -47.45444 <br> + CDELT1 -2.1277777E-4 <br> + CDELT2 2.1277777E-4 <br> + CTYPE1 'RA---TAN' <br> + CTYPE2 'DEC--TAN' </tt> </blockquote> + <p><b> <a name="PreferenceFile"></a>Preference File</b></p> + A preference file is a valid tcl script generated by DS9 to save + the current preference items. See <a href="prefs.html">Preferences</a> + for more information. + <p><b> <a name="StartupFile"></a>Startup File</b></p> + If a startup file <tt>$HOME/ds9.ini</tt> is available, it is + sourced as the last step in initialization. The file permissions + must be group/world readonly.<br> + Users may have several different startup files. DS9 looks for a + startup file with its own name. By default, if the application is + named <tt>ds9</tt>, it will look for <tt>.ds9.ini.</tt> However, + if the DS9 application is named <tt>foo</tt>, then DS9 will look + for <tt>.foo.ini.</tt> In this manner, the user can have several + predefined startup files that are activated by invoking DS9 with a + different application names. <br> + <p><b> <a name="TCL"></a>TCL</b></p> + TCL/TK script file. Users may customize the appearance and enhance + the capabilities of DS9 by sourcing their own TCL scripts. </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/grid.html b/ds9/doc/ref/grid.html new file mode 100644 index 0000000..ed772cc --- /dev/null +++ b/ds9/doc/ref/grid.html @@ -0,0 +1,90 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=ISO-8859-1"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Coordinate Grids</title> + </head> + <body alink="#ff0000" bgcolor="#ffffff" link="#0000ee" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" align="middle" height="98" + width="100"> Coordinate Grids</h3> + <blockquote> + <p>DS9 can create and display coordinate grids as an overlay on an + image. The Display Coordinate Grid Menu is used to display + grids. A coordinate grid is composed of Grid Lines, Axes, + Border, and Title. Axes include tick marks, title, and numbers. + The appearance of the coordinate grid is specified by + parameters. These parameters may be configured via the + Coordinate Grid Parameters dialog box. In addition to the axes + titles and the grid title, the following menus are available. </p> + <p><b><a name="Format"></a>Numeric Formats</b></p> + <p>The user may specify custom numeric formats for either axes. + The format specification can be empty (default) or a print + function, based on the selected coordinate system:<br> + </p> + <blockquote> <tt>image</tt><br> + <tt>physical</tt><br> + <tt>detector</tt><br> + <tt>amplifier</tt><br> + <tt>wcs linear</tt><br> + <tt>wcs equatorial</tt><br> + </blockquote> + <p>The format specification string to be passed to the C "printf" + function (e.g. "%%1.7G") in order to format a single coordinate + value.</p> + <p>The Format string supplied should contain one or more of the + following characters. These may occur in any order, but the + following is recommended for clarity:</p> + <blockquote> "": Indicates that a plus sign should be prefixed to + positive values. By default, no plus sign is used.<br> + "z": Indicates that leading zeros should be prefixed to the + value so that the first field is of constant width, as would be + required in a fixed-width table (leading zeros are always + prefixed to any fields that follow). By default, no leading + zeros are added.<br> + "i": Use the standard ISO field separator (a colon) between + fields. This is the default behaviour.<br> + "b": Use a blank to separate fields.<br> + "l": Use a letter ("h"/"d", "m" or "s" as appropriate) to + separate fields.<br> + "g": Use a letter and symbols to separate fields ("h"/"d", "m" + or "s", etc, as appropriate), but include escape sequences in + the formatted value so that the Plot class will draw the + separators as small super-scripts.<br> + "d": Include a degrees field. Expressing the angle purely in + degrees is also the default if none of "h", "m", "s" or "t" are + given.<br> + "h": Express the angle as a time and include an hours field + (where 24 hours correspond to 360 degrees). Expressing the angle + purely in hours is also the default if "t" is given without + either "m" or "s".<br> + "m": Include a minutes field. By default this is not included.<br> + "s": Include a seconds field. By default this is not included. + This request is ignored if "d" or "h" is given, unless a minutes + field is also included.<br> + "t": Express the angle as a time (where 24 hours correspond to + 360 degrees). This option is ignored if either "d" or "h" is + given and is intended for use where the value is to be expressed + purely in minutes and/or seconds of time (with no hours field). + If "t" is given without "d", "h", "m" or "s" being present, then + it is equivalent to "h".<br> + ".": Indicates that decimal places are to be given for the final + field in the formatted string (whichever field this is). The "." + should be followed immediately by an unsigned integer which + gives the number of decimal places required, or by an asterisk. + If an asterisk is supplied, a default number of decimal places + is used which is based on the value of the Digits attribute.<br> + </blockquote> + <p>All of the above format specifiers are case-insensitive. If + several characters make conflicting requests (e.g. if both "i" + and "b" appear), then the character occurring last takes + precedence, except that "d" and "h" always override "t".</p> + <p>The default formats are <tt>d.3</tt> for degrees and <tt>hms.1</tt> + / <tt>dms.1</tt> / <tt>ldms.1</tt> for sexagesimal.<br> + </p> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/how.html b/ds9/doc/ref/how.html new file mode 100644 index 0000000..9a76d51 --- /dev/null +++ b/ds9/doc/ref/how.html @@ -0,0 +1,159 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>How</title> + </head> + <body link="#0000ee" alink="#ff0000" bgcolor="#ffffff" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" height="98" align="middle" + width="100"> How it Works</h3> + <blockquote> + <p><b>Table of Contents</b></p> + <a href="#How">How DS9 Renders an Image</a><br> + <a href="#Scales">Scales</a><br> + <a href="#Smoothing">Smoothing</a><br> + <a href="#Contours">Contours</a><br> + <a href="#LargeFiles">Large Files</a><br> + <p><b><a name="How"></a>How DS9 renders an image</b></p> + <p>Here is a short description on how DS9 decides to paint a pixel + a color on the the screen, give an data value... you need a + color scale, a contrast/bias pair for the colorscale, clip + values for the data, a scale distribution, and finally, the + value of the pixel in question.</p> + <blockquote> + <p>Step 1. Select a color scale. A color scale is defined as a + number of colors (RGB triplets). The number of RGB triplets + can vary from just a few to over 200. DS9 contains a number of + predefined color scales (Gray, A, B, I8, ...) or the user may + load his own color scale.</p> + <p>Step 2. Apply a contrast/bias pair. This step takes the + result of step 1 and creates a new array with the + contrast/bias applied. The length of the new array will + between 200 (for pseudocolor) and 4096 (for truecolor).</p> + <p>Step 3. Calculate the data clip values (low/high data + values). The min/max data values may be used or an algorithm + may be used to determine the clip data values.</p> + <p>Step 4. Apply the scale distribution. This involves taking + the result of step 2, and creating yet another array, this + time of size 16384, redistributing the colors, based on the + scale algorithm selected (see <a href="Scales">Scales</a>).</p> + <p>Step 5. Based on your data clip values, and the value of the + pixel you have, index into the result of step 4, and you have + an index into lookup table (for pseudocolor) and an RGB pair + (for truecolor and postscript).</p> + </blockquote> + <p><b><a name="Scales"></a>Scales</b></p> + <p>The <tt>log</tt> function is defined as the following:</p> + <blockquote> + <p><b><img src="img/log.png" alt="log equation" height="32" + width="78"></b></p> + </blockquote> + <p>as <i>x</i> goes from 0 to 1. The user may specify an exponent + <i>a</i> to change the distribution of colors within the + colorbar. The default value of <i>a</i> is 1000. Typically, + optical images respond well at 1000, IR images as low as 100, + and high energy bin tables up to 10000. A value of 10000 closely + matches the <b><tt>log</tt></b> function of SAOImage as defined + as the following:</p> + <blockquote> + <p><b><img src="img/saolog.png" alt="SAOImage log equation" + height="34" width="65"></b></p> + </blockquote> + <p>The <tt>pow</tt> function is defined as the following:</p> + <blockquote> + <p><b><img src="img/pow.png" alt="pow equation" height="30" + width="51"></b></p> + </blockquote> + <p>as <i>x</i> goes from 0 to 1. The user may specify an exponent + <i>a</i> to change the distribution of colors within the + colorbar. The default value of <i>a</i> is 1000.</p> + <p>The <tt>sqrt</tt> scale function is defined as the following:</p> + <blockquote><img src="img/sqrt.png" alt="sqrt equation" + height="21" width="42"><br> + </blockquote> + <p>as <i>x</i> goes from 0 to 1. </p> + <p>The <tt>square</tt> scale function is defined as the + following:</p> + <blockquote><img src="img/square.png" alt="square equation" + height="21" width="35"><br> + </blockquote> + <p>as <i>x</i> goes from 0 to 1.<br> + </p> + <p>The <tt>asinh</tt> scale function is defined as the following:</p> + <blockquote><img alt="asinh" src="img/asinh.png" height="29" + width="80"><br> + </blockquote> + <p>as <i>x</i> goes from 0 to 1. </p> + <p>The <tt>sinh</tt> scale function is defined as the following:</p> + <blockquote><img alt="sinh" src="img/sinh.png" height="29" + width="69"><br> + </blockquote> + <p>as <i>x</i> goes from 0 to 1. </p> + <p>The <tt>histogram equalization</tt> scale function distributes + colors based on the frequency of each data value.</p> + <p><b><a name="Smoothing"></a>Smoothing</b></p> + <p>The user may select one of three types of smoothing kernels. + The parameter, <i>r</i> or <tt>kernel radius</tt>, is defined + as the following:</p> + <blockquote> Boxcar function, where the width = 2<i>r</i>+1<br> + Tophat function, where the radius = <i>r</i> and the diameter + of kernel is 2<i>r</i>+1<br> + Gaussian function, defined as: + <blockquote><img src="img/gauss.png" alt="Gaussian Equation" + height="38" width="173"><br> + </blockquote> + where the mean = 0 and sigma =<i> r</i>/2, and the diameter of + kernel is 2<i>r</i>+1 </blockquote> + <p><b><a name="Contours"></a>Contours</b></p> + <p>The contour algorithm is from an unknown author and originally + came from FV. The difference between the two modes are:<tt><br> + </tt></p> + <blockquote><tt>block</tt> : the image is blocked down before the + contour is generated <br> + <tt>smooth</tt> : the image is smoothed via a Gaussian kernel + before the contour is generated. </blockquote> + <p><tt>block</tt> mode is faster as the smoothing parameter + increases. Inversely, <tt>smooth</tt> mode is much slower as + the smoothing parameter increases.</p> + <p><b><a name="LargeFiles"></a>Large Files</b></p> + There are several factors that determine if DS9 will be able to + load a large file.<br> + <p>32 bit OS vs 64 bit OS : to address very large files, you may + need to use an 64 bit OS with a 64bit version of DS9. 32bit apps + can address up to 4Gb of address space. However, depending on + the OS, this limit may be less. Linux for example, the limit + appears to be ~3GB (the OS and shared libs eat up a lot of + address space). Under 64bit Solaris, 32bit ds9 has a full 4Gb of + space. MacOSX appears to have a limit ~3Gb. Under windows, ~2Gb.</p> + <p>Large File Support: is the ability to sequence thru files + larger than 4Gb. DS9 is compiled with LFS.</p> + <p>File system: the OS file system must be able to support files + larger than 4Gb. Most recent file systems fully support 4GB>.</p> + <p>Memory Management: There are a number of memory management + techniques supported in DS9 that will greatly affect the ability + and speed of loading large files:</p> + <blockquote> <tt>$ ds9 foo.fits # uses mmap</tt><br> + <tt>$ cat foo.fits | ds9 - # allocates memory</tt> <br> + <tt>$ xpaset -p ds9 file foo.fits # uses mmap</tt> <br> + <tt>$ xpaset -p ds9 fits foo.fits # allocates memory</tt><br> + </blockquote> + <p>Memory Map (<tt>mmap</tt>) is very fast, limit is memory + address space (see above). Allocate is very slow, limit is + amount of physical memory + swap partition.</p> + <p>Scanning Data: DS9 needs to determine the min and max data + values to correctly display your image. For large files, such as + Mosaics and Data Cubes, this can take time. You have the + option of using using the FITS keywords DATAMIN/MAX or + IRAFMIN/MAX - great if present, bad because they are always + wrong. Another option is to specify the low and high clip values + via the command line or Scale dialogbox.<br> + </p> + <blockquote> <br> + </blockquote> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/img/asinh.png b/ds9/doc/ref/img/asinh.png Binary files differnew file mode 100644 index 0000000..7021885 --- /dev/null +++ b/ds9/doc/ref/img/asinh.png diff --git a/ds9/doc/ref/img/gauss.png b/ds9/doc/ref/img/gauss.png Binary files differnew file mode 100644 index 0000000..31a639a --- /dev/null +++ b/ds9/doc/ref/img/gauss.png diff --git a/ds9/doc/ref/img/log.png b/ds9/doc/ref/img/log.png Binary files differnew file mode 100644 index 0000000..f122879 --- /dev/null +++ b/ds9/doc/ref/img/log.png diff --git a/ds9/doc/ref/img/pow.png b/ds9/doc/ref/img/pow.png Binary files differnew file mode 100644 index 0000000..65b2dd5 --- /dev/null +++ b/ds9/doc/ref/img/pow.png diff --git a/ds9/doc/ref/img/saolog.png b/ds9/doc/ref/img/saolog.png Binary files differnew file mode 100644 index 0000000..0a4b871 --- /dev/null +++ b/ds9/doc/ref/img/saolog.png diff --git a/ds9/doc/ref/img/sinh.png b/ds9/doc/ref/img/sinh.png Binary files differnew file mode 100644 index 0000000..395e6d9 --- /dev/null +++ b/ds9/doc/ref/img/sinh.png diff --git a/ds9/doc/ref/img/sqrt.png b/ds9/doc/ref/img/sqrt.png Binary files differnew file mode 100644 index 0000000..16ad2c0 --- /dev/null +++ b/ds9/doc/ref/img/sqrt.png diff --git a/ds9/doc/ref/img/square.png b/ds9/doc/ref/img/square.png Binary files differnew file mode 100644 index 0000000..b96c6bf --- /dev/null +++ b/ds9/doc/ref/img/square.png diff --git a/ds9/doc/ref/index.html b/ds9/doc/ref/index.html new file mode 100644 index 0000000..8286492 --- /dev/null +++ b/ds9/doc/ref/index.html @@ -0,0 +1,105 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=ISO-8859-1"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Reference Manual</title> + </head> + <body alink="#ff0000" bgcolor="#ffffff" link="#0000ee" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" align="middle" height="98" + width="100"> SAOImage DS9 Reference Manual</h3> + <blockquote> + <p>DS9 is the next version of the popular <a + href="http://hea-www.harvard.edu/RD/saotng/">SAOtng</a> + display program. It is a Tk/Tcl application which utilizes the + SAOtk widget set. It also incorporates the new X Public Access (<a + href="http://hea-www.harvard.edu/RD/xpa/">XPA</a>) mechanism + to allow external processes to access and control its data, GUI + functions, and algorithms. DS9 supports the direct display + of FITS images and binary tables, multiple frame buffers, region + cursor manipulation, many scale algorithms and colormaps, and + easy communication with external analysis tasks. It is highly + configurable and extensible to meet the evolving needs of the + astronomical community. </p> + <p>DS9 supports advanced features such as multiple frame buffers, + mosaic images, tiling, blinking, geometric markers, colormap + manipulation, scaling, arbitrary zoom, rotation, pan, and a + variety of coordinate systems (including Image, Physical, + Detector, and WCS). DS9 also supports FTP and HTTP access. The + GUI for DS9 is user configurable.</p> + <table align="center" border="0" cellpadding="4" cellspacing="2" + height="25%" width="75%"> + <tbody> + <tr> + <td align="center" valign="middle"> <a href="how.html">How + It Works</a></td> + <td align="center" valign="top"><a href="backup.html">Backup + and Restore</a></td> + <td align="center" valign="middle"> <a href="file.html">File + + + + + + + + Formats</a></td> + </tr> + <tr> + <td align="center" valign="middle"> <a href="keyboard.html">Mouse + + + + + and Keyboard</a> </td> + <td align="center" valign="top"><a href="grid.html">Coordinate + + + + + + + + Grids</a></td> + <td align="center" valign="middle"> <a href="prefs.html">Preferences</a></td> + </tr> + <tr> + <td align="center" valign="middle"> <a href="command.html">Command + + + + + Line Options</a> </td> + <td align="center" valign="top"><a href="catalog.html">Catalogs</a></td> + <td align="center" valign="middle"> <a href="3d.html">3-D + Frames</a></td> + </tr> + <tr> + <td align="center" valign="middle"> <a href="xpa.html">XPA + Access Points</a> </td> + <td align="center" valign="top"><a href="colorbar.html">Colorbar</a><br> + </td> + <td align="center" valign="middle"> <a href="contour.html">Contours</a></td> + </tr> + <tr> + <td align="center" valign="top"> <a href="samp.html">SAMP<br> + </a> </td> + <td align="center" valign="top"><a href="print.html">Printing</a></td> + <td align="center" valign="top"> <a href="iraf.html">IRAF + Support</a></td> + </tr> + <tr> + <td align="center" valign="middle"> <a href="region.html">Regions</a> + </td> + <td align="center" valign="top"><a href="analysis.html">Analysis</a></td> + <td align="center" valign="middle"> <a href="bin.html">Binning</a><br> + </td> + </tr> + </tbody> + </table> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/iraf.html b/ds9/doc/ref/iraf.html new file mode 100644 index 0000000..72545d4 --- /dev/null +++ b/ds9/doc/ref/iraf.html @@ -0,0 +1,179 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" + content="text/html; charset=ISO-8859-1"> + <meta name="GENERATOR" + content="Mozilla/4.78 [en] (X11; U; Linux 2.4.7-10 i686) [Netscape]"> + <title>IRAF Support</title> + </head> + <body link="#0000ee" text="#000000" vlink="#551a8b" alink="#ff0000" + bgcolor="#ffffff"> + <h3><img alt="" src="../sun.gif" height="98" width="100" align="middle"> + IRAF Support</h3> + <blockquote> + <p>DS9 is a fully functional IRAF image display server. IRAF + uses the IIS protocol to communicate with a valid image display server, + such as DS9, ximtool, saoimage, and saotng. With DS9, no special + scripts are + needed. If you have one of the above currently working, DS9 works <i>right</i> + <i>out of the box.</i> And DS9 now supports IRAF's new IIS image + display + protocol that supports up to 16 display frames. </p> + <p>All native DS9 functions may be used with images load with IRAF + display + except for the <tt>Scale</tt> menu items. Values displayed may the the + true values, if a linear scale is specified with the <tt>display</tt> + command. + Otherwise, the value is a scaled value. DS9 supports IRAF in all + display + visuals including <tt>Truecolor</tt>. Support full postscript printing + of images loaded from IRAF is provided. </p> + <p><b> Command Line Arguments</b></p> + <p>As with <i>ximtool</i>, the follow command line arguments may be + used + to specify the communication parameters: </p> + <blockquote> + <tt> + <a href="command.html#fifo">fifo</a><br> + <a href="command.html#fifo_only">fifo_only</a><br> + <a href="command.html#port_only">inet_only</a><br> + <a href="command.html#port">port</a><br> + <a href="command.html#port_only">port_only</a><br> + <a href="command.html#unix">unix</a><br> + <a href="command.html#unix_only">unix_only</a> + </tt> + </blockquote> + <p>The default parameters are: </p> + <blockquote> + <tt> + fifo /dev/imt1<br> + port 5137<br> + unix /tmp/.IMT%d</tt> + </blockquote> + <p><b> Configuration</b></p> + <p>An <i>IRAF</i> image server uses a configuration + file to specify the number of available buffers and their sizes. + What actually + passes from IRAF is not the buffer size, but an index number into + this file. </p> + <p>So when an image server starts (DS9), it will attempt to locate + this file as <tt>$HOME/.imtoolrc</tt> and /<tt>usr/local/lib/imtoolrc</tt>. + If + not found, it will look for shell environment variables <tt>IMTOOLRC</tt> + and <tt>imtoolrc</tt>, that contains the name of the configuration + file. </p> + <p>If no configuration file is found, DS9 will assume the following + default configuration: </p> + <blockquote> + <tt> + 1 2 512 512 # imt1|imt512 <br> + 2 2 800 800 # imt2|imt800 <br> + 3 2 1024 1024 # imt3|imt1024 <br> + 4 1 1600 1600 # imt4|imt1600 <br> + 5 1 2048 2048 # imt5|imt2048 <br> + 6 1 4096 4096 # imt6|imt4096 <br> + 7 1 8192 8192 # imt7|imt8192 <br> + 8 1 1024 4096 # imt8|imt1x4 <br> + 9 2 1144 880 # imt9|imtfs full screen + (1152x900 minus frame) <br> + 10 2 1144 764 # imt10|imtfs35 full screen at + 35mm film aspect ratio <br> + 11 2 128 128 # imt11|imt128 <br> + 12 2 256 256 # imt12|imt256 <br> + 13 2 128 1056 # imt13|imttall128 tall & + narrow for spectro. <br> + 14 2 256 1056 # imt14|imttall256 tall & + wider for spectro. <br> + 15 2 1056 128 # imt15|imtwide128 wide & + thin for spectro. <br> + 16 2 1056 256 # imt16|imtwide256 wide & + fatter for spectro. <br> + 17 2 1008 648 # imt17|imtssy Solitaire fmt w/ + imtool border <br> + 18 2 1024 680 # imt18|imtssn Solitaire fmt + w/out imtool border <br> + 19 1 4096 1024 # imt19|imt4x1</tt> + </blockquote> + <p>If on the other hand, IRAF assumes a different buffer size, the + image + will appear corrupted and DS9 may issue a number of error messages. </p> + <p>Another problem is that this file must be in sync with <tt>dev$graphcap</tt>. + If + your system administrator has made changes to <tt>graphcap</tt>, + they must also be implemented in <tt>imtoolrc</tt>. </p> + <p>Here is a note from NOAO: </p> + <blockquote> + <p><tt>The messages means that there is no /usr/local/lib/imtoolrc + file on the machine. This is created as a symlink to dev$imtoolrc by + the iraf install script but only if the /usr/local/lib dir already + exists on the machine. The fix is the create the dir and rerun the + install + script or else make the link by hand. Users can also just copy + dev$imtoolrc to $HOME/.imtoolrc and restart the server to also + workaround + it. Note that an existing .imtoolrc might define old frame buffer + configs which might confuse things, so if the system file exists check + for a + private copy screwing things up.</tt></p> + </blockquote> + <p><b> Windows DS9 and IRAF</b></p> + <p>To direct image output from IRAF to DS9 running under windows, use + the <tt>IMTDEV</tt> + environment variable. For example, if the windows machine is named + 'foo.bar.edu', define <tt>IMTDEV</tt> to the follow value before + entering IRAF. </p> + <blockquote> + <tt>$ setenv IMTDEV inet:5137:foo.bar.edu<br> + $ cl <br> + cl> display dev$pix</tt> + </blockquote> + <p><b> Scale Menu Disabled</b></p> + <p>When you display an image from <i>IRAF</i> into DS9, <i>IRAF</i> + actually does the color scale distribution. In <tt>Display</tt>, + use the <tt>ztrans</tt> and <tt>z1</tt>,<tt>z2</tt><tt>zscale</tt> + parameter to auto determine <tt>z1,z2. Here</tt> are the <tt>DISPLAY</tt> + parameters in question: parameters to set + the upper/lower bounds and distribution. You can also use the </p> + <blockquote> + <tt> + ztrans=[linear|log|none|user]<br> + z1=min<br> + z2=max<br> + zscale=[yes|no]</tt> + </blockquote> + <p>What actually is sent from <i>IRAF</i> to DS9 is one byte per + pixel, + values 0-200, which already has applied both the upper and lower + clipping bounds and the distribution. So this is why, the <tt>SCALE </tt>menu + is + disabled in DS9 when it receives a image from <i>IRAF</i>.</p> + <p><b>MSCRED/MSCZERO<br> + </b></p> + <p>DS9 now supports IRAF's new IIS image display protocol. However, + there + is one minor problem with the <b>mscred</b> task <b>msczero.</b> + Before using <b>msczero</b>, issue the following command in the cl:</p> + <blockquote> + <tt>cl> set disable_wcs_maps=""<br> + cl> flpr</tt><br> + </blockquote> + <p><b>IMEXAMINE</b></p> + <p>Due to the unique relationship between DS9 and IRAF, if you use + the <b>imexamine</b> + task, you can take advantage of a special feature of DS9. Instead of + loading the image from IRAF with the <b>display</b> task, load the + image directly into DS9. Then, from the <b>cl</b> prompt, invoke <b>imexamine</b> + without a filename. IRAF will ask DS9 for the current filename and use + it for analysis. This approach provides several advantages over + previous methods. First, it + will work with compound fits images such as mosaics, data cubes, and + rgb images. + Second, the image displays includes true image data and WCS + information, + not + the approximated data from IRAF. + </p> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/keyboard.html b/ds9/doc/ref/keyboard.html new file mode 100644 index 0000000..dae00be --- /dev/null +++ b/ds9/doc/ref/keyboard.html @@ -0,0 +1,230 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Mouse and Keyboard</title> + </head> + <body alink="#ff0000" bgcolor="#ffffff" link="#0000ee" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" align="middle" height="98" + width="100"> Mouse and Keyboard</h3> + <blockquote> + <p><b> Mouse Buttons</b></p> + <p>The following table contains the event bindings for the mouse + buttons. </p> + <center> + <table nosave="" border="1" width="75%"> + <tbody> + <tr> + <td> + <center>Mouse Button</center> + </td> + <td> + <center>Description</center> + </td> + </tr> + <tr> + <td><font face="Courier New,Courier">Button 1</font></td> + <td>Depends on current MODE, which may be selected by the + EDIT menu option.<br> + In Region mode, create/edit/delete regions.<br> + In Crosshair mode, will move current crosshair.<br> + In Colorbar mode, will change contrast and bias of + colormap.<br> + In Pan mode, will move or pan to clicked location.<br> + In Zoom mode, will zoom about clicked location.<br> + In Rotate mode, will rotate image about center.<br> + In Crop mode, will select 2-D crop region. For 3-D <i>Shift-click</i> + will edit front clip plane, <i>Control-click</i> will + edit back clip plane.<br> + In Catalog mode, will select catalog regions.<br> + In examine mode, will follow IRAF examine protocol.<br> + </td> + </tr> + <tr> + <td><font face="Courier New,Courier">Button 2</font></td> + <td>Pan mode: will move or pan to clicked location. + Behavior depends on the PAN preference settings.</td> + </tr> + <tr> + <td><font face="Courier New,Courier">Button 3</font></td> + <td>Colorbar mode: will change the contrast and bias of + the colormap.</td> + </tr> + </tbody> + </table> + </center> + <p><b>Greek and other special characters.</b> </p> + <p>The concept of a separate <tt>SYMBOL</tt> font is 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 characters 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.</p> + <blockquote> + <p>Linux- Gnome: <b>gucharmap<br> + </b>Linux- KDE: <b>kcharselect<br> + </b>MacOSX: <b>Character Viewer</b> (Select <tt>Edit:Special + Characters</tt>) Now click and drag the characters to a + terminal window. Then select the string and select <tt>Edit:Copy</tt>.<br> + Windows: <b>Character Map</b> (from <tt>Start</tt> button, + select <tt>All Programs</tt>, <tt>Accessories</tt>, <tt>System + + + Tools</tt> and then <tt>Character Map</tt>)</p> + </blockquote> + <p><b>Keyboard Shortcuts</b></p> + <p>The following table contains the list of keyboard shortcuts and + the resulting action taken. </p> + <center> + <table nosave="" border="1" width="75%"> + <tbody> + <tr> + <td align="center"> Key Stroke </td> + <td> + <center>Description</center> + </td> + </tr> + <tr> + <td align="center"><tt>TAB</tt></td> + <td><font face="Courier New,Courier">G</font>oto next + frame</td> + </tr> + <tr> + <td align="center" valign="top"><tt>Shift-TAB</tt><br> + </td> + <td valign="top">Goto previous frame<br> + </td> + </tr> + <tr> + <td align="center"><tt>DELETE</tt></td> + <td>Deletes selected regions</td> + </tr> + <tr> + <td align="center">c<br> + </td> + <td>Print Mouse Coordinates and Pixel value.</td> + </tr> + <tr> + <td align="center">f<br> + </td> + <td>Toggles Infobox freeze</td> + </tr> + <tr> + <td align="center">i<br> + </td> + <td>Set include property for region</td> + </tr> + <tr> + <td align="center">e<br> + </td> + <td>Set exclude property for region</td> + </tr> + <tr> + <td align="center">s<br> + </td> + <td>Set source property for region</td> + </tr> + <tr> + <td align="center">b<br> + </td> + <td>Set background property for region</td> + </tr> + <tr> + <td align="center">g<br> + </td> + <td>Create a new group</td> + </tr> + <tr> + <td align="center"><tt>Shift-g</tt></td> + <td>Create a new group with default name</td> + </tr> + <tr> + <td align="center"><tt>+</tt></td> + <td>Goto next 3D Fits Slice</td> + </tr> + <tr> + <td align="center"><tt>-</tt></td> + <td>Goto previous 3D Fits Slice</td> + </tr> + <tr> + <td align="center"><tt>Up Arrow<br> + k<br> + </tt></td> + <td>Will move selected regions up one pixel. <br> + In Pointer mode, will move the cursor up one pixel. <br> + In Crosshair mode, will move the crosshair up one pixel. + <br> + In Pan mode, will pan the image up one pixel.</td> + </tr> + <tr nosave=""> + <td align="center"><tt>Right</tt><font face="Courier + New,Courier"> </font><tt>Arrow<br> + l<br> + </tt></td> + <td nosave="">Will move selected regions to the right one + pixel. <br> + In Pointer mode, will move the cursor to the right one + pixel. <br> + In Crosshair mode, will move the crosshair to the right + one pixel. <br> + In Pan mode, will pan the image to the right one pixel.</td> + </tr> + <tr> + <td align="center"><tt>Left</tt><font face="Courier + New,Courier"> </font><tt>Arrow<br> + h<br> + </tt></td> + <td>Will move selected regions to the left one pixel. <br> + In Pointer mode, will move the cursor to the left one + pixel. <br> + In Crosshair mode, will move the crosshair to the left + one pixel. <br> + In Pan mode, will pan the image to the left one pixel.</td> + </tr> + <tr> + <td align="center"><tt>Down</tt><font face="Courier + New,Courier"> </font><tt>Arrow<br> + j<br> + </tt></td> + <td>Will move selected regions down one pixel. <br> + In Pointer mode, will move the cursor up down one pixel. + <br> + In Crosshair mode, will also move the crosshair down one + pixel. <br> + In Pan mode, will pan the image down one pixel.</td> + </tr> + <tr> + <td align="center"><tt>Shift</tt><font face="Courier + New,Courier">-</font><tt>Drag</tt></td> + <td>In Pointer mode, will select all regions within the + indicated region.<br> + In Crop mode, for 3D frame, will move front crop plane + forward.<br> + </td> + </tr> + <tr> + <td align="center"><tt>Control-Drag</tt></td> + <td>In Poiner mode, on selected <tt>ANNULUS</tt> Regions, + will create new radii.<br> + In Crop mode, for 3D frame, will move back crop plane + backward.<br> + </td> + </tr> + <tr> + <td align="center" valign="top"><tt>Command-`</tt><br> + </td> + <td valign="top">Rotate thur all open windows<br> + </td> + </tr> + </tbody> + </table> + </center> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/prefs.html b/ds9/doc/ref/prefs.html new file mode 100644 index 0000000..05ffb9e --- /dev/null +++ b/ds9/doc/ref/prefs.html @@ -0,0 +1,34 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Preferences</title> + </head> + <body alink="#ff0000" bgcolor="#ffffff" link="#0000ff" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" height="98" align="middle" + width="100"> Preferences</h3> + <blockquote> + <p>Allows the user to customize the appearance and behavior of the + GUI . Please note: some preferences take effect immediately, + while others require DS9 to be restarted. Changes to the + preferences can be saved by selecting the <tt>Save</tt> button<tt>. + </tt>Use the <tt>Clear Preferences </tt>button to restore + default settings.</p> + <p>User preferences are stored in <tt>$HOME/.ds9.prf</tt>. DO NOT + EDIT this file, since it will be deleted or overwritten by DS9. + The file permissions must be group/world readonly.<br> + </p> + <p>Users may have several different preference files. DS9 looks + for a preference file with its own name. By default, if the + application is named <tt>ds9</tt>, it will look for <tt>.ds9.prf.</tt> + However, if the DS9 application is named <tt>foo</tt>, then DS9 + will look for <tt>.foo.prf.</tt> In this manner, the user can + have several predefined preference files that are activated by + invoking DS9 with a different application names. </p> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/print.html b/ds9/doc/ref/print.html new file mode 100644 index 0000000..4ff3272 --- /dev/null +++ b/ds9/doc/ref/print.html @@ -0,0 +1,57 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Printing</title> + </head> + <body link="#0000ee" alink="#ff0000" bgcolor="#ffffff" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" height="98" align="middle" + width="100"> Printing</h3> + <blockquote> + <p>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. </p> + <p><b> Postscript Level</b></p> + <blockquote> + <p> Level 1-- The postscript generated consist of a color lookup + table and image data, encoded in <tt>ASCIIHEX</tt>. All line + graphics and text are postscript elements.</p> + <p> Level 2-- The postscript generated consist of a color lookup + table and image data, compressed with RLE, and encoded in <tt>ASCIIHEX85. + + + + + </tt>All line graphics and text are postscript elements.</p> + </blockquote> + <blockquote> + <p> Level 3-- The postscript generated consist of a color lookup + table and image data, compressed with GZIP<tt>. </tt>All line + graphics and text are postscript elements.</p> + </blockquote> + <p><b>Postscript Color Model</b></p> + <p>DS9 supports three color models for level 2/3 postscript. All + three color models generate approximately the same size files. </p> + <blockquote><tt> RGB<br> + CMYK<br> + Grayscale<br> + </tt></blockquote> + <p><b> Resolution</b></p> + <p>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.</p> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/region.html b/ds9/doc/ref/region.html new file mode 100644 index 0000000..fcd8601 --- /dev/null +++ b/ds9/doc/ref/region.html @@ -0,0 +1,808 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>Regions</title> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + </head> + <body link="#0000ff" alink="#ff0000" bgcolor="#ffffff" text="#000000" + vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" height="98" align="middle" + width="100"> Regions</h3> + <blockquote> + <p>Regions provide a means for marking particular areas of an + image for further analysis. Regions may also be used for + presentation purposes. DS9 supports a number of region + descriptions, each of which may be edited, moved, rotated, + displayed, saved and loaded, via the GUI and XPA.</p> + <a href="#RegionDescriptions">Region Descriptions</a><br> + <a href="#RegionProperties">Region Properties</a><br> + <a href="#RegionFileFormat">Region File Format</a><br> + <a href="#CompositeRegion">Composite Region</a><br> + <a href="#TemplateRegion">Template Region</a><br> + <a href="#ExternalRegionFiles">External Region Files</a><br> + <p><b> <a name="RegionDescriptions"></a>Region Descriptions</b></p> + <p><tt>Circle<br> + Usage: circle x y radius<br> + </tt></p> + <p><tt>Ellipse<br> + Usage: ellipse x y radius radius angle<br> + </tt></p> + <p><tt>Box <br> + Usage: box x y width height angle<br> + </tt></p> + <p><tt>Polygon <br> + Usage: polygon x1 y1 x2 y2 x3 y3 ...<br> + </tt></p> + <p><tt>Point <br> + Usage: point x y # + point=[circle|box|diamond|cross|x|arrow|boxcircle] [size]<br> + circle point x y </tt></p> + <p><tt>Line <br> + Usage: line x1 y1 x2 y2 # line=[0|1] [0|1] </tt></p> + <p><tt>Vector <br> + Usage: vector x1 y1 length angle # vector=[0|1] </tt></p> + <p><tt>Text <br> + Usage: text x y # text={Your Text Here}<br> + text x y {Your Text Here} + </tt></p> + <p><tt>Ruler <br> + Usage: ruler x1 y1 x2 y2 # + ruler=[pixels|degrees|arcmin|arcsec]</tt></p> + <p><tt>Compass <br> + Usage: compass x1 y1 length # compass=<coordinate + system> <north label> <east label> [0|1] [0|1] + </tt></p> + <p><tt>Projection <br> + Usage: projection x1 y1 x2 y2 width</tt></p> + <p><tt>Annulus <br> + Usage: annulus x y inner outer n=# <br> + annulus x y r1 r2 r3... </tt></p> + <p><tt>Ellipse Annulus <br> + Usage: ellipse x y r11 r12 r21 r22 n=# [angle]<br> + ellipse x y r11 r12 r21 + r22 r31 r32 ... [angle] </tt></p> + <p><tt>Box Annulus <br> + Usage: box x y w1 h1 w2 h2 [angle] <br> + box x y w1 h1 w2 h2 w3 h3 + ... [angle] </tt></p> + <p><tt>Panda <br> + Usage: panda x y startangle stopangle nangle inner outer + nradius</tt></p> + <p><tt>Epanda <br> + Usage: epanda x y startangle stopangle nangle inner outer + nradius [angle]</tt></p> + <p><tt>Bpanda <br> + Usage: bpanda x y startangle stopangle nangle inner outer + nradius [angle]</tt></p> + <p><tt>Composite<br> + Usage: # composite x y angle</tt></p> + <p><b> <a name="RegionProperties"></a>Region Properties</b></p> + <p>Each region has a number of properties associated with the + region, which indicates how the region is to be rendered or + manipulated. Properties are defined for a region in the comment + section of the region description. The exception is the + Include/Exclude property. It is set via '+' or '-' preceding the + region. In addition, the Line, Point, and Ruler regions have + unique properties, not shared by others. Not all properties are + available via the GUI or are applicable for all regions. </p> + <blockquote> + <p><b> Text</b></p> + <p>All regions may have text associated with them. Use the text + property to set the text. Strings may be quoted with " or ' or + {}. For best results, use {}. Use <tt>textangle</tt> to + specify angle in degress based on current coordinate system + axes.<br> + </p> + <tt>Example: circle(100,100,20) # text={This message has both a + " and ' in it} textangle=30</tt> + <p><b> Color</b></p> + <p>The color property specifies the color of the region when + rendered. DS9 recognizes many symbolic color names (i.e. + "red", "green", "blue", "pink", etc) along with 3, 6, and 9 + digit RGB hex values (#fff, #ffffff, #fffffffff)<br> + </p> + <tt>Example: <br> + circle(100,100,20) # color=green<br> + </tt><tt>circle(100,100,20) # color=#48f</tt> + <p><b>Dash List</b></p> + <p>Sets dashed line parameters. This does not render the region + in dashed lines.</p> + <tt>Example: circle(100,100,20) # dashlist=8 3</tt><br> + <p><b>Width</b></p> + <p>Sets the line width used to render the region.</p> + <tt>Example: circle(100,100,20) # width=2</tt><br> + <p><b>Font</b></p> + <p>The font property specifies the font family, size, weight, + and slant of any text to be displayed along with the region. </p> + <tt>Example: circle(100,100,20) # font="times 12 bold italic"</tt> + <p><b> Can Select</b></p> + <p>The Select property specifies if the user is allowed to + select (hence, edit) the region via the GUI. For Regions used + for catalogs and such, it is desirable that the user is unable + to edit, move, or delete the region.<br> + </p> + <tt>Example: circle(100,100,20) # select=1</tt><br> + <p><b>Can Highlite</b></p> + The Highlite property specifies if the edit handles become + visible when the region is selected.<br> + <tt>Example: circle(100,100,20) # hightlite=1</tt><br> + <p><b>Dash</b></p> + <p>Render region using dashed lines using current <tt>dashlist</tt> + value.</p> + <tt>Example: circle(100,100,20) # dash=1</tt><br> + <p><b>Fixed in Size</b></p> + <p>The Fixed in Size property specifies that the region does not + change in size as the image magnification factor changes. This + allows the user to build complex pointer type regions. </p> + <tt>Example: circle(100,100,20) # fixed=1</tt> + <p><b> Can Edit</b></p> + <p>The Edit property specifies if the user is allowed to edit + the region via the GUI. </p> + <tt>Example: circle(100,100,20) # edit=1</tt> + <p><b> Can Move</b></p> + <p>The Move property specifies if the user is allowed to move + the region via the GUI. </p> + <tt>Example: circle(100,100,20) # move=1</tt> + <p><b> Can Rotate</b></p> + <p>The Rotate property specifies if the user is allowed to + rotate the region via the GUI. </p> + <tt>Example: circle(100,100,20) # rotate=1</tt> + <p><b> Can Delete</b></p> + <p>The Delete property specifies if the user is allowed to + delete the region via the GUI. </p> + <tt>Example: circle(100,100,20) # delete=1</tt> + <p><b> Include/Exclude</b></p> + <p>The Include/Exclude properties flags the region with a + boolean <tt>NOT </tt>for later analysis. Use '+' for include + (default), '-' for exclude. </p> + <tt>Example: -circle(100,100,20)<br> + </tt> + <p><b>Source/Background</b></p> + <p>The Source/Background properties flag the region for use with + other analysis applications. The default is <tt>source</tt></p> + <tt>Example: circle(100,100,20) # source<br> + circle(200,200,10) + # background</tt><br> + <p><b>Tag</b></p> + <p>All regions may have zero or more tags associated with it, + which may be used for grouping and searching. </p> + <tt>Example: circle(100,100,20) # tag={Group 1} tag={Group + 2}</tt> + <p><b> Line</b></p> + <p>The line region may be rendered with arrows, one at each end. + To indicate arrows, use the line property. A '1' indicates an + arrow, '0' indicates no arrow. </p> + <tt>Example: line(100,100,200,200) # line=1 1</tt> + <p><b> Ruler</b></p> + <p>The ruler region may display information in 'pixels', + 'degrees', 'arcmin', or 'arcsec'. Use the ruler property to + indicate which format to display distances in. </p> + <tt>Example: ruler(100,100,200,200) # ruler=arcmin</tt> + <p><b> Point</b></p> + <p>Point regions have an associated type and size. Use the point + property to set the point type. </p> + <tt>Example: point(100,100) # point=diamond 31</tt> + <p><b> Default Properties</b></p> + <p>The default properties are: </p> + <blockquote> <tt>text={}</tt> <br> + <tt>color=green</tt> <br> + <tt>font="helvetica 10 normal roman"</tt> <br> + <tt>select=1</tt> <br> + <tt>edit=1</tt> <br> + <tt>move=1</tt> <br> + <tt>delete=1</tt> <br> + <tt>highlite=1</tt> <br> + <tt>include=1</tt> <br> + <tt>fixed=0</tt> </blockquote> + </blockquote> + <p><b><a name="RegionFileFormat"></a>Region File Format</b></p> + <blockquote> + <p><b> Syntax</b></p> + <p>Region arguments may be separated with either a comma or + space. Optional parentheses may be used a the beginning and + end of a description. </p> + <blockquote> <tt>circle 100 100 10</tt> <br> + <tt>circle(100 100 10)</tt> <br> + <tt>circle(100,100,10)</tt> </blockquote> + <p><b> Comments</b></p> + <p>All lines that begin with <tt>#</tt> are comments and will + be ignored.</p> + <blockquote> <tt># This is a comment</tt> </blockquote> + <p><b> Delimiter</b></p> + <p>All lines may be delimited with either a new-line or + semi-colon. </p> + <blockquote> <tt>circle 100 100 10</tt> <br> + <tt>ellipse 200 200 20 40 ; box 300 300 20 40</tt> </blockquote> + <p><b> Header</b></p> + <p>A DS9 region file may start with the following optional + header: </p> + <blockquote> <tt># Region file format: DS9 version 4.0</tt> </blockquote> + <p><b> Global Properties</b></p> + <p>Global properties affect all regions unless a local property + is specified. The <tt>global</tt> keyword is first, followed + by a list of keyword = value pairs. Multiple global property + lines may be used within a region file. </p> + <blockquote> <tt>global color=green font="helvetica 10 normal + roman" edit=1 move=1 delete=1 highlite=1 include=1 wcs=wcs</tt> + </blockquote> + <p><b> Local Properties</b></p> + <p>Local properties start with a # after a region description + and only affect the region it is specified with. </p> + <blockquote> <tt>physical;circle(504,513,20) # color=red + text={This is a Circle}</tt> </blockquote> + <p><b> Coordinate Systems</b></p> + <p>For each region, it is important to specify the coordinate + system used to interpret the region, i.e., to set the context + in which the position and size values are interpreted. For + this purpose, the following keywords are recognized: </p> + <blockquote> + <blockquote> <tt>PHYSICAL + +# + + + + + + + + + pixel coords of original file using LTM/LTV</tt> <br> + <tt>IMAGE + +# + + + + + + + + + pixel coords of current file</tt> <br> + <tt><tt><tt>FK4,B1950 + + # sky coordinate systems</tt> <br> + FK5,J2000 +# + + + + + + + + + sky coordinate systems</tt> <br> + </tt><tt><tt><tt>ICRS + +# + sky coordinate systems</tt> <br> + </tt>GALACTIC + +# + + + + + + + + + sky coordinate systems</tt> <br> + <tt>ECLIPTIC + +# + + + + + + + + + sky coordinate systems</tt> <br> + <tt>WCS + + # primary WCS<br> + </tt><tt>WCSA + # + secondary WCS<br> + </tt><tt>LINEAR + +# + + + + + + + + + linear primary WCS</tt> <tt><br> + </tt></blockquote> + <tt></tt> </blockquote> + <p><b> Mosaic Images</b></p> + <p>While some coordinate systems are unique across mosaic + images, others coordinate systems, such as <tt>image</tt>, or + <tt>physical</tt> , are valid on a per segment basis. In this + case, use <tt>tile</tt> to specify which header to use in all + coordinate conversions. The default is the first header, or <tt>tile + + + + + + + + 1</tt>. </p> + <tt>Example: tile 2;fk5;point(100,100)</tt> + <p><b> Multiple WCS</b></p> + <p>If an image has multiple wcs's defined, use <tt>wcs#</tt> to + specify which wcs to use for all wcs references. Valid values + are <tt>wcs, wcsa, wcsb, wcsc... wcsz.</tt><br> + <tt>Example: wcsa;linear;point(100,100) # point=diamond</tt></p> + <p><b> Specifying Positions and Sizes</b></p> + <p>The arguments to region shapes can be floats or integers + describing positions and sizes. They can be specified as pure + numbers or using explicit formatting directives: </p> + <blockquote> + <p><b>position arguments</b> </p> + <tt>[num] + +# + + + + + + + + + context-dependent (see below)</tt> <br> + <tt>[num]d + +# + + + + + + + + + degrees</tt> <br> + <tt>[num]r + +# + + + + + + + + + radians</tt> <br> + <tt>[num]p + +# + + + + + + + + + physical pixels</tt> <br> + <tt>[num]i + +# + + + + + + + + + image pixels</tt> <br> + <tt>[num]:[num]:[num] # + hms for 'odd' position arguments</tt> <br> + <tt>[num]:[num]:[num] # + dms for 'even' position arguments</tt> <br> + <tt>[num]h[num]m[num]s # + explicit hms</tt> <br> + <tt>[num]d[num]m[num]s # + explicit dms</tt> + <p><b>size arguments</b> </p> + <tt>[num] + +# + + + + + + + + + context-dependent (see below)</tt> <br> + <tt>[num]" + +# + + + + + + + + + arc sec</tt> <br> + <tt>[num]' + +# + + + + + + + + + arc min</tt> <br> + <tt>[num]d + +# + + + + + + + + + degrees</tt> <br> + <tt>[num]r + +# + + + + + + + + + radians</tt> <br> + <tt>[num]p + +# + + + + + + + + + physical pixels</tt> <br> + <tt>[num]i + +# + + + + + + + + + image pixels</tt> + <p></p> + </blockquote> + <p>When a "pure number" (i.e. one without a format directive + such as 'd' for 'degrees') is specified, its interpretation + depends on the context defined by the 'coordsys' keyword. In + general, the rule is: </p> + <p><i>All pure numbers have implied units corresponding to the + current coordinate system.</i> </p> + <p>If no such system is explicitly specified, the default system + is implicitly assumed to be <tt>PHYSICAL</tt>. In practice + this means that for <tt>IMAGE</tt> and <tt>PHYSICAL</tt> + systems, pure numbers are pixels. Otherwise, for all systems + other than linear, pure numbers are degrees. For <tt>LINEAR</tt> + systems, pure numbers are in the units of the linear system. + This rule covers both positions and sizes. The input values to + each shape can be specified in several coordinate systems + including: </p> + <blockquote> <tt>IMAGE + +# + + + + + + + + + pixel coords of current file</tt> <br> + <br> + <tt>LINEAR + +# + + + + + + + + + linear wcs as defined in file</tt> + <p><tt>FK4, + B1950 + +# + + + + + + + + + sky coordinate systems</tt> <br> + <tt>FK5, J2000</tt> <br> + <tt>GALACTIC</tt> <br> + <tt>ECLIPTIC</tt> <br> + <tt>ICRS</tt> <br> + <tt>PHYSICAL + +# + + + + + + + + + pixel coords of original file using LTM/LTV</tt> <br> + <tt>AMPLIFIER + +# + + + + + + + + + mosaic coords of original file using ATM/ATV</tt> <br> + <tt>DETECTOR + +# + + + + + + + + + mosaic coords of original file using DTM/DTV</tt><br> + <br> + <tt>WCS,WCSA-WCSZ + # specify which WCS system to be + used for <br> + + # + linear and sky coordinate systems<br> + </tt></p> + </blockquote> + <p>If no coordinate system is specified, <tt>PHYSICAL</tt> is + assumed. <tt>PHYSICAL</tt> or a World Coordinate System such + as <tt>J2000</tt> is preferred and most general. The + coordinate system specifier should appear at the beginning of + the region description, on a separate line (in a file), or + followed by a new-line or semicolon; e.g., </p> + <blockquote> <tt>image; circle 100 100 10</tt> <br> + <tt>physical; ellipse 200 200 10 20</tt> <br> + <tt>fk5; point 30 50</tt><br> + <tt>wcsa; fk4; point 202 47</tt><br> + <tt>wcsp; linear; point 100 100</tt><br> + </blockquote> + <p>The use of celestial input units automatically implies WORLD + coordinates of the reference image. Thus, if the world + coordinate system of the reference image is <tt>J2000</tt>, + then</p> + <blockquote> <tt>circle 10:10:0 20:22:0 3'</tt> </blockquote> + <p>is equivalent to: <br> + </p> + <blockquote> <tt>j2000; circle 10:10:0 20:22:0 3'</tt> </blockquote> + <p>Note that by using units as described above, you may mix + coordinate systems within a region specifier; e.g., </p> + <blockquote> <tt>physical; circle 6500 9320 3'<br> + </tt></blockquote> + <p>Note that, for regions which accept a rotation angle such as: + </p> + <blockquote> <tt>ellipse (x, y, r1, r2, angle)<br> + box(x, y, w, h, angle)</tt> + <p></p> + </blockquote> + <p>the angle is relative to the specified coordinate system. In + particular, if the region is specified in WCS coordinates, the + angle is related to the WCS system, not x/y image coordinate + axis. For WCS systems with no rotation, this obviously is not + an issue. However, some images do define an implicit rotation + (e.g., by using a non-zero CROTA value in the WCS parameters) + and for these images, the angle will be relative to the WCS + axes. In such case, a region specification such as:</p> + <blockquote> <tt>fk4;ellipse(22:59:43.985, +58:45:26.92,320", + 160", 30)</tt> </blockquote> + <p>will not, in general, be the same region specified as:</p> + <blockquote> <tt>physical;ellipse(465, 578, 40, 20, 30)</tt> </blockquote> + <p>even when positions and sizes match. The angle is relative to + WCS axes in the first case, and relative to physical x,y axes + in the second.</p> + </blockquote> + <p><b><a name="CompositeRegion"></a>Composite Region</b></p> + <p>A Composite Region is a region which is a collection of other + regions, which share common properties. A composite region is + composed of a center point and a rotation angle, of which all + its members are rendered in reference to. A composite region is + defined by the # composite x y angle declaration followed by a + number of regions who are or'd together. A composite region is + manipulated as a single region within ds9. A composite region + maybe created from the current selection of regions by selecting + the Create Composite Region menu option. Likewise, a composite + region can be dissolved by selecting the Dissolve Composite + Region menu option.</p> + <p><b> <a name="TemplateRegion"></a>Template Region</b></p> + <p>A Template Region is a special form of a region which is saved + in a special wcs coordinate system WCS0. WCS0 indicates that the + ra and dec values are relative to the current WCS location, not + absolute. A template region can be loaded at any location into + any fits image which contains a valid wcs. For example, a user + may create a series of regions, which represent an instrument + template. Then, by selecting the Save As Template menu option, a + template region saved. The user may now load this templated into + any other fits image which contains a valid WCS. </p> + <p><b> <a name="ExternalRegionFiles"></a>External Region Files</b></p> + <p>DS9 can read and write a number of region file formats. Not all + formats support all the functionality of DS9 regions. Therefore, + the user may loose some information when writing and then + reading back from a region file in a format other that DS9. On + output, the regions File Format menu or the <a + href="xpa.html#regions">XPA</a> regions point is used specify + the output coordinate system and format. On input, the menu or + xpa point is used only for the <tt>X Y </tt>format. For all + other formats, the input coordinate system is specified in the + regions file itself. </p> + <blockquote> + <p><b> <a name="FUNTools"></a><a + href="http://hea-www.harvard.edu/RD/funtools/regions.html">Funtools</a></b><tt></tt><br> + </p> + <blockquote> <tt>When using DS9 regions file in FUNTOOLS:<br> + LINE is ignored<br> + </tt> <tt>VECTOR is ignored</tt> <br> + <tt>PROJECTION is ignored<br> + SEGMENT is ignored<br> + TEXT is ignored<br> + </tt> <tt>RULER is ignored</tt><br> + <tt>COMPASS is ignored</tt><br> + </blockquote> + <a name="Ciao"></a>CIAO + <blockquote> <tt><tt>When importing from CIAO into DS9:<br> + POINT is translated into BOX CIRCLE POINT</tt><br> + </tt><tt>ROTBOX is translated into BOX<br> + RECTANGLE is translated into BOX<br> + </tt><tt>PANDA is translated as PIE<br> + SECTOR is ignored<br> + FIELD is ignored</tt><br> + <tt><tt>REGION is ignored<br> + </tt><br> + When exporting from DS9 into CIAO:<br> + </tt> <tt>PANDA is translated into PIE<br> + LINE is ignored</tt><br> + <tt>VECTOR is ignored</tt> <br> + <tt><tt>PROJECTION is ignored</tt><br> + </tt><tt><tt>SEGMENT is ignored<br> + </tt></tt><tt><tt>TEXT is ignored</tt><br> + RULER is ignored</tt><br> + <tt>COMPASS is ignored</tt><br> + <tt>ELLIPSE ANNULUS is ignored</tt><br> + <tt>BOX ANNULUS is ignored</tt><br> + <tt>EPANDA is ignored</tt><br> + <tt>BPANDA is ignored</tt><br> + </blockquote> + <a name="SAOimage"></a><a + href="http://tdc-www.harvard.edu/software/saoimage/saoimage.region.html">SAOimage</a> + <blockquote> <tt><tt><tt>When importing from SAOIMAGE into DS9:<br> + POINT is translated into BOX CIRCLE POINT</tt></tt></tt><br> + <tt><tt><tt><tt>ROTBOX is translated into BOX<br> + </tt></tt> </tt></tt><tt><br> + </tt><tt><tt>When exporting from DS9 into SAOIMAGE:<br> + </tt> </tt><tt><tt><tt>LINE is ignored</tt><br> + <tt>VECTOR is ignored</tt> <br> + <tt><tt>PROJECTION is ignored</tt><br> + </tt><tt><tt>SEGMENT is ignored<br> + </tt></tt><tt><tt>TEXT is ignored</tt><br> + RULER is ignored</tt><br> + <tt>COMPASS is ignored</tt><br> + </tt></tt><tt><tt>ELLIPSE ANNULUS is ignored</tt><br> + <tt>BOX ANNULUS is ignored</tt><br> + PANDA is ignored</tt><br> + <tt>EPANDA is ignored</tt><br> + <tt>BPANDA is ignored</tt><br> + </blockquote> + <a name="IRAFPROS"></a>IRAF PROS + <blockquote> <tt><tt><tt><tt>When importing from PROS into DS9:<br> + POINT is translated into BOX CIRCLE POINT</tt></tt></tt><br> + </tt><tt><tt><tt><tt>ROTBOX is translated into BOX<br> + </tt></tt> </tt></tt><tt><br> + </tt><tt><tt><tt>When exporting from DS9 into SAOIMAGE:<br> + </tt> </tt><tt><tt><tt>LINE is ignored</tt><br> + <tt>VECTOR is ignored</tt> <br> + <tt><tt>PROJECTION is ignored</tt><br> + </tt><tt><tt>SEGMENT is ignored<br> + </tt></tt><tt><tt>TEXT is ignored</tt><br> + RULER is ignored</tt><br> + <tt>COMPASS is ignored</tt><br> + </tt></tt><tt><tt>ELLIPSE ANNULUS is ignored</tt><br> + <tt>BOX ANNULUS is ignored</tt><br> + PANDA is ignored</tt><br> + <tt>EPANDA is ignored</tt><br> + <tt>BPANDA is ignored</tt></tt><br> + </blockquote> + <a name="FITSREGIONBinaryTable"></a>FITS REGION Binary Table + <blockquote> <tt><tt><tt><tt><tt>When importing from FITS + REGION into DS9:<br> + POINT is translated into BOX CIRCLE POINT</tt></tt></tt><br> + </tt><tt><tt><tt><tt>ROTBOX is translated into BOX</tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt>RECTANGLE is translated into BOX</tt><br> + <tt>ROTRECTANGLE is translated into a BOX</tt><br> + <tt>PIE is translated into PANDA<br> + ELLIPTANNULUS is translated into EPANDA<br> + SECTOR is ignored<br> + </tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt>FIELD + + is ignored</tt><br> + </tt><tt>DIAMOND</tt><tt><tt> is ignored<br> + </tt>RHOMBUS</tt><tt><tt> is ignored<br> + </tt>ROTDIAMOND</tt><tt><tt> is ignored<br> + </tt>ROTRHOMBUS</tt><tt> is ignored<br> + </tt> </tt></tt></tt></tt><tt><br> + </tt>DS9 currently can not export into this format.</tt><br> + </blockquote> + <a name="XY"></a>X Y <br> + <p>This format consists of a number of coordinate pairs, one per + line. The coordinate format for both input and output is + specified via the Save Regions Parameters menu or <a + href="xpa.html#regions">XPA</a> regions point. The first two + coordinates are read, the rest of the line is ignored. The + comment character '#' may be used at the beginning of line and + the line is ignored. This format is very useful for reading in + coordinates from other external analysis programs, such as + IRAF. </p> + <blockquote> <tt>Example:</tt> <tt># this is a comment</tt> <br> + <tt>physical # this overrides the specified coordinate system</tt><br> + <tt>300 300</tt> <br> + <tt>400 400 # this is a comment</tt> <br> + </blockquote> + </blockquote> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/samp.html b/ds9/doc/ref/samp.html new file mode 100644 index 0000000..485d76e --- /dev/null +++ b/ds9/doc/ref/samp.html @@ -0,0 +1,6367 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>SAMP</title> + </head> + <body alink="#ff0000" link="#0000ff" vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" align="middle" height="98" + width="100"> SAMP</h3> + <blockquote> + <p>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 <a + href="http://www.ivoa.net/Documents/latest/SAMP.html">here</a>.</p> + <p>The samp implementation for DS9 is based on the <a + href="xpa.html">XPA</a> model with 2 private calls:</p> + <tt> ds9.get<br> + Arguments<br> + cmd (string) required<br> + url (string) optional<br> + Returned value<br> + OK (samp.result map)<br> + value + (string) optional<br> + + url (string) optional<br> + ERROR (samp.error map)<br> + + samp.errortxt (string)<br> + <br> + ds9.set<br> + Arguments<br> + cmd (string) required<br> + url (string) optional<br> + Returned value<br> + OK<br> + ERROR (samp.error map)<br> + + samp.errortxt (string)<br> + </tt> + <p><tt>ds9.set</tt> maybe called via notification, call and + call/wait. <tt>ds9.get</tt> can only be called via call and + call/wait. Most of the <tt>ds9.get</tt> calls return a value + string, but a few will return a url instead.</p> + <tt> <a href="#2mass">2mass</a><br> + <a href="#3d">3d</a><br> + <a href="#about">about</a><br> + <a href="#analysis">analysis</a><br> + <a href="#array">array</a><br> + <a href="#background">background</a><br> + <a href="#backup">backup</a><br> + <a href="#bin">bin</a><br> + <a href="#blink">blink</a><br> + <a href="#block">block</a><br> + <a href="#catalog">catalog</a><br> + <a href="#cd">cd</a><br> + <a href="#cmap">cmap</a><br> + <a href="#colorbar">colorbar</a><br> + <a href="#console">console</a><br> + <a href="#contour">contour</a><br> + <a href="#crop">crop</a><br> + <a href="#crosshair">crosshair</a><br> + <a href="#cube">cube</a><br> + <a href="#cursor">cursor</a><br> + <a href="#data">data</a><br> + <a href="#dsssao">dsssao</a><br> + <a href="#dsseso">dsseso</a><br> + <a href="#dssstsci">dssstsci</a><br> + <a href="#envi">envi</a><br> + <a href="#exit">exit</a><br> + <a href="#export">export</a><br> + <a href="#file">file</a><br> + <a href="#fits">fits</a><br> + <a href="#frame">frame</a><br> + <a href="#gif">gif</a><br> + <a href="#grid">grid</a><br> + <a href="#header">header</a><br> + <a href="#height">height</a><br> + <a href="#iconify">iconify</a><br> + </tt><tt><tt><a href="#iexam">iexam</a><br> + </tt><a href="#iis">iis</a><br> + <a href="#jpeg">jpeg</a><br> + <a href="#lock">lock</a><br> + <a href="#lower">lower</a><br> + <a href="#magnifier">magnifier</a><br> + <a href="#mask">mask</a><br> + <a href="#match">match</a><br> + <a href="#mecube">mecube</a><br> + <a href="#minmax">minmax</a><br> + <a href="#mode">mode</a><br> + <a href="#mosaic">mosaic</a><br> + <a href="#mosaicimage">mosaicimage</a><br> + <a href="#movie">movie</a><br> + <a href="#multiframe">multiframe</a><br> + <a href="#nameserver">nameserver</a><br> + <a href="#nan">nan</a><br> + <a href="#nrrd">nrrd</a><br> + <a href="#nvss">nvss</a><br> + <a href="#orient">orient</a><br> + <a href="#pagesetup">pagesetup</a><br> + <a href="#pan">pan</a><br> + <a href="#pixeltable">pixeltable</a><br> + <a href="#plot">plot</a><br> + <a href="#png">png</a><br> + <a href="#prefs">prefs</a><br> + <a href="#preserve">preserve</a><br> + <a href="#psprint">psprint</a><br> + <a href="#print">print</a><br> + <a href="#exit">quit</a><br> + <a href="#raise">raise</a><br> + <a href="#regions">regions</a><br> + <a href="#restore">restore</a><br> + <a href="#rgb">rgb</a><br> + <a href="#rgbarray">rgbarray</a><br> + <a href="#rgbcube">rgbcube</a><br> + <a href="#rgbimage">rgbimage</a><br> + <a href="#rotate">rotate</a><br> + <a href="#samp">samp</a><br> + <a href="#save">save</a><br> + <a href="#saveimage">saveimage</a><br> + <a href="#scale">scale</a><br> + <a href="#shm">shm</a><br> + </tt><tt><tt><a href="#sia">sia</a><br> + </tt><a href="#single">single</a><br> + <a href="#skyview">skyview</a><br> + <a href="#sleep">sleep</a><br> + <a href="#smooth">smooth</a><br> + <a href="#source">source</a><br> + <a href="#tcl">tcl</a><br> + <a href="#threads">threads</a><br> + <a href="#tiff">tiff</a><br> + <a href="#tile">tile</a><br> + <a href="#update">update</a><br> + <a href="#url">url</a><br> + <a href="#version">version</a><br> + <a href="#view">view</a><br> + <a href="#vla">vla</a></tt><br> + <tt><tt><a href="#vlss">vlss</a><br> + </tt> <a href="#vo">vo</a><br> + <a href="#wcs">wcs</a><br> + <a href="#web">web</a><br> + <a href="#width">width</a><br> + <a href="#zscale">zscale</a><br> + <a href="#zoom">zoom</a><br> + </tt> + <p><b> <a name="2mass"></a>2mass</b></p> + <p>Support for 2MASS Digital Sky Survey.</p> + <tt> Syntax: <br> + 2mass []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> <dec> + degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [survey j|h|k]<br> + [open|close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + 2mass name <br> + 2mass coord <br> + 2mass size<br> + 2mass save<br> + 2mass frame<br> + 2mass survey <br> + ds9.set(string cmd)<br> + 2mass<br> + 2mass m31 <br> + 2mass name m31 <br> + 2mass coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + 2mass size 60 60 arcmin<br> + 2mass save yes<br> + 2mass frame current<br> + 2mass update frame<br> + 2mass survey j<br> + 2mass open<br> + 2mass close<br> + </tt> + <p><b> <a name="3d"></a>3d</b></p> + <p>Support for 3D frame.</p> + <tt> Syntax: <br> + </tt><tt>3d []<br> + [view <az> <el>]<br> + [az <az>]<br> + [el <el>]<br> + [scale <scale>]<br> + [method mip|aip]</tt><br> + <tt><tt> [background none|azimuth|elevation]<br> + </tt> </tt><tt> [border yes|no]<br> + [border color <color>]<br> + </tt><tt> [highlite yes|no]<br> + [hightlite color <color>]<br> + </tt><tt> [open|close]</tt><tt><br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + </tt><tt>3d view<br> + 3d az<br> + 3d el<br> + 3d scale<br> + 3d method</tt><br> + <tt>3d background<br> + </tt><tt>3d border<br> + 3d border color<br> + </tt> <tt> </tt><tt>3d highlite<br> + 3d highlite color<br> + </tt> <tt> ds9.set(string cmd)<br> + </tt><tt>3d # create new 3D frame<br> + 3d view 45 30<br> + 3d az 45<br> + 3d el 30<br> + 3d scale 10<br> + 3d method mip</tt><br> + <tt>3d background azimuth<br> + </tt><tt>3d border yes<br> + 3d border color red<br> + </tt><tt>3d highlite yes<br> + 3d highlite color red<br> + 3d open<br> + 3d close</tt><br> + <p><b><a name="about"></a>about</b></p> + <p>Get DS9 credits.</p> + <tt> Syntax: <br> + about <br> + <br> + Example:<br> + string value = ds9.get(string cmd) <br> + about<br> + </tt> + <p><b> <a name="align"></a>align</b></p> + <p>Controls the World Coordinate System alignment for the current + frame.</p> + <tt> Syntax: <br> + align []<br> + [yes|no]<br> + <br> + Example: <br> + </tt><tt><tt>string value = ds9.get(string cmd) <br> + </tt>align<br> + </tt><tt><tt>ds9.set(string cmd)<br> + </tt>align yes</tt><br> + <p><b> <a name="analysis"></a>analysis</b></p> + <p>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. </p> + <tt> Syntax: <br> + analysis [<task number>]<br> + + [<filename>]<br> + [task <task + number>|<task name>]<br> + [load + <filename>]<br> + [clear]<br> + [clear][load + <filename>]<br> + [message + ok|okcancel|yesno <message>]<br> + [entry + <message>]<br> + [text]</tt><tt><tt><tt><tt><tt><br> + </tt></tt> </tt></tt> <br> + Example:<br> + string value = ds9.get(string cmd) <br> + analysis<br> + analysis task<br> + analysis entry Please enter something<br> + analysis entry okcancel Please enter something<br> + ds9.set(string cmd)<br> + analysis 0 # invoke first analysis task<br> + analysis task 0<br> + analysis task foobar<br> + analysis task {foo bar}<br> + analysis my.ans<br> + analysis load my.ans <br> + analysis clear <br> + analysis clear load my.ans<br> + analysis message ok {This is a message}<br> + analysis text {this is text}</tt><tt><tt><br> + </tt> ds9.set(string cmd, string url)<br> + analysis load <br> + analysis text</tt><b><br> + </b> + <p><b> <a name="array"></a>array</b></p> + <p>Load raw data array into current frame.<br> + </p> + <tt> Syntax:<br> + array [native|big|little]<br> + array [new|mask] +[[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,endian=[little|big]]<br> + <br> + Example: <br> + </tt><tt><tt>string url = ds9.get(string cmd)<br> + </tt>array<br> + array little<br> + </tt><tt><tt>ds9.set(string command, string url)<br> + </tt>array foo.arr[dim=512,bitpix=-32,endian=little]<br> + array new foo.arr[dim=512,bitpix=</tt><tt>-32,endian=little]</tt><br> + <tt><tt>array mask foo.arr[dim=512,bitpix=</tt></tt><tt>-32,endian=little]</tt><tt><br> + </tt> + <p><b> <a name="background"></a>bg<br> + background</b></p> + <p>Set image background color. </p> + <tt> Syntax: <br> + bg <color><br> + <br> + Example:<br> + </tt><tt>string url = ds9.get(string cmd)</tt><tt><br> + bg<br> + </tt><tt>ds9.set(string cmd)<br> + </tt><tt>bg red</tt><tt><br> + <tt>bg red</tt></tt><br> + <p><b> <a name="backup"></a>backup</b></p> + <p>Create a backup save set. </p> + <tt> Syntax: <br> + backup <filename><br> + <br> + Example:<br> + </tt><tt>ds9.set(string cmd)<br> + </tt><tt>backup ds9.bck</tt><br> + <p><b> <a name="bin"></a>bin</b></p> + <p>Controls binning factor, binning buffer size, and binning + function for binning FITS bin tables. The access point blocking + is provided for backward compatibility. </p> + <tt> Syntax: <br> + bin [about <x> <y>]<br> + [about center]<br> + [buffersize <value>] <br> + [cols <x> <y>]<br> + [colsz <x> <y> <z>]<br> + [factor <value> [<vector>]]<br> + [depth <value>] <br> + [filter <string>] <br> + [function average|sum] <br> + [in]<br> + [out]<br> + [to fit] <br> + [match]<br> + [lock [yes|no]]<br> + [open|close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd) <br> + bin about<br> + bin buffersize<br> + bin cols<br> + bin factor<br> + bin depth<br> + bin filter<br> + bin function<br> + bin smooth<br> + bin smooth function<br> + bin smooth radius<br> + bin lock<br> + ds9.set(string cmd)<br> + bin about 4096 4096<br> + bin about center<br> + bin buffersize 512<br> + bin cols detx dety<br> + bin colsz detx dety time<br> + bin factor 4<br> + bin factor 4 2<br> + bin depth 10<br> + bin filter 'pha > 5'<br> + bin filter ''<br> + bin function sum<br> + bin in<br> + bin out<br> + bin to fit<br> + bin match<br> + bin lock yes<br> + bin open<br> + bin close<br> + </tt> + <p><b> <a name="blink"></a>blink</b></p> + <p>Blink mode parameters. Interval is in seconds. <br> + </p> + <tt> Syntax: <br> + blink []<br> + [yes|no]<br> + [interval <value>]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + blink<br> + blink interval<br> + ds9.set(string cmd)<br> + blink<br> + blink yes<br> + blink interval 1</tt><br> + <p><b> <a name="block"></a>block</b></p> + <p>Controls blocking parameters. </p> + <tt> Syntax: <br> + block</tt><tt><tt> [<value>] <br> + [<value> <value>]<br> + [to <value>] <br> + [to <value> + <value>]<br> + [in]<br> + [out]<br> + </tt> [to fit] <br> + [match]<br> + [lock [yes|no]]<br> + [open|close]<br> + <br> + Example: <br> + </tt><tt><tt>string value = ds9.get(string cmd)<br> + </tt>block<br> + block lock<br> + </tt><tt><tt>ds9.set(string cmd)<br> + </tt></tt><tt><tt><tt>block</tt></tt> 4<br> + </tt><tt><tt><tt>block</tt></tt> 4 2<br> + </tt><tt><tt><tt><tt><tt>block</tt></tt> to 4<br> + </tt><tt><tt><tt>block</tt></tt> to 4 2<br> + </tt></tt><tt><tt><tt>block</tt></tt> in<br> + </tt></tt><tt><tt><tt><tt><tt>block</tt></tt> out<br> + </tt></tt></tt><tt><tt><tt>block</tt></tt> to fit<br> + </tt><tt><tt><tt>block</tt></tt> match<br> + </tt><tt><tt><tt>block</tt></tt> lock yes<br> + </tt><tt><tt><tt>block</tt></tt> open<br> + </tt><tt><tt><tt>block</tt></tt> close</tt><tt><br> + </tt> + <p><b> <a name="catalog"></a>catalog<br> + cat<br> + </b></p> + <p>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.</p> + <tt> Syntax:<br> + </tt><tt>catalog []<br> + + [ned|simbad|denis|skybot]<br> + + [ascss|cmc|gsc1|gsc2|gsc3|ac|nomad|ppmx|sao|sdss5|sdss6|</tt><tt>sdss7|sdss8|</tt><tt>tycho|ua2|ub1|ucac2]<br> + [2mass|iras]<br> + [csc|xmm|rosat]<br> + [first|nvss]<br> + + [chandralog|cfhtlog|esolog|stlog|xmmlog]<br> + [cds <catalogname>]<br> + [cds + <catalogid>]<br> + <br> + [load <filename>]<br> + [import sb|tsv + <filename>]<br> + <br> + </tt><tt> [<ref>] [allcols]<br> + </tt><tt> </tt><tt> + [<ref>] [allrows]<br> + </tt><tt> [<ref>] + [cancel]<br> + </tt><tt> [<ref>] + [clear]<br> + </tt><tt> [<ref>] [close]</tt><br> + <tt> [<ref>] + [coordinate <ra> <dec> <coordsys>]</tt><tt><br> + </tt><tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [crosshair]</tt><br> + <tt> [<ref>] [dec + <col>]</tt><br> + <tt> [<ref>] [edit + yes|no]</tt><br> + <tt> [<ref>] + [export sb|tsv <filename>]<br> + </tt><tt> [<ref>] + [filter <string>]<br> + [<ref>] [filter load + <filename>]</tt><br> + <tt> [<ref>] + [header]</tt><br> + <tt> [<ref>] [hide]</tt><br> + <tt> [<ref>] [location + <code>]</tt><br> + <tt> [<ref>] + [match <ref> <ref>]<br> + </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match error <value> degrees|arcmin|arcsec]</tt><br> + <tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match function 1and2|1not2|2not1]<br> + </tt><tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match return 1and2|1only|2only]</tt><br> + <tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match unique yes|no]</tt><br> + <tt> [<ref>] [maxrows + <number>]</tt><br> + <tt> [<ref>] [name + <object>]<br> + </tt><tt> [<ref>] + [panto yes|no]</tt><br> + <tt> [<ref>] [plot + <xcol> <ycol> <xerrcol> <yerrcol>]</tt><br> + <tt> [<ref>] [print]</tt><br> + <tt> [<ref>] [psky + <skyframe>]</tt><br> + <tt> [<ref>] [psystem + <coordsys>]</tt><br> + <tt> [<ref>] [ra + <col>]</tt><br> + <tt> [<ref>] [regions]</tt><br> + <tt> </tt><tt><tt> + [<ref>] [retrieve]</tt><br> + <tt> </tt> [<ref>] + [samp]<br> + [<ref>] [samp + broadcast]<br> + [<ref>] [samp + send <application>]</tt><tt><br> + </tt><tt> [<ref>] + [save <filename>]</tt><br> + <tt> [<ref>] + [server cds|sao|cadc|adac|iucaa|bejing|cambridge|ukirt]</tt><br> + <tt> [<ref>] [show]</tt><br> + <tt> [<ref>] [size + <width> <height> degrees|arcmin|arcsec]</tt><br> + <tt> </tt><tt> [<ref>] + [sky <skyframe>]<br> + </tt><tt> [<ref>] + [skyformat <skyformat>]<br> + </tt><tt> [<ref>] [sort + <col> incr|decr]</tt><br> + <tt> [<ref>] [symbol + [#] + condition|shape|color|text|font|fontsize|fontweight|fontslant + <value>] <br> + </tt><tt> [<ref>] + [symbol [#] text|size|size2|units|angle <value>] <br> + </tt><tt> [<ref>] + [symbol shape {circle point}|{box point}|{diamond point}|<br> + + {cross point}|{x point}|{arrow + point}|{boxcircle point}|<br> + + circle|ellipse|box|text]<br> + [<ref>] [symbol + add| [#] remove]<br> + [<ref>] [symbol + save|load <filename>]</tt><br> + <tt> [<ref>] [system + <coordsys>]</tt><tt><br> + </tt><tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [update]</tt><br> + <tt> [<ref>] [x + <col>]</tt><br> + <tt> [<ref>] [y + <col>]</tt><br> + <tt> <br> + Example:<br> + string value = ds9.get(string cmd) <br> + catalog<br> + catalog header<br> + <br> + ds9.set(string cmd)<br> + </tt><tt>catalog<br> + catalog 2mass<br> + catalog cds 2mass<br> + catalog cds </tt><tt>{I/252}</tt><br> + <tt> <br> + </tt><tt>catalog load foo.xml<br> + catalog import tsv foo.tsv<br> + <br> + </tt><tt>catalog allrows<br> + catalog allcols<br> + </tt><tt>catalog cancel<br> + </tt><tt>catalog clear<br> + </tt><tt>catalog close<br> + </tt><tt>catalog coordinate 202.48 47.21 fk5<br> + </tt><tt>catalog crosshair<br> + </tt><tt>catalog dec DEC<br> + </tt><tt>catalog edit yes<br> + </tt><tt>catalog export tsv bar.tsv<br> + </tt><tt>catalog filter {$Jmag>10}<br> + catalog filter load foo.flt<br> + catalog header<br> + </tt><tt>catalog hide<br> + </tt><tt>catalog location 500</tt><br> + <tt>catalog match error 2 arcsec<br> + catalog match function 1and2<br> + catalog match unique no<br> + catalog match return 1only<br> + catalog match 2mass csc<br> + </tt><tt>catalog maxrows 2000<br> + </tt><tt>catalog name m51<br> + catalog panto no<br> + </tt><tt>catalog plot </tt><tt>{$Jmag} {$Hmag} {$e_Jmag} + {$e_Hmag}</tt><tt><br> + </tt><tt>catalog print</tt><br> + <tt>catalog psky fk5</tt><br> + <tt>catalog psystem wcs</tt><br> + <tt>catalog ra RA</tt><br> + <tt>catalog regions<br> + </tt><tt>catalog retrieve<br> + </tt><tt> </tt><tt>catalog samp broadcast<br> + catalog samp send aladin<br> + catalog save foo.xml<br> + </tt><tt>catalog server sao<br> + </tt><tt>catalog show</tt><br> + <tt> catalog size 1 1 degrees</tt><br> + <tt>catalog symbol condition </tt><tt>{$Jmag>15}</tt><br> + <tt> catalog symbol 2 shape </tt><tt>{boxcircle point}</tt><br> + <tt> catalog symbol color red<br> + catalog symbol font times<br> + </tt><tt>catalog symbol fontsize 14<br> + </tt><tt>catalog symbol fontweight bold<br> + </tt><tt>catalog symbol fontslant italic<br> + </tt><tt>catalog symbol add<br> + catalog symbol 2 remove<br> + catalog symbol load foo.sym<br> + catalog symbol save bar.sym</tt><tt><br> + catalog sky fk5<br> + catalog skyformat degrees<br> + </tt><tt>catalog sort {Jmag} incr<br> + </tt><tt>catalog system wcs</tt><tt><br> + </tt><tt>catalog update<br> + </tt><tt>catalog x RA<br> + catalog y DEC</tt><br> + <p><b><a name="cd"></a>cd</b></p> + <p>Sets/Returns the current working directory. </p> + <tt> Syntax: <br> + cd [<directory>] <br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + cd<br> + ds9.set(string cmd)<br> + cd /home/mrbill<br> + </tt> + <p><b> <a name="cmap"></a>cmap</b></p> + <p>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. </p> + <tt> Syntax: <br> + cmap [<colormap>] <br> + [file]<br> + [load <filename>] <br> + [save <filename>]<br> + [invert yes|no] <br> + [value <constrast> <bias>] + <br> + </tt><tt> [tag [load|save] + <filename>]<br> + [tag delete]</tt><br> + <tt> [match]<br> + [lock [yes|no]]</tt><br> + <tt> [open|close]<br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + cmap <br> + cmap file <br> + cmap invert <br> + cmap value <br> + </tt><tt>cmap lock</tt><br> + <tt> ds9.set(string cmd)<br> + cmap Heat <br> + cmap load foo.sao <br> + cmap save bar.sao<br> + cmap invert yes <br> + cmap value 5 .5<br> + </tt><tt>cmap tag load foo.tag<br> + cmap tag save foo.tag<br> + cmap tag delete</tt><br> + <tt>cmap match<br> + cmap lock yes</tt><br> + <tt> cmap open<br> + cmap close<br> + </tt> + <p><b><a name="colorbar"></a>colorbar</b></p> + <p>Controls colorbar parameters.</p> + <tt> Syntax: <br> + colorbar []<br> + [yes|no]<br> + + [horizontal|vertical]<br> + [orientation + horizontal|vertical]<br> + [numerics + yes|no]<br> + [space + value|distance] <br> + [font + times|helvetica|courier]<br> + [fontsize + <value>]<br> + [fontweight + normal|bold]<br> + [fontslant + roman|italic]<br> + [size]<br> + [ticks]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + colorbar<br> + colorbar orientation<br> + colorbar numerics<br> + colorbar space<br> + colorbar font<br> + colorbar fontsize<br> + colorbar fontweight<br> + colorbar fontslant<br> + colorbar size<br> + colorbar ticks<br> + ds9.set(string cmd)<br> + colorbar yes<br> + colorbar vertical<br> + colorbar orientation vertical<br> + colorbar numerics yes<br> + colorbar space value<br> + colorbar font times<br> + colorbar fontsize 14<br> + colorbar fontwieght bold<br> + colorbar fontslant italic<br> + colorbar size 20<br> + colorbar ticks 11<br> + </tt> + <p><b> <a name="console"></a>console</b></p> + <p>Display tcl console window.</p> + <tt> Syntax: <br> + -console<br> + <br> + Example:<br> + ds9.set(string cmd)<br> + console<br> + </tt> + <p><b> <a name="contour"></a>contour</b></p> + <p>Controls contours in the current frame. </p> + <tt> Syntax: <br> + contour []<br> + [yes|no]<br> + [<coordsys> + [<skyframe>]]<br> + [clear]<br> + [generate]<br> + [load + <filename> [<color> <width> yes|no]]<br> + [save <filename> + <coordsys> <skyframe>]<br> + [convert]<br> + </tt><tt><tt> + [loadlevels <filename>]<br> + </tt></tt><tt><tt><tt> + [savelevels <filename>]<br> + </tt></tt> [copy]<br> + [paste + <coordsys> [<color> <width> yes|no]]<br> + [color <color>]<br> + [width <width>]<br> + [dash yes|no]<br> + [smooth <smooth>]<br> + [method block|smooth]<br> + [nlevels <number of + levels>]<br> + [scale + linear|log|pow|squared|sqrt|asinh|sinh|histequ]<br> + ]scale log exp + <value>]<br> + [mode + minmax|<value>|zscale|zmax]<br> + [limits <min> + <max>]<br> + [levels <value + value value...>] <br> + [open|close]<br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + contour<br> + contour color<br> + contour width<br> + contour dash<br> + contour smooth<br> + contour method<br> + contour nlevels<br> + contour scale<br> + contour log exp<br> + contour mode<br> + contour limits<br> + contour levels<br> + string url = ds9.get(string cmd)<br> + contour wcs fk5<br> + ds9.set(string cmd)<br> + contour<br> + contour yes<br> + contour clear<br> + contour generate<br> + contour load ds9.ctr<br> + contour load ds9.ctr red 2 yes<br> + contour save ds9.con wcs fk5<br> + contour convert<br> + </tt><tt><tt>contour loadlevels ds9.ctr<br> + </tt></tt><tt><tt><tt>contour savelevels ds9.lev<br> + </tt></tt>contour copy<br> + contour paste wcs red 2 no<br> + contour color yellow<br> + contour width 2<br> + contour dash yes<br> + contour smooth 5<br> + contour method smooth<br> + contour nlevels 10<br> + contour scale sqrt<br> + contour log exp 1000<br> + contour mode zscale<br> + contour limits 1 100<br> + contour levels "{1 10 100 1000}"<br> + contour open<br> + contour close<br> + </tt> + <p><b><a name="crop"></a>crop</b> </p> + <p>Set current image display area. </p> + <tt> Syntax: <br> + crop [<x> <y> <width> <height> +[<coordsys>][<skyframe>][<skyformat>][degrees|arcmin|arcsec]<br> + </tt><tt> [match <coordsys>]<br> + [lock <coordsys>|none]</tt><tt><br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + </tt><tt>crop # get crop in physical coords <br> + </tt><tt>crop wcs galactic sexagesimal arcsec<br> + crop lock<br> + </tt><tt>ds9.set(string cmd)</tt><br> + <tt> crop 40 30 10 20 # set crop in physical coords<br> + crop +104:51:06.915 +68:33:40.761 28.144405 22.000204 wcs + galactic arcsec<br> + crop match wcs<br> + crop lock wcs</tt><br> + <p><b> <a name="crosshair"></a>crosshair</b></p> + <p>Controls the current position of the crosshair in the current + frame. DS9 is placed in crosshair mode when the crosshair is + set. </p> + <tt> Syntax: <br> + crosshair [<x> <y> <coordsys> + [<skyframe>][<skyformat>]] <br> + </tt><tt> + [match <coordsys>]<br> + [lock + <coordsys>|none]</tt><br> + <tt> <br> + Example:<br> + string value = ds9.get(string cmd)<br> + crosshair # get crosshair in physical coords <br> + crosshair wcs fk4 sexagesimal # get crosshair in wcs coords <br> + crosshair lock<br> + ds9.set(string cmd)<br> + crosshair 100 100 physical # set crosshair in physical <br> + crosshair 345 58.8 wcs fk5 # set crosshair in wcs coords <br> + crosshair 23:01:00 +58:52:51 wcs fk5<br> + crosshair match wcs<br> + crosshair lock wcs<br> + </tt> + <p><b><a name="cube"></a>cube<br> + </b></p> + <p>Controls FITS cube. </p> + <tt> Syntax: <br> + cube [play|stop|next|prev|first|last]<br> + [<slice> + [<coordsys>][<axis>]]<br> + [interval <numeric>]<br> + [axis <axis>]<br> + </tt><tt> [match <coordsys>]<br> + [lock <coordsys>|none]</tt><br> + <tt> [order 123|132|213|231|312|321]<br> + [axes lock [yes|no]]</tt><br> + <tt> [open|close]<br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + cube<br> + cube interval<br> + cube lock<br> + cube order<br> + cube axes lock<br> + ds9.set(string cmd)<br> + cube play<br> + cube last<br> + cube 3<br> + cube 4.5 wcs 3<br> + cube interval 2<br> + cube axis 3<br> + cube match wcs<br> + cube lock wcs<br> + cube order 123<br> + cube axes lock yes<br> + cube open<br> + cube close</tt><br> + <p><b> <a name="cursor"></a>cursor</b></p> + <p>Move mouse pointer or crosshair in image pixels in the current + frame. Note, this will move selected Regions also. </p> + <tt> Syntax: <br> + cursor [<x> <y>] <br> + <br> + Example:<br> + ds9.set(string cmd)<br> + cursor 10 10<br> + </tt> + <p><b><a name="data"></a>data</b></p> + <p>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.<br> + </p> + <tt> Syntax: <br> + data [<coordsys> [<skyframe>] <x> <y> + <width> <height> [yes|no]]<br> + <br> + Example:<br> + string url = ds9.get(string cmd) <br> + data image 450 520 3 3 yes<br> + data physical 899 1039 6 6 no<br> + data fk5 202.47091 47.196811 0.00016516669 0.00016516669 no<br> + data wcs fk5 13:29:53.018 +47:11:48.52 0.00016516669 + 0.00016516669 no</tt><tt><br> + </tt> + <p><b> <a name="dsssao"></a>dsssao<br> + dss<br> + </b></p> + <p>Support for Digital Sky Survey at SAO. </p> + <tt> Syntax:<br> + dsssao []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> + <dec> degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [open|close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + dsssao name <br> + dsssao coord <br> + dsssao size<br> + dsssao save<br> + dsssao frame<br> + ds9.set(string cmd)<br> + dsssao<br> + dsssao m31 <br> + dsssao name m31 <br> + dsssao coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + dsssao size 60 60 arcmin<br> + dsssao save yes<br> + dsssao frame current<br> + dsssao update frame<br> + dsssao open<br> + dsssao close<br> + </tt> + <p><b> <a name="dsseso"></a>dsseso</b></p> + <p>Support for Digital Sky Survey at ESO. </p> + <tt> Syntax:<br> + dsseso []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> + <dec> degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [survey + DSS1|DSS2-red|DSS2-blue|DSS2-infrared]<br> + [open|close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + dsseso name <br> + dsseso coord <br> + dsseso size<br> + dsseso save<br> + dsseso frame<br> + dsseso survey<br> + ds9.set(string cmd)<br> + dsseso<br> + dsseso m31 <br> + dsseso name m31 <br> + dsseso coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + dsseso size 60 60 arcmin<br> + dsseso save yes<br> + dsseso frame current<br> + dsseso update frame<br> + dsseso survey DSS2-red <br> + dsseso open<br> + dsseso close<br> + </tt> + <p><b> <a name="dssstsci"></a>dssstsci</b></p> + <p>Support for Digital Sky Survey at STSCI.</p> + <tt> Syntax:<br> + dssstsci []<br> + [<object>]<br> + [name <object>]<br> + [coord + <ra> <dec> degrees|sexagesimal] # in wcs fk5<br> + [size + <width> <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame + new|current]<br> + [update + frame|crosshair]<br> + [survey + poss2ukstu_red|poss2ukstu_ir|poss2ukstu_blue] <br> + [survey + poss1_blue|poss1_red]<br> + [survey + all|quickv|phase2_gsc2|phase2_gsc1]<br> + [open|close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + dssstsci name <br> + dssstsci coord <br> + dssstsci size<br> + dssstsci save<br> + dssstsci frame<br> + dssstsci survey<br> + ds9.set(string cmd)<br> + dssstsci<br> + dssstsci m31 <br> + dssstsci name m31 <br> + dssstsci coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + dssstsci size 60 60 arcmin<br> + dssstsci save yes<br> + dssstsci frame current<br> + dssstsci update frame<br> + dssstsci survey all<br> + dssstsci open<br> + dssstsci close</tt><br> + <p><b> <a name="envi"></a>envi</b></p> + <p>Load an ENVI header and file. Optional parameter: array endian.<br> + </p> + <tt> Syntax: <br> + envi <header> [<filename>]<br> + <br> + Example:<br> + </tt><tt><tt>envi foo.hdr</tt></tt><br> + <tt><tt><tt><tt><tt><tt>envi foo.hdr foo.bsq</tt></tt><br> + envi new foo.hdr foo.bsq</tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><br> + </tt></tt></tt></tt></tt></tt> + <p><b> <a name="exit"></a>exit<br> + quit<br> + </b></p> + <p>Quits DS9. </p> + <tt> Syntax: <br> + exit<br> + quit<br> + <br> + Example:<br> + ds9.set(string cmd)<br> + exit</tt><br> + <p><b> <a name="export"></a>export<br> + </b></p> + <p>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.</p> + <tt> Syntax: </tt><tt><br> + </tt><tt> export </tt><tt>[array|nrrd|envi|gif|tiff|jpeg|png] </tt><tt><filename></tt><tt><br> + </tt><tt>export array <filename></tt><tt> </tt><tt>[big|little</tt><tt>|native]</tt><tt><br> + </tt><tt>export nrrd <filename> </tt><tt>[big|little</tt><tt>|native]</tt><br> + <tt>export envi <header> [<filename>] </tt><tt>[big|little</tt><tt>|native]</tt><tt><br> + </tt><tt> </tt><tt>export jpeg <filename></tt><tt> [1-100]</tt><tt><br> + </tt><tt> </tt><tt>export tiff <filename</tt><tt>></tt><tt> + [none|jpeg|packbits|deflate]</tt><br> + <tt> <br> + Example: <br> + </tt><tt><tt><tt>ds9.set (string cmd)<br> + </tt>export array foo.arr little</tt></tt><br> + <tt><tt>export nrrd foo.nrrd little<br> + export envi foo.hdr little<br> + export envi foo.hdr foo.bsq little<br> + </tt></tt> <tt><tt><tt><tt>export tiff foo.tiff jpeg</tt></tt></tt><br> + export jpeg foo.jpeg 75<br> + export png foo.png</tt><br> + <p><b> <a name="file"></a>file</b></p> + <p>Query currently loaded file information. </p> + <tt> Syntax:<br> + file <br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + file</tt><tt><br> + </tt> + <p><b> <a name="fits"></a>fits</b></p> + <p>Load a FITS image into the current frame or query the currently + loaded image.<br> + </p> + <tt> Syntax: <br> + fits </tt><tt><tt>[new|mask|slice] [<filename>]</tt><tt><br> + </tt> [width|height|depth|bitpix|type]<br> + [size [wcs|wcsa...wcsz] + [fk4|fk5|icrs|galactic|ecliptic] [degrees|arcmin|arcsecs]]<br> + [header [<ext>] [keyword + <string>]]<br> + [image|table|slice]</tt><tt><br> + <br> + Example: </tt><br> + <tt><tt>string value = ds9.get(string cmd)</tt><br> + fits<br> + fits width<br> + fits height<br> + fits depth<br> + fits bitpix</tt><br> + <tt>fits type </tt><br> + <tt><tt>fits size<br> + </tt> fits size wcs fk5 arcmin<br> + fits header # primary<br> + fits header 2 # hdu 2<br> + fits header -2 # hdu 2 with inherit<br> + fits header keyword "'BITPIX'"<br> + fits header 1 keyword "'BITPIX'"</tt><br> + <tt><tt>fits image<br> + fits table</tt></tt><tt><br> + fits slice<br> + ds9.set(string cmd, string url)</tt><tt><tt><br> + </tt> fits foo.fits<br> + fits new foo.fits<br> + fits bar.fits[bin=detx,dety]<br> + fits slice foo.fits<br> + fits mask foo.fits<br> + fits <br> + fits new<br> + fits -[bin=detx,dety]<br> + fits slice<br> + fits mask</tt> + <p>Syntax: <br> + </p> + <tt> fits [size|width|height|depth|bitpix]<br> + [size [wcs|wcsa...wcsz] + [fk4|fk5|icrs|galactic|ecliptic] [degrees|arcmin|arcsecs]]<br> + [type]<br> + [header [<ext>] [keyword + <string>]]<br> + [image|table|resample] [gz] <br> + [new|mask][<options>]<br> + [new][slice <options>]<br> + [new][mecube <options>]<br> + [new|mask][mosaicimage + [iraf|wcs|wcsa...wcsz|wfpc2] <options>]<br> + [new|mask][mosaic + [iraf|wcs|wcsa...wcsz] <options>]<br> + [new][rgbcube <options>]<br> + [new][rgbimage <options>]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + fits size<br> + fits width<br> + fits height<br> + fits depth<br> + fits bitpix<br> + fits size wcs fk5 arcmin<br> + fits type <br> + fits header keyword BITPIX<br> + fits header 1 keyword BITPIX<br> + string url = ds9.get(string cmd)<br> + fits<br> + fits image<br> + fits image gz<br> + fits table<br> + fits table gz<br> + fits resample<br> + fits resample gz<br> + fits header # primary<br> + fits header 2 # hdu 2<br> + fits header -2 # hdu 2 with inherit<br> + ds9.set(string cmd, string url)<br> + fits <br> + fits [2] <br> + fits new [bin=detx,dety]<br> + fits slice<br> + fits mecube <br> + fits mosaicimage iraf<br> + fits mosaicimage wcs<br> + fits mosaicimage wcsa<br> + fits mosaicimage wfpc2<br> + fits mosaic iraf<br> + fits mosaic wcs<br> + fits rgbcube<br> + fits rgbimage </tt> + <p><b> <a name="frame"></a>frame</b></p> + <p>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. </p> + <tt> Syntax: <br> + frame [center [#|all]]<br> + [clear [#|all]]<br> + [new [rgb|3d]]<br> + [delete [#|all]] <br> + [reset [#|all]]<br> + [refresh [#|all]]<br> + [hide [#|all]]<br> + [show [#|all]]<br> + [move first]<br> + [move back]<br> + [move forward]<br> + [move last]<br> + [first]<br> + [prev]<br> + [next]<br> + [last]<br> + [frameno #]<br> + [#]<br> + [match <coordsys>]<br> + [lock <coordsys>|none]<br> + [has +[amplifier|datamin|datasec|detector|grid|iis|irafmin|physical|smooth]]<br> + [has contour [aux]]]<br> + [has fits [ |bin|cube|mosaic]]<br> + [has marker + [highlite|paste|select|undo]]<br> + [has system <coordsys>]<br> + [has wcs + [<wcssys>|equatorial <wcssys>|linear + <wcssys>]]<br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + frame # returns the id of the current frame <br> + frame frameno # returns the id of the current frame <br> + frame all # returns the id of all frames <br> + frame active # returns the id of all active frames<br> + frame lock<br> + frame has amplifier<br> + frame has datamin<br> + frame has datasec<br> + frame has detector<br> + frame has grid<br> + frame has iis<br> + frame has irafmin<br> + frame has physical<br> + frame has smooth<br> + frame has contour<br> + frame has contour aux<br> + frame has fits<br> + frame has fits bin<br> + frame has fits cube<br> + frame has fits mosaic<br> + frame has marker highlite<br> + frame has marker paste<br> + frame has marker select<br> + frame has marker undo<br> + frame has system physical<br> + frame has wcs wcsa<br> + frame has wcs equatorial wcsa<br> + frame has wcs linear wcsa<br> + ds9.set(string cmd)<br> + frame center # center current frame<br> + frame center 1 # center 'Frame1' <br> + frame center all # center all frames <br> + frame clear # clear current frame<br> + frame new # create new frame <br> + frame new rgb # create new rgb frame<br> + frame delete # delete current frame <br> + frame reset # reset current frame <br> + frame refresh # refresh current frame <br> + frame hide # hide current frame <br> + frame show 1 # show frame 'Frame1'<br> + frame move first # move frame to first in order<br> + frame move back # move frame back in order<br> + frame move forward # move frame forward in order<br> + frame move last # move frame to last in order<br> + frame first # goto first frame <br> + frame prev # goto prev frame <br> + frame next # goto next frame<br> + frame last # goto last frame<br> + frame frameno 4 # goto frame 'Frame4', create if needed<br> + frame 3 # goto frame 'Frame3', create if needed <br> + frame match wcs<br> + frame lock wcs</tt><br> + <p><b> <a name="gif"></a>gif</b></p> + <p>Load GIF image into current frame.<br> + </p> + <tt> Syntax:<br> + gif [new|slice] [<filename>]<br> + <br> + Example: <br> + </tt><tt><tt>string value = ds9.get(string cmd)<br> + </tt>gif</tt><br> + <tt><tt>ds9.set(string cmd)<br> + </tt>gif foo.gif</tt><br> + <tt><tt>gif new foo.gif<br> + </tt></tt><tt><tt><tt>gif slice foo.gif<br> + </tt></tt>gif</tt><br> + <tt><tt>gif</tt><tt> new<br> + </tt>gif</tt><tt> slice</tt> + <p><b> <a name="grid"></a>grid</b></p> + <p> Controls coordinate grid. For grid numeric format + syntax, click <a href="grid.html#Format">here</a>.</p> + <tt> Syntax: <br> + grid []<br> + [yes|no] <br> + [type analysis|publication] <br> + [system <coordsys>] <br> + [sky <skyframe>] <br> + [skyformat <skyformat>]<br> + [grid yes|no]<br> + [grid color <color>]<br> + [grid width <value>]<br> + [grid style 0|1]<br> + [grid gap1 <value>]<br> + [grid gap2 <value>]<br> + [axes yes|no]<br> + [axes color <color>]<br> + [axes width <value>]<br> + [axes style 0|1]<br> + [axes type interior|exterior]<br> + </tt><tt> [axes origin + lll|llu|lul|luu|ull|ulu|uul|uuu]</tt><br> + <tt> [format1 <format>]<br> + [format2 <format>]<br> + [tickmarks yes|no]<br> + [tickmarks color <color>]<br> + [tickmarks width <value>]<br> + [tickmarks style 0|1]<br> + [border yes|no]<br> + [border color <color>]<br> + [border width <value>]<br> + [border style 0|1]<br> + [numerics yes|no]<br> + [numerics font + times|helvetica|courier]<br> + [numerics fontsize <value>]<br> + [numerics fontweight normal|bold]<br> + [numerics fontslant roman|italic]<br> + [numerics color <color>]<br> + [numerics gap1 <value>]<br> + [numerics gap2 <value>]<br> + [numerics type interior|exterior]<br> + [numerics vertical yes|no]<br> + [title yes|no]<br> + [title text <text>]<br> + [title def yes|no]<br> + [title gap <value>]<br> + [title font + times|helvetica|courier]<br> + [title fontsize <value>]<br> + [title fontweight normal|bold]<br> + [title fontslant roman|italic]<br> + [title color <color>]<br> + [labels yes|no]<br> + [labels text1 <text>]<br> + [labels def1 yes|no]<br> + [labels gap1 <value>]<br> + [labels text2 <text>]<br> + [labels def2 yes|no]<br> + [labels gap2 <value>]<br> + [labels font + times|helvetica|courier]<br> + [labels fontsize <value>]<br> + [labels fontweight normal|bold]<br> + [labels fontslant roman|italic]<br> + [labels color <color>]<br> + [reset]<br> + [load <filename>] <br> + [save <filename>] <br> + [open|close]<br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + grid <br> + grid type <br> + grid system <br> + grid sky <br> + grid skyformat <br> + grid grid <br> + grid grid color <br> + grid grid width <br> + grid grid style <br> + grid grid gap1 <br> + grid grid gap2 <br> + grid axes <br> + grid axes color <br> + grid axes width <br> + grid axes style <br> + grid axes type <br> + grid axes origin<br> + grid format1<br> + grid format2<br> + grid tickmarks <br> + grid tickmarks color <br> + grid tickmarks width <br> + grid tickmarks style <br> + grid border <br> + grid border color <br> + grid border width <br> + grid border style <br> + grid numerics <br> + grid numerics font <br> + grid numerics fontsize <br> + grid numerics fontweight<br> + grid numerics fontslant<br> + grid numerics color <br> + grid numerics gap1 <br> + grid numerics gap2 <br> + grid numerics type <br> + grid numerics vertical <br> + grid title <br> + grid title text<br> + grid title def <br> + grid title gap <br> + grid title font <br> + grid title fontsize <br> + grid title fontweight<br> + grid title fontslant<br> + grid title color <br> + grid labels <br> + grid labels text1 <br> + grid labels def1 <br> + grid labels gap1 <br> + grid labels text2 <br> + grid labels def2 <br> + grid labels gap2 <br> + grid labels font <br> + grid labels fontsize <br> + grid labels fontweight<br> + grid labels fontslant<br> + grid labels color <br> + ds9.set(string cmd)<br> + grid <br> + grid yes<br> + grid type analysis <br> + grid system wcs <br> + grid sky fk5 <br> + grid skyformat degrees<br> + grid grid yes<br> + grid grid color red<br> + grid grid width 2<br> + grid grid style 1<br> + grid grid gap1 10<br> + grid grid gap2 10<br> + grid axes yes<br> + grid axes color red<br> + grid axes width 2<br> + grid axes style 1<br> + grid axes type exterior<br> + grid axes origin lll<br> + grid format1 d.2<br> + grid format2 d.2<br> + grid tickmarks yes<br> + grid tickmarks color red<br> + grid tickmarks width 2<br> + grid tickmarks style 1<br> + grid border yes<br> + grid border color red<br> + grid border width 2<br> + grid border style 1<br> + grid numerics yes<br> + grid numerics font courier<br> + grid numerics fontsize 12<br> + grid numerics fontweight bold<br> + grid numerics fontslant italic<br> + grid numerics color red<br> + grid numerics gap1 10<br> + grid numerics gap2 10<br> + grid numerics type exterior<br> + grid numerics vertical yes<br> + grid title yes<br> + grid title text {Hello World}<br> + grid title def yes<br> + grid title gap 10<br> + grid title fontsize 12<br> + grid title font courier<br> + grid title fontweight bold<br> + grid title fontslant italic<br> + grid title color red<br> + grid labels yes<br> + grid labels text1 {Hello World}<br> + grid labels def1 yes<br> + grid labels gap1 10<br> + grid labels text2 {Hello World}<br> + grid labels def2 yes<br> + grid labels gap2 10<br> + grid labels font courier<br> + grid labels fontsize 12<br> + grid labels fontweight bold<br> + grid labels fontslant italic<br> + grid labels color red<br> + grid reset<br> + grid load foo.grd <br> + grid save foo.grd<br> + grid open<br> + grid close<br> + </tt> + <p><b> <a name="header"></a>header</b></p> + <p>Display current fits header dialog. Optional extension number + maybe specified. Please note, this differs from samp fits + header.</p> + <tt> Syntax: <br> + header [<ext>]<br> + [close [<ext>]]<br> + [save [<ext>] + <filename>]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + header<br> + header 2<br> + header close<br> + </tt> + <p><b> <a name="height"></a>height</b></p> + <p>Set the height of the image display window. </p> + <tt> Syntax: <br> + height [<value>]<br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + height<br> + ds9.set(string cmd)<br> + height 512<br> + </tt> + <p><b> <a name="iconify"></a>iconify</b></p> + <p>Toggles iconification. </p> + <tt> Syntax: <br> + iconify []<br> + [yes|no] <br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + iconify <br> + ds9.set(string cmd)<br> + iconify<br> + iconify yes</tt><br> + <p><b><a name="iexam"></a>iexam</b></p> + <p>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 + <tt>button</tt>. In the last form, the following macros will be + expanded if present: <tt>$width, $height, $depth, $bitpix, + $filename, $regions, $filename[$regions], $env, $pan, $value, + $x, $y, $z.</tt> See <a + href="file:///Users/joye/saods9/doc/ref/analysis.html#macros">Analysis + + + + + + + + + + + + + + + + + + + + + + + + Macros</a> for more information.</p> + <tt> Syntax: <br> + iexam []<br> + </tt><tt><tt> [[]|button|key|any] + coordinate <coordsys> [<skyframe>] + [<skyformat>]<br> + [[]|button|key|any] data + [width][height]<br> + </tt><tt><tt> [[]|button|key|any] + <macro string>]<br> + </tt></tt><br> + Example:<br> + string value = ds9.get(string cmd)<br> + </tt><tt><tt>iexam<br> + </tt>iexam coordinate image<br> + iexam key coordinate image # return coordinate and key event<br> + iexam coordinate wcs fk5 degrees<br> + iexam coordinate wcs galactic sexagesimal<br> + iexam coordinate fk5<br> + iexam data # return data value<br> + iexam key data # return data value and key event<br> + iexam data 3 3 # return all data in 3x3 box about selected point<br> + iexam {Click at $x,$y in file $filename}</tt><br> + <p><b><a name="iis"></a>iis</b></p> + <p>Set/Get IIS Filename. Optional mosaic number maybe supplied.</p> + <tt> Syntax: <br> + iis [filename <filename> [#]]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + iis filename<br> + iis filename 4<br> + ds9.set(string cmd)<br> + iis filename foo.fits<br> + iis filename bar.fits 4</tt><br> + <p><b> <a name="jpeg"></a>jpeg</b></p> + <p>Load JPEG image into current frame. Optional parameters: <tt>jpeg + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </tt>quality (1-100) </p> + <tt> Syntax:<br> + jpeg [new|slice] [<filename>] [1-100]<br> + <br> + Example: <br> + </tt><tt><tt>string value = ds9.get(string cmd)<br> + </tt>jpeg</tt><br> + <tt><tt>jpeg 100</tt><br> + </tt><tt><tt>ds9.set(string cmd)<br> + </tt>jpeg foo.jpeg</tt><br> + <tt><tt>jpeg new foo.jpeg<br> + </tt></tt><tt><tt><tt>jpeg slice foo.jpeg<br> + </tt></tt>jpeg</tt><br> + <tt><tt>jpeg</tt><tt> new<br> + </tt>jpeg</tt><tt> slice</tt> + <p><b> <a name="lock"></a>lock</b></p> + <p>Lock all other frames to the current frame. </p> + <tt> Syntax: <br> + </tt><tt>lock</tt><tt> </tt><tt>[frame <coordsys>|none]<br> + </tt><tt>[crosshair + <coordsys>|none] </tt><tt><br> + </tt><tt> [crop <coordsys>|none]</tt><br> + <tt> [slice <coordsys>|none]</tt><br> + <tt> </tt><tt> [bin [yes|no]]<br> + [axes [yes|no]]<br> + [scale [yes|no]]<br> + [scalelimits [yes|no]]<br> + [colorbar [yes|no]]<br> + [block [yes|no]]<br> + [smooth [yes|no]]</tt><tt><br> + </tt><tt> </tt><tt><br> + Example:<br> + </tt><tt>string value = ds9.get(string cmd) <br> + </tt><tt>lock frame<br> + lock crosshair<br> + </tt><tt>lock crop</tt><br> + <tt> lock slice</tt><br> + <tt>lock bin<br> + lock axes<br> + lock scale<br> + lock scalelimits<br> + lock color</tt><tt>bar<br> + lock block<br> + lock smooth<br> + </tt><tt>ds9.set(string cmd)<br> + </tt><tt>lock frame wcs</tt><tt><br> + </tt><tt>lock crosshair wcs<br> + </tt><tt>lock crop wcs</tt><br> + <tt>lock slice wcs</tt><br> + <tt>lock bin yes<br> + lock axes yes<br> + </tt><tt>lock scale yes<br> + lock scalelimits yes<br> + </tt><tt>lock colorbar yes</tt><tt><br> + lock block yes<br> + lock smooth yes<br> + <br> + </tt><b><a name="lower"></a>lower</b> + <p>Lower in the window stacking order. </p> + <tt> Syntax: <br> + lower <br> + <br> + Example: <br> + ds9.set(string cmd)<br> + lower</tt><tt><br> + </tt> + <p><b> <a name="magnifier"></a>magnifier</b></p> + <p>Controls the magnifier settings. </p> + <tt> Syntax: <br> + magnifier [color <color>]<br> + [zoom + <value>]<br> + [cursor + yes|no]<br> + [region + yes|no]<br> + <br> + Example:<br> + string value = ds9.get(string cmd) <br> + magnifier color<br> + magnifier zoom<br> + magnifier cursor<br> + magnifier region<br> + ds9.set(string cmd)<br> + magnifier color yellow<br> + magnifier zoom 2<br> + magnifier cursor no<br> + magnifier region no<br> + </tt> + <p><b><a name="mask"></a>mask<br> + </b></p> + <p>Controls mask parameters. </p> + <tt> Syntax: <br> + mask [color <color>]<br> + [mark 1|0]<br> + [transparency <value>]<br> + [clear]<br> + [open|close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + mask color<br> + mask mark<br> + mask transparency<br> + ds9.set(string cmd)<br> + mask color red<br> + mask mark 0<br> + mask transparency 50<br> + mask clear<br> + mask open<br> + mask close<br> + </tt> + <p><b> <a name="match"></a>match</b></p> + <p>Match all other frames to the current frame. </p> + <tt> Syntax: <br> + </tt><tt>match </tt><tt>[frame <coordsys>]<br> + </tt><tt>[crosshair + <coordsys>] </tt><tt><br> + </tt><tt> [crop <coordsys>]<br> + </tt><tt> [slice <coordsys>]<br> + </tt><tt> [bin]<br> + [axes]<br> + [scale]<br> + [scalelimits]<br> + [colorbar]<br> + [block]<br> + [smooth]</tt><tt><br> + </tt><tt> <br> + Example:<br> + ds9.set(string cmd)<br> + </tt><tt>match frame wcs <br> + </tt><tt>match crosshair wcs<br> + </tt><tt>match crop wcs</tt><br> + <tt> match slice wcs<br> + match bin<br> + match axes<br> + match scale<br> + match scalelimits<br> + match color</tt><tt>bar<br> + match block<br> + match smooth</tt><br> + <p><b> <a name="mecube"></a>mecube</b></p> + <p>Load FITS multiple extension file as data cube.<br> + </p> + <tt> Syntax:<br> + mecube [new] [<filename>]<br> + <br> + Example: </tt><br> + <tt>string value = ds9.get(string cmd)</tt><tt><tt><br> + </tt>mecube<br> + </tt><tt><tt><tt>ds9.set(string cmd)<br> + </tt></tt>mecube foo.fits</tt><br> + <tt><tt>mecube new foo.fits<br> + </tt>mecube</tt><br> + <tt>mecube</tt><tt> new</tt> + <p><b> <a name="minmax"></a>minmax</b></p> + <p>This is how DS9 determines the min and max data values + from the data. <tt>SCAN</tt> will scan all data.</p> + <tt> Syntax: <br> + minmax [scan|sample|datamin|irafmin] <br> + [mode + scan|sample|datamin|irafmin]<br> + [interval #]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + minmax mode<br> + minmax sample <br> + ds9.set(string cmd)<br> + minmax scan <br> + minmax mode scan<br> + minmax interval 100<br> + </tt> + <p><b> <a name="mode"></a>mode</b></p> + <p>Controls the first mouse button mode. </p> + <tt> Syntax: <br> + mode + [none|region|crosshair|colorbar|pan|zoom|rotate|catalog|examine] + <br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + mode <br> + ds9.set(string cmd)<br> + mode crosshair</tt><br> + <p><b> <a name="mosaic"></a>mosaic</b></p> + <p>Load FITS mosaic segment into current frame.</p> + <tt> Syntax:<br> + mosaic [wcs|wcsa...wcsz|iraf] [new|mask] [<filename>]<br> + <br> + Example: <br> + </tt><tt><tt>string value = ds9.get(string cmd)<br> + </tt>mosaic</tt><tt><br> + </tt><tt><tt>ds9.set(string cmd)<br> + </tt>mosaic foo.fits</tt><br> + <tt><tt>mosaic wcs foo.fits</tt></tt><br> + <tt><tt>mosaic wcs new foo.fits</tt></tt><br> + <tt><tt>mosaic wcs mask foo.fits</tt></tt><tt><tt><tt><br> + </tt></tt>mosaic</tt><br> + <tt><tt>mosaic wcs<br> + mosaic wcs</tt><tt> new<br> + </tt>mosaic wcs</tt><tt> mask<br> + </tt> + <p><b> <a name="mosaicimage"></a>mosaicimage</b></p> + <p>Load FITS mosaic image into current frame.</p> + <tt> Syntax:<br> + mosaicimage [wcs|wcsa...wcsz|iraf|wfpc2] [new|mask] + [<filename>]<br> + <br> + Example: <br> + </tt><tt><tt>string value = ds9.get(string cmd)<br> + </tt>mosaicimage</tt><tt><br> + </tt><tt><tt>ds9.set(string cmd)<br> + </tt>mosaicimage foo.fits</tt><br> + <tt><tt>mosaicimage wcs foo.fits</tt></tt><br> + <tt><tt>mosaicimage wcs new foo.fits</tt></tt><br> + <tt><tt>mosaicimage wcs mask foo.fits</tt></tt><tt><tt><tt><br> + </tt></tt>mosaicimage</tt><br> + <tt><tt>mosaicimage wcs<br> + mosaicimage wcs new</tt><tt><br> + </tt>mosaicimage wcs mask</tt> + <p><b><a name="movie"></a>movie</b></p> + <p>Create mpeg1 movie from snap shots of the DS9 window. A <tt>slice</tt> + movie cycles though all slices of a cube. A <tt>frame</tt> + movie cycles through all active frames. A <tt>3d</tt> movie + cycles through specified viewing angles. The default is <tt>frame</tt>. + Optional parameters for <tt>3d</tt>: number of frames, azimuth + from/to, elevation from/to, slice from/to, oscillate/repeat + times.</p> + <tt> Syntax:<br> + movie </tt><tt>[slice|frame|3d] </tt><tt><filename><br> + </tt><tt>movie 3d <filename> + [number|azfrom|azto|elfrom|elto|slfrom|slto|oscillate|repeat + <#>]</tt><br> + <tt> <br> + Example:<br> + ds9.set(string cmd)<br> + movie slice ds9.mpg<br> + </tt><tt>movie 3d ds9.mpg number 10 azfrom -60 azto 60 oscillate 1</tt><br> + <p><b> <a name="multiframe"></a>multiframe</b></p> + <p>Load FITS multiple extension file as multiple images.<br> + </p> + <tt> Syntax:<br> + multiframe [<filename>]<br> + <br> + Example: <br> + </tt><tt><tt>ds9.set(string cmd)<br> + </tt>multiframe foo.fits</tt><tt><tt><br> + </tt>multiframe</tt><br> + <p><b> <a name="nameserver"></a>nameserver</b></p> + <p>Support Name Server functions. Coordinates are in fk5. </p> + <tt> Syntax: <br> + nameserver [<object>] <br> + + [name <object>]<br> + + [server ned-sao|ned-eso|simbad-sao|simbad-eso]<br> + + [skyformat degrees|sexagesimal]<br> + + [pan]<br> + + [crosshair]<br> + [close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + nameserver<br> + nameserver server<br> + nameserver skyformat<br> + nameserver m31<br> + ds9.set(string cmd)<br> + nameserver m31 <br> + nameserver name m31 <br> + nameserver server ned-sao <br> + nameserver skyformat sexagesimal<br> + nameserver pan<br> + nameserver crosshair<br> + nameserver open<br> + nameserver close<br> + </tt> + <p><b> <a name="nan"></a>nan</b></p> + <p>Set image not-a-number color. </p> + <tt> Syntax: <br> + nan <color><br> + <br> + Example:<br> + </tt><tt>string value = ds9.get(string cmd)<br> + nan</tt><br> + <tt>ds9.set(string cmd)<br> + nan red</tt><br> + <p><b> <a name="nrrd"></a>nrrd</b></p> + <p>Load an NRRD (Nearly Raw Raster Data) file. Optional parameter: + array endian.<br> + </p> + <tt> Syntax: <br> + nrrd [<filename>] [little|big]<br> + <br> + Example:<br> + </tt><tt><tt>string value = ds9.get(string cmd)<br> + </tt>nrrd</tt><br> + <tt><tt>nrrd big<br> + </tt></tt><tt><tt><tt>ds9.set(string cmd</tt><tt>, string url</tt><tt>)<br> + </tt>nrrd foo.nrrd</tt></tt><br> + <tt><tt><tt><tt>nrrd new foo.nrrd</tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt>nrrd mask foo.nrrd<br> + </tt></tt></tt></tt></tt>nrrd</tt><br> + <tt>nrrd</tt><tt> new<br> + nrrd mask</tt><br> + <p><b> <a name="nvss"></a>nvss</b></p> + <p>Support for NRAO VLA Sky Survey.</p> + <tt> Syntax: <br> + nvss []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> <dec> + degrees|sexagesimal] # in wcs fk5<br> + [size <width> <height> + degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [open|close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + nvss name <br> + nvss coord <br> + nvss size<br> + nvss save<br> + nvss frame<br> + ds9.set(string cmd)<br> + nvss<br> + nvss m31 <br> + nvss name m31 <br> + nvss coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + nvss size 60 60 arcmin<br> + nvss save yes<br> + nvss frame current<br> + nvss update frame<br> + nvss open<br> + nvss close<br> + </tt> + <p><b> <a name="orient"></a>orient</b></p> + <p>Controls the orientation of the current frame. </p> + <tt> Syntax: <br> + orient [none|x|y|xy] <br> + [open|close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + orient <br> + ds9.set(string cmd)<br> + orient xy<br> + orient open<br> + orient close<br> + </tt> + <p><b> <a name="pagesetup"></a>pagesetup</b></p> + <p>Controls Page Setup options. </p> + <tt> Syntax: <br> + pagesetup [orient portrait|landscape]</tt><br> + <tt> [scale + <numeric>]</tt><br> + <tt> [size + letter|legal|tabloid|poster|a4]</tt><br> + <tt> <br> + Example:<br> + string value = ds9.get(string cmd)<br> + pagesetup orient<br> + pagesetup scale <br> + pagesetup size <br> + ds9.set(string cmd)<br> + pagesetup orient portrait <br> + pagesetup scale 50<br> + pagesetup size poster<br> + </tt> + <p><b> <a name="pan"></a>pan</b></p> + <p>Controls the current image cursor location for the current + frame. </p> + <tt> Syntax: <br> + pan [<x> <y> <coordsys> + [<skyframe>][<skyformat>]] # relative<br> + [to <x> <y> <coordsys> + [<skyframe>][<skyformat>] # absolute<br> + [open|close]<br> + [close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + pan # get current image coords <br> + pan wcs fk4 sexagesimal # get current wcs coords <br> + ds9.set(string cmd)<br> + pan 200 200 image # pan relative <br> + pan to 400 400 physical # pan to physical coords <br> + pan to 13:29:55 47:11:50 wcs fk5 # pan to wcs coords<br> + pan open<br> + pan close<br> + </tt> + <p><b> <a name="pixeltable"></a>pixeltable</b></p> + <p>Display/Hide the pixel table. </p> + <tt> Syntax: <br> + pixeltable []<br> + [yes|open] <br> + [no|close]<br> + <br> + Example:<br> + string url = ds9.get(string cmd)<br> + pixeltable <br> + ds9.set(string cmd)<br> + pixeltable<br> + pixeltable yes<br> + pixeltable open<br> + pixeltable close<br> + </tt> + <p><b> <a name="plot"></a>plot</b></p> + <p>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:</p> + <blockquote>xy x and y coordinates<br> + xyex x,y coordinates with x errors<br> + xyey x,y coordinates with y errors<br> + xyexey x,y coordinates with x and y + errors<br> + </blockquote> + <p>To create a new plot, use the plot new command.</p> + <tt> Syntax: <br> + # create new empty plot window<br> + plot<br> + plot [bar|scatter]<br> + [new [name <plotname>] + [line|bar|scatter]]<br> + [new [name <plotname>] + [line|bar|scatter] <title> <xaxis label> <yaxis + label> </tt><tt>xy|xyex|xyey|xyexey</tt><tt>]<br> + <br> + # create new plot with data<br> + plot [new [name <plotname>] </tt><tt>[line|bar|scatter] </tt><tt>stdin] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + # title, title xaxis, title yaxis, dimension on line 1<br> + [new [name <plotname>] + [line|bar|scatter] <title> <xaxis label> <yaxis + label> xy|xyex|xyey|xyexey]<br> + <br> + # load dataset into an existing plot<br> + plot [<plotname>] [data xy|xyex|xyey|xyexey]<br> + </tt><tt><tt><br> + plot [<plotname>] load <filename> + [xy|xyex|xyey|xyexey]<br> + [<plotname>] save + <filename><br> + </tt> [<plotname>] clear<br> + </tt><tt><tt><tt><tt><tt><tt> </tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + duplicate<br> + </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </tt>[<plotname>] stats<br> + </tt></tt> </tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + list<br> + </tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + loadconfig <filename><br> + [<plotname>] saveconfig + <filename><br> + </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [<plotname>] pagesetup orient [portrait|landscape]<br> + [<plotname>] pagesetup + size [letter|legal|tabloid|poster|a4]</tt><br> + <tt> </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [<plotname>] print<br> + [<plotname>] print destination + [printer|file] <br> + [<plotname>] print + command <command><br> + [<plotname>] print + filename <filename><br> + [<plotname>] print color + [rgb|gray]<br> + </tt> </tt>[<plotname>] + close<br> + </tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><br> + plot </tt>[<plotname>] mode [pointer|zoom]<br> + </tt></tt></tt></tt></tt></tt><tt><br> + # configure graph<br> + plot [<plotname>] axis [x|y] grid [yes|no]<br> + [<plotname>] axis [x|y] log + [yes|no]<br> + </tt><tt> [<plotname>] axis [x|y] + flip [yes|no]</tt><br> + <tt><tt> [<plotname>] axis [x|y] auto + [yes|no]<br> + [<plotname>] axis [x|y] min + <value><br> + [<plotname>] axis [x|y] max + <value></tt><tt><br> + </tt><tt><tt> [<plotname>] axis [x|y] + format <string></tt><tt><br> + </tt></tt> </tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + legend [yes|no]<br> + [<plotname>] legend position + [right|left|top|bottom]</tt><br> + </tt><tt><tt> [<plotname>] font + [title|labels|numbers] font [times|helvetica|courier]<br> + [<plotname>] font </tt></tt><tt><tt><tt><tt>[title|labels|numbers]</tt></tt> + size <value><br> + [<plotname>] font </tt></tt><tt><tt><tt><tt>[title|labels|numbers]</tt></tt> + weight [normal|bold]<br> + [<plotname>] font </tt></tt><tt><tt><tt><tt>[title|labels|numbers]</tt></tt> + slant [roman|italic]<br> + </tt></tt><tt> [<plotname>] title + <string></tt><br> + <tt><tt> [<plotname>] title [x|y] + <string><br> + [<plotname>] barmode + [normal|stacked|aligned|overlap]<br> + </tt></tt><tt><tt><tt><br> + # configure current dataset<br> + </tt>plot [<plotname>] show [yes|no]<br> + </tt> </tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + shape + [circle|square|diamond|plus|splus|scross|triangle|arrow]</tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt> <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + shape fill [yes|no]</tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt> <tt> + </tt></tt><tt><tt><tt><tt>[<plotname>] + shape color <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + smooth + [step|linear|cubic|quadratic|catrom]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + color + <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + width + <value><br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + dash [yes|no]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error [yes|no]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error color + <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + color + <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error width + <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + name + <string><br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><br> + # select current dataset<br> + </tt></tt></tt>plot [<plotname>] select <value><br> + </tt><tt> <br> + Example: <br> + # return all plotnames<br> + string value = ds9.get(string cmd)<br> + plot<br> + <br> + # create new empty plot window<br> + ds9.set(string cmd)<br> + plot<br> + plot scatter<br> + plot new<br> + plot new bar<br> + plot new name foo<br> + plot new name foo scatter<br> + <br> + # create new plot with data<br> + ds9.set(string cmd, string url)<br> + plot new stdin <br> + plot new name foo stdin<br> + plot new "{The Title}" "{X}" "{Y}" xy<br> + plot new name foo "{The Title}" "{X}" "{Y}" xy<br> + <br> + # load additional dataset into an existing plot<br> + ds9.set(string cmd, string url)<br> + plot data xy # plot additional data<br> + plot foo data xy # plot additional data<br> + </tt><tt><tt><tt><tt><tt><tt><tt><br> + </tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>string + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + value = ds9.get(string cmd)<br> + </tt></tt></tt></tt></tt></tt>plot + stats<br> + plot list<br> + </tt></tt></tt>ds9.set(string cmd)<br> + </tt></tt></tt></tt>plot load foo.dat xy # load new + dataset with dimension xy<br> + plot save bar.dat # save current dataset<br> + </tt></tt><tt><tt>plot clear # clear all datasets<br> + plot duplicate # duplicate current dataset<br> + plot stats<br> + plot list<br> + </tt></tt><tt><tt>plot loadconfig foo.plt # load plot + configuration <br> + plot saveconfig bar.plt # save current plot configuration<br> + </tt></tt><tt><tt>plot pagesetup orient portrait<br> + plot pagesetup size letter<br> + </tt></tt><tt><tt>plot print<br> + plot print destination file<br> + plot print command "lp"<br> + plot print filename "foo.ps"<br> + plot print color rgb<br> + </tt>plot close # close current plot<br> + </tt></tt><tt><tt><tt><tt><br> + string value = ds9.get(string cmd)<br> + </tt>plot mode<br> + </tt></tt></tt><tt><tt><tt><tt>ds9.set(string cmd)<br> + </tt>plot mode pointer</tt><br> + </tt><tt><br> + # configure plot<br> + </tt></tt><tt><tt><tt><tt><tt><tt>string value = ds9.get(string + cmd)<br> + </tt></tt></tt></tt>plot axis x grid<br> + </tt><tt><tt>plot axis x log<br> + </tt></tt><tt><tt><tt>plot axis x flip</tt></tt></tt><br> + </tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + axis x auto<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + axis x min<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + axis x max<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + axis x format<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + legend<br> + </tt></tt></tt></tt><tt><tt><tt><tt><tt>plot legend + position<br> + </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>plot + font numbers font<br> + </tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + font numbers size<br> + </tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + font numbers weight<br> + </tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + font numbers slant<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + title<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + title x<br> + plot barmode<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt> + </tt></tt></tt></tt><tt><tt><tt>ds9.set(string cmd)<br> + </tt>plot axis x grid yes<br> + plot axis x log yes</tt><br> + <tt>plot axis x flip yes</tt><tt><br> + </tt></tt><tt><tt><tt><tt>plot axis x auto no<br> + plot axis x min 0<br> + plot axis x max 100<br> + </tt></tt><tt><tt><tt><tt>plot axis x format {%f}<br> + </tt></tt></tt></tt>plot legend yes # show legend<br> + </tt><tt>plot legend position left</tt><tt><tt><tt><tt><br> + </tt></tt>plot font numbers font times<br> + plot font numbers size 12<br> + plot font numbers weight bold<br> + plot font numbers slant italic<br> + </tt></tt></tt><tt><tt>plot title {The Title}<br> + plot title x {X Axis}<br> + plot barmode aligned<br> + <br> + # configure current dataset<br> + </tt></tt><tt><tt><tt><tt><tt><tt>string value = ds9.get(string + cmd)<br> + </tt></tt></tt></tt>plot show<br> + plot shape</tt> <br> + <tt><tt>plot shape fill<br> + </tt></tt><tt><tt><tt>plot shape color<br> + </tt></tt></tt><tt><tt><tt><tt>plot smooth<br> + </tt></tt></tt></tt><tt><tt><tt><tt><tt>plot color<br> + </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>plot + width<br> + </tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + dash<br> + </tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error color<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error width<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>plot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + name<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt>ds9.set(string + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + cmd)<br> + </tt>plot show yes<br> + plot shape circle<br> + </tt><tt><tt>plot shape fill no<br> + </tt></tt><tt><tt><tt>plot shape color cyan<br> + </tt></tt></tt><tt><tt>plot smooth step<br> + </tt>plot color red<br> + plot width 2<br> + plot dash yes<br> + plot error yes<br> + plot error color red</tt><br> + <tt>plot error width 2</tt><br> + <tt>plot name {My Data}</tt><br> + <tt><br> + # select current dataset<br> + </tt></tt><tt><tt><tt><tt><tt><tt>string value = ds9.get(string + cmd)<br> + </tt></tt></tt></tt>plot select<br> + </tt></tt><tt><tt><tt>ds9.set(string cmd)<br> + </tt>plot select 2</tt><br> + <br> + </tt><b><b><a name="png"></a></b>png</b> + <p>Load PNG image into current frame.<br> + </p> + <tt> Syntax:<br> + png [new|slice] [<filename>]<br> + <br> + Example: <br> + </tt><tt><tt>string value = ds9.get(string cmd)<br> + </tt>png</tt><br> + <tt><tt>ds9.set(string cmd)<br> + </tt>png foo.png</tt><br> + <tt><tt>png new foo.png<br> + </tt></tt><tt><tt><tt>png slice foo.png<br> + </tt></tt>png</tt><br> + <tt><tt>png</tt><tt> new<br> + </tt>png</tt><tt> slice</tt><br> + <p><b> <a name="prefs"></a>prefs</b></p> + <p>Controls various preference settings. </p> + <tt> Syntax: <br> + prefs [clear]<br> + [irafalign yes|no]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + prefs irafalign<br> + ds9.set(string cmd)<br> + prefs clear<br> + prefs irafalign<br> + <br> + </tt><b><a name="preserve"></a>preserve</b> + <p>Preserve the follow attributes while loading a new image. </p> + <tt> Syntax: <br> + preserve [pan yes|no]<br> + [regions yes|no]<br> + <br> + Example: <br> + string value = ds9.get(string cmd) <br> + preserve pan<br> + preserve regions<br> + ds9.set(string cmd)<br> + preserve pan yes<br> + preserve regions yes<br> + </tt> + <p><b><a name="psprint"></a>psprint</b></p> + <p>Invokes postscript printing. Please see <a + href="file:///Users/joye/saods9/ds9/doc/ref/command.html#print">print</a> + for further details.</p> + <p><b> <a name="print"></a>print</b></p> + <p>Controls printing. Use print option to set printing options.</p> + <tt> Syntax: <br> + print [destination printer|file] <br> + [command <command>] <br> + [filename <filename>]<br> + [color rgb|cmyk|gray] <br> + [level 1|2] <br> + [resolution 53|72|75|150|300|600] + <br> + <br> + Example: <br> + string value = ds9.get(string cmd) <br> + print destination <br> + print command <br> + print filename <br> + print color<br> + print level <br> + print resolution <br> + ds9.set(string cmd)<br> + print <br> + print destination file <br> + print command '{gv -}' <br> + print filename foo.ps <br> + print color cmyk <br> + print level 2 <br> + print resolution 75 </tt> + <p><b> <a name="raise"></a>raise</b></p> + <p>Raise in the window stacking order. </p> + <tt> Syntax: <br> + raise <br> + <br> + Example: <br> + ds9.set(string cmd)<br> + raise </tt> + <p><b> <a name="regions"></a>regions</b></p> + <p>Controls regions in the current frame. </p> + <tt> Syntax: <br> + regions [<filename>]<br> + [load [all] + <filename>] <br> + [save + <filename>] <br> + [list [close]]<br> + [epsilon + <integer>]<br> + [show yes|no]<br> + [showtext yes|no]<br> + [centroid]<br> + [centroid auto + yes|no]<br> + [centroid radius + <value>|iteration <value>]<br> + [getinfo]<br> + [move front] <br> + [move back]<br> + [select all]<br> + [select none] <br> + [select invert]<br> + [delete all] <br> + [delete select] <br> + [format + ds9|xml|ciao|saotng|saoimage|pros|xy] <br> + [system + image|physical|wcs|wcsa...wcsz]<br> + [sky + fk4|fk5|icrs|galactic|ecliptic] <br> + [skyformat + degrees|sexagesimal]<br> + [strip yes|no]<br> + [shape <shape>]<br> + [color + &ltcolor>]<br> + [width <width>]<br> + </tt><tt> + [fixed|edit|rotate|delete yes|no]<br> + + [include|exclude|source|background]</tt><br> + <tt> </tt><tt> [delim + [nl|<char>]]<br> + [command <marker + command>]<br> + [composite]<br> + [dissolve]<br> + [template + <filename>]<br> + [template <filename> + at <ra> <dec> <coordsys> <skyframe>]<br> + [savetemplate + <filename>]<br> + [groups] <br> + [group new]<br> + [group <tag> + new]<br> + [group <tag> + update]<br> + [group <tag> select]<br> + [group <tag> color + <color>] <br> + [group <tag> copy] <br> + [group <tag> delete] + <br> + [group <tag> cut]<br> + [group <tag> font + <font>] <br> + [group <tag> move + <int> <int>]<br> + [group <tag> + movefront] <br> + [group <tag> + moveback] <br> + [group <tag> + property <property> yes|no] <br> + [copy]<br> + [cut]<br> + [paste + image|physical|wcs|wcsa...wcsz]<br> + [undo]<br> + + [include|exclude|source|background|selected]<br> + [-format + ds9|ciao|saotng|saoimage|pros|xy]<br> + [-system + image|physical|wcs|wcsa...wcsz]<br> + [-sky + fk4|fk5|icrs|galactic|ecliptic] <br> + [-skyformat + degrees|sexagesimal]<br> + [-delim [nl|<char>]]<br> + [-prop + select|edit|move|rotate|delete|fixed|include|source 1|0] <br> + [-group <tag>]<br> + [-strip yes|no]<br> + [-wcs yes|no]<br> + <br> + Example: <br> + string url = ds9.get(string cmd)<br> + regions<br> + regions -format ds9 -system wcs -sky fk5 -skyformat sexagesimal + -prop edit 1 -group foo <br> + string value = ds9.get(string cmd) <br> + regions epsilon<br> + regions show<br> + regions showtext<br> + regions centroid<br> + regions centroid auto<br> + regions centroid radius<br> + regions centroid iteration<br> + regions selected<br> + regions format <br> + regions system <br> + regions sky <br> + regions skyformat <br> + regions strip<br> + regions shape <br> + regions color <br> + regions width<br> + regions delim<br> + regions source <br> + regions background <br> + regions include <br> + regions exclude <br> + regions selected<br> + regions groups<br> + ds9.set(string cmd, string url)<br> + regions -format xy -system wcs -sky fk5<br> + regions -format ds9<br> + ds9.set(string cmd)<br> + regions foo.reg <br> + regions -format ciao bar.reg # load as ciao format<br> + regions foo.fits # FITS regions files do not need a format + specification<br> + regions load foo.reg # load foo.reg into current frame<br> + regions load all foo.reg # load foo.reg into all frames<br> + regions load *.reg# expand *.reg and load into current frame<br> + regions load all *.reg # expand *.reg and load into all frames<br> + regions save foo.reg<br> + regions list <br> + regions list close<br> + regions epsilon 5<br> + regions show yes<br> + regions showtext no<br> + regions centroid<br> + regions centroid auto yes<br> + regions centroid radius 10<br> + regions centroid iteration 20<br> + regions getinfo<br> + regions move back <br> + regions move front <br> + regions select all <br> + regions select none <br> + regions select invert<br> + regions delete all <br> + regions delete select <br> + regions format ds9 <br> + regions system wcs<br> + regions sky fk5 <br> + regions skyformat degrees <br> + regions delim nl <br> + regions strip yes<br> + regions shape ellipse <br> + regions color red <br> + regions width 3<br> + regions edit yes<br> + regions include<br> + regions command "circle 100 100 20 # color=red"<br> + regions composite<br> + regions dissolve<br> + regions template foo.tpl<br> + regions template foo.tpl at 13:29:55.92 +47:12:48.02 fk5<br> + regions savetemplate foo.tpl<br> + regions group new<br> + regions group foo new<br> + regions group foo update<br> + regions group foo select<br> + regions group foo color red<br> + regions group foo copy<br> + regions group foo delete<br> + regions group foo cut<br> + regions group foo font 'times 14 bold'<br> + regions group foo move 100 100 <br> + regions group foo movefront <br> + regions group foo moveback <br> + regions group foo property delete no <br> + regions copy<br> + regions cut<br> + regions paste wcs<br> + regions undo<br> + </tt> + <p><b> <a name="restore"></a>restore</b></p> + <p>Restore DS9 to a previous state from a backup save set. </p> + <tt> Syntax: <br> + restore <filename><br> + <br> + Example:<br> + restore ds9.bck</tt><br> + <p><b> <a name="rgb"></a>rgb</b></p> + <p>Create RGB frame and control RGB frame parameters.</p> + <tt> Syntax: <br> + rgb []<br> + [red|green|blue]<br> + [channel [red|green|blue]]<br> + [view [red|green|blue] [yes|no]]<br> + [system <coordsys>]<br> + [lock + wcs|crop|slice|bin|scale|scalelimits|colorbar|block|smooth + [yes|no]]<br> + [open|close]<br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + rgb channel<br> + </tt><tt>rgb lock wcs</tt><br> + <tt>rgb lock crop</tt><br> + <tt>rgb lock slice</tt><br> + <tt> rgb lock bin<br> + rgb lock scale<br> + rgb lock scalelimits<br> + rgb lock colorbar<br> + rgb lock block<br> + rgb lock smooth<br> + rgb system<br> + rgb view red<br> + rgb view green<br> + rgb view blue<br> + ds9.set(string cmd)<br> + rgb # create new rgb frame<br> + rgb red # set current channel to red<br> + rgb channel red # set current channel to red<br> + rgb view blue no # turn off blue channel<br> + rgb system wcs # set rgb coordinate system<br> + </tt><tt>rgb lock wcs yes</tt><br> + <tt>rgb lock crop yes</tt><br> + <tt>rgb lock slice yes</tt><br> + <tt>rgb lock bin yes</tt><br> + <tt> rgb lock scale yes<br> + rgb lock scalelimits yes<br> + rgb lock colorbar yes<br> + rgb lock block yes<br> + rgb lock smooth yes<br> + rgb open<br> + rgb close</tt><br> + <p><b> <a name="rgbarray"></a>rgbarray</b></p> + <p>Load raw data array cube into rgb frame.<br> + </p> + <tt> Syntax:<br> + rgbarray [native|big|little]<br> + rgbarray [new|mask] +[[xdim=<x>,ydim=<y>|dim=<dim>],[zdim=3],bitpix=<b>,skip=<s>,endian=[little|big]]<br> + <br> + Example: <br> + </tt><tt><tt><tt>string value = ds9.get(string cmd)<br> + </tt></tt>rgbarray<br> + rgbarray little<br> + </tt><tt><tt><tt>ds9.set(string cmd)<br> + </tt></tt>rgbarray + foo.arr[dim=512,zdim=3,bitpix=-32,endian=little]<br> + rgbarray new foo.arr[dim=512,zdim=3,bitpix=</tt><tt>-32,endian=little]</tt><br> + <p><b> <a name="rgbcube"></a>rgbcube</b></p> + <p>Load FITS rgbcube into rgb frame.<br> + </p> + <tt> Syntax:<br> + rgbcube [new] [<filename>]<br> + <br> + Example: <br> + </tt><tt><tt>string value = ds9.get(string cmd)<br> + </tt>rgbcube<br> + </tt><tt><tt>ds9.set(string cmd)<br> + </tt>rgbcube foo.fits</tt><br> + <tt><tt>rgbcube new foo.fits<br> + </tt>rgbcube</tt><br> + <tt>rgbcube</tt><tt> new</tt><br> + <p><b> <a name="rgbimage"></a>rgbimage</b></p> + <p>Load FITS rgbimage into rgb frame.<br> + </p> + <tt> Syntax:<br> + rgbimage [new] [<filename>]<br> + <br> + Example: <br> + </tt><tt><tt><tt>string value = ds9.get(string cmd)<br> + </tt></tt>rgbimage<br> + </tt><tt><tt><tt>ds9.set(string cmd)<br> + </tt></tt>rgbimage foo.fits</tt><br> + <tt><tt>rgbimage new foo.fits<br> + </tt>rgbimage</tt><br> + <tt>rgbimage</tt><tt> new</tt> + <p><b> <a name="rotate"></a>rotate</b></p> + <p>Controls the rotation angle (in degrees) of the current frame. + </p> + <tt> Syntax: <br> + rotate [<value>] <br> + [to <value>] <br> + [open|close]<br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + rotate <br> + ds9.set(string cmd)<br> + rotate 45 <br> + rotate to 30<br> + rotate open<br> + rotate close</tt><br> + <p><b><a name="samp"></a>samp</b></p> + <p>Configure SAMP protocol. </p> + <tt> Syntax: <br> + samp [no|disconnect] <br> + [broadcast [image|table]]<br> + [send [image|table] + <application>]<br> + <br> + Example: <br> + </tt><tt><tt>ds9.set(string cmd)<br> + </tt>samp no<br> + </tt><tt><tt>samp disconnect<br> + </tt>samp broadcast image<br> + samp send image aladin</tt> + <p><b> <a name="save"></a>save<br> + </b></p> + <p>Save loaded image data of current frame as FITS.</p> + <tt> Syntax: <br> + save </tt><tt>[fits|rgbimage|rgbcube|mecube|mosaic|mosaicimage] + <filename> [image|table|slice]</tt> <br> + <tt> <br> + Example: <br> + </tt><tt><tt>ds9.set(string cmd) <br> + </tt>save foo.fits</tt><br> + <tt>save fits foo.fits image</tt><br> + <tt>save fits foo.fits table<br> + save fits foo.fits slice</tt><br> + <tt>save rgbimage foo.fits<br> + </tt><tt>save rgbcube foo.fits</tt><br> + <tt>save mecube foo.fits</tt><br> + <tt>save mosaic foo.fits</tt><br> + <tt>save mosaicimage foo.fits</tt><br> + <p><b> <a name="saveimage"></a>saveimage</b></p> + <p>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: <tt>jpeg</tt> quality (1-100) and <tt>tiff</tt> + compression method. </p> + <tt> Syntax: <br> + saveimage </tt><tt>[fits|eps|gif|tiff|jpeg|png] </tt><tt><filename><br> + saveimage <filename>.jpeg [1-100]<br> + saveimage <filename>.tiff [none|jpeg|packbits|deflate]<br> + <br> + Example:<br> + ds9.set(string cmd) <br> + saveimage ds9.tiff<br> + saveimage jpeg ds9.jpeg 75</tt><br> + <p><b> <a name="scale"></a>scale</b></p> + <p>Controls the limits and color scale distribution. </p> + <tt> Syntax: <br> + scale [linear|log|pow|sqrt|squared|asinh|sinh|histequ]<br> + [log exp <value>] <br> + [datasec yes|no] <br> + [limits <minvalue> + <maxvalue>] <br> + [mode + minmax|<value>|zscale|zmax] <br> + [scope local|global]<br> + [match]<br> + [match limits]<br> + [lock [yes|no]]<br> + [lock limits [yes|no]]<br> + [open|close]<br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + scale<br> + scale log exp <br> + scale datasec <br> + scale limits <br> + scale mode <br> + scale scope <br> + scale lock<br> + scale lock limits<br> + ds9.set(string cmd)<br> + scale linear<br> + scale log exp 100<br> + scale datasec yes <br> + scale histequ <br> + scale limits 1 100 <br> + scale mode zscale <br> + scale mode 99.5 <br> + scale scope local<br> + scale match<br> + scale match limits<br> + scale lock yes<br> + scale lock limits yes<br> + scale open<br> + scale close<br> + </tt> + <p><b> <a name="shm"></a>shm</b></p> + <p>Load a shared memory segment into the current frame. </p> + <tt> Syntax: <br> + shm [<key> [<filename>]] <br> + [key <key> [<filename>]] <br> + [shmid <id> [<filename>]]<br> + [fits [key|shmid] <id> + [<filename>]]<br> + [mosaicimage [iraf|wcs|wcsa...wcsz|wfpc2] + [key|shmid] <id> [<filename>]]<br> + [mosaicimagenext [wcs|wcsa...wcsz] + [key|shmid] <id> [<filename>]]<br> + [mosaic [iraf|wcs|wcsa...wcsz] [key|shmid] + <id> [<filename>]] <br> + [rgbcube [key|shmid] <id> + [<filename>]<br> + [rgbimage [key|shmid] <id> + [<filename>]]<br> + [rgbarray [key|shmid] <id> +[xdim=<x>,ydim=<y>|dim=<dim>,zdim=3],bitpix=<b>,[skip=<s>]]<br> + [array [key|shmid] <id> +[xdim=<x>,ydim=<y>|dim=<dim>],bitpix=<b>,[skip=<s>]]<br> + [startload|finishload]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + shm <br> + ds9.set(string cmd)<br> + shm 102 <br> + shm key 102<br> + shm shmid 102 foo<br> + shm fits key 100 foo <br> + shm mosaicimage iraf key 100 foo <br> + shm mosaicimage wcs key 100 foo <br> + shm mosaicimage wcsa key 100 foo <br> + shm mosaicimage wfpc2 key 100 foo <br> + shm mosaicimagenext wcs key 100 foo<br> + shm mosaic iraf key 100 foo <br> + shm mosaic wcs key 100 foo <br> + shm rgbcube key 100 foo <br> + shm rgbimage key 100 foo<br> + shm rgbarray key 100 [dim=200,zdim=3,bitpix=-32]<br> + shm array shmid 102 [dim=32,bitpix=-32]<br> + shm startload # start a multiple load sequence without updating + the display<br> + shm finishload # finish multiple load sequence</tt><br> + <p><b> <a name="sia"></a>sia<br> + </b></p> + <p>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.</p> + <tt> Syntax:<br> + sia</tt><tt> </tt><tt><tt><tt>[2mass|akari|astrowise|cadc|cxc|mast|sdss|skyview|tgssadr</tt><tt>]</tt></tt><br> + <br> + </tt><tt> </tt><tt> + [<ref>] [cancel]<br> + </tt><tt> [<ref>] + [clear]<br> + </tt><tt> [<ref>] [close]</tt><br> + <tt> [<ref>] + [coordinate <ra> <dec> <coordsys>]</tt><tt><br> + </tt><tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [crosshair]</tt><br> + <tt> [<ref>] + [export sb|tsv <filename>]<br> + </tt><tt> [<ref>] [name + <object>]<br> + </tt><tt> [<ref>] [print]</tt><br> + <tt><tt> [<ref>] + [retrieve]</tt><br> + <tt> </tt></tt><tt> + [<ref>] [save <filename>]</tt><br> + <tt> [<ref>] [size + <width> <height> degrees|arcmin|arcsec]</tt><br> + <tt> </tt><tt> [<ref>] + [sky <skyframe>]<br> + </tt><tt> [<ref>] + [skyformat <skyformat>]<br> + </tt><tt> [<ref>] + [system <coordsys>]</tt><tt><br> + </tt><tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [update]</tt><br> + <tt><br> + Example:<br> + string value = ds9.get(string cmd) <br> + sia<br> + <br> + ds9.set(string cmd)<br> + sia</tt><tt> 2mass<br> + sia</tt><tt> cancel<br> + sia</tt><tt> clear<br> + sia</tt><tt> close<br> + sia</tt><tt> coordinate 202.48 47.21 fk5<br> + sia</tt><tt> crosshair<br> + sia</tt><tt> export tsv bar.tsv<br> + sia</tt><tt> name m51<br> + sia</tt><tt> print</tt><br> + <tt>sia</tt><tt> retrieve<br> + sia</tt><tt> save foo.xml<br> + sia</tt><tt> size 1 1 degrees</tt><br> + <tt>sia</tt><tt> sky fk5<br> + sia skyformat degrees<br> + sia</tt><tt> system wcs</tt><tt><br> + sia</tt><tt> update<br> + <br> + </tt><b><a name="single"></a>single</b> + <p>Select Single Display mode </p> + <tt> Syntax: <br> + single <br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + single <br> + ds9.set(string cmd)<br> + single<br> + </tt> + <p><b><a name="skyview"></a>skyview </b></p> + <p>Support for SkyView image server at HEASARC. </p> + <p> </p> + <tt> Syntax: <br> + skyview []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> + <dec> degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [pixels <width> + <height>]<br> + [save yes|no]<br> + [frame new|current]<br> + [update + frame|crosshair]<br> + [survey <survey>] <br> + [open|close]<br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + skyview name <br> + skyview coord <br> + skyview size<br> + skyview pixels<br> + skyview save<br> + skyview frame<br> + skyview survey<br> + ds9.set(string cmd)<br> + skyview<br> + skyview m31 <br> + skyview name m31 <br> + skyview coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + skyview size 60 60 arcmin<br> + skyview pixels 600 600<br> + skyview save yes<br> + skyview frame current<br> + skyview update frame<br> + skyview survey sdssi<br> + skyview open<br> + skyview close<br> + </tt> + <p><b><a name="sleep"></a>sleep </b></p> + <p>Delays execution for specified number of seconds. Default is 1 + second. </p> + <p> </p> + <tt> Syntax: <br> + sleep [#]<br> + <br> + Example: <br> + ds9.set(string cmd)<br> + sleep<br> + sleep 2<br> + </tt> + <p><b><a name="smooth"></a>smooth</b></p> + <p>Smooth current image or set smooth parameters.</p> + <tt> Syntax:<br> + smooth []<br> + [yes|no]<br> + [function + boxcar|tophat|gaussian]<br> + [radius <int>]<br> + [open|close]<br> + [match]<br> + [lock [yes|no]]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + smooth<br> + smooth function<br> + smooth radius<br> + smooth lock<br> + ds9.set(string cmd)<br> + smooth<br> + smooth yes<br> + smooth function tophat<br> + smooth radius 4<br> + smooth open<br> + smooth close<br> + smooth match<br> + smooth lock yes<br> + </tt> + <p><b> <a name="source"></a>source</b></p> + <p>Source TCL code from a file. </p> + <tt> Syntax: <br> + source [filename] <br> + <br> + Example: <br> + ds9.set(string cmd)<br> + source foo.tcl</tt><br> + <p><b> <a name="tcl"></a>tcl</b></p> + <p>Execute one TCL command.<br> + </p> + <tt> Syntax:<br> + tcl <tcl command><br> + <br> + Example: <br> + </tt><tt><tt>ds9.set(string cmd)<br> + </tt>tcl puts "Hello, World"<br> + </tt> + <p><b> <a name="threads"></a>threads</b></p> + <p>Set number of process threads for functions which are + multi-threaded. </p> + <tt> Syntax:<br> + threads #<br> + <br> + Example: <br> + </tt><tt>string value = ds9.get(string cmd)<br> + </tt><tt>threads</tt><br> + <tt>ds9.set(string cmd)<br> + </tt><tt>threads 8</tt><br> + <p><b> <a name="tiff"></a>tiff</b></p> + <p>Load TIFF image into current frame. Optional parameters: <tt>tiff + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </tt>compression method. </p> + <tt> Syntax:<br> + tiff [new|slice] [<filename>] [none|jpeg|packbits|deflate]<br> + <br> + Example: <br> + </tt><tt><tt>string value = ds9.get(string cmd)<br> + </tt>tiff</tt><br> + <tt><tt>tiff jpeg</tt><br> + </tt><tt><tt>ds9.set(string cmd)<br> + </tt>tiff foo.tiff<br> + tiff new foo.tiff<br> + tiff slice foo.tiff</tt><tt><tt><br> + </tt>tiff<br> + tiff new<br> + tiff slice</tt><br> + <p><b> <a name="tile"></a>tile</b></p> + <p>Controls the tile display mode. </p> + <tt> Syntax: <br> + tile []<br> + [yes|no] <br> + [mode grid|column|row] <br> + [grid] <br> + [grid mode automatic|manual]<br> + [grid direction x|y]<br> + [grid layout <col> <row>] <br> + [grid gap <pixels>] <br> + [row] <br> + [column] <br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + tile <br> + tile mode <br> + tile grid mode<br> + tile grid direction <br> + tile grid layout <br> + tile grid gap <br> + ds9.set(string cmd)<br> + tile<br> + tile yes <br> + tile mode row <br> + tile grid <br> + tile grid mode manual<br> + tile grid direction x <br> + tile grid layout 5 5 <br> + tile grid gap 10 <br> + tile row <br> + tile column </tt> + <p><b> <a name="update"></a>update</b></p> + <p>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. </p> + <tt> Syntax: <br> + update [] <br> + [# x1 y1 x2 y2] <br> + [now] <br> + [now # x1 y1 x2 y2]<br> + <br> + Example: <br> + ds9.set(string cmd)<br> + update <br> + update 1 100 100 300 400 <br> + update now <br> + update now 1 100 100 300 400</tt><br> + <p><b> <a name="url"></a>url</b></p> + <p>Load FITS from URL into the current frame</p> + <tt> Syntax: <br> + url <url><br> + <br> + Example: <br> + </tt><tt><tt>ds9.set(string cmd)<br> + </tt>url http://foo.bar.edu/foo.fits </tt> + <p><b> <a name="version"></a>version</b></p> + <p>Returns the current version of DS9. </p> + <tt> Syntax: <br> + version <br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + version </tt> + <p><b> <a name="view"></a>view</b></p> + <p>Controls the GUI. </p> + <tt> Syntax: <br> + view [layout horizontal|vertical]<br> + [keyvalue <string>]<br> + [info yes|no] <br> + [panner yes|no] <br> + [magnifier yes|no] <br> + [buttons yes|no] <br> + [colorbar yes|no]<br> + [colorbar horizontal|vertical]<br> + [colorbar numerics yes|no]<br> + [graph horizontal|vertical + yes|no]<br> + [filename yes|no[<br> + [object yes|no]<br> + [keyword yes|no]<br> + [minmax yes|no]<br> + [lowhigh yes|no]<br> + [units yes|no]<br> + [image|physical|wcs|wcsa...wcsz + yes|no]<br> + </tt><tt><tt> [frame yes|no] <br> + </tt> [red yes|no]<br> + [green yes|no]<br> + [blue yes|no]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + view layout<br> + view keyvalue<br> + view info <br> + view panner<br> + view magnifier<br> + view buttons<br> + view colorbar<br> + view graph horizontal<br> + view filename<br> + view object<br> + view keyword<br> + view minmax<br> + view lowhigh<br> + view units<br> + view image<br> + view wcsa<br> + </tt><tt><tt>view frame<br> + </tt>view red<br> + ds9.set(string cmd)<br> + view layout vertical<br> + view keyvalue BITPIX<br> + view info yes<br> + view panner yes<br> + view magnifier yes<br> + view buttons yes<br> + view colorbar yes<br> + view graph horizontal yes<br> + view filename yes<br> + view object yes<br> + view keyword yes<br> + view minmax yes<br> + view lowhigh yes<br> + view units yes<br> + view wcsa yes<br> + </tt><tt><tt>view frame yes <br> + </tt>view red yes<br> + view green yes<br> + view blue yes</tt><br> + <p><b> <a name="vla"></a>vla</b></p> + <p>Support for VLA Sky Survey. </p> + <tt> Syntax:<br> + vla []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> <dec> + degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [survey first|stripe82]<br> + [open|close]<br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + vla name <br> + vla coord <br> + vla size<br> + vla save<br> + vla frame<br> + vla survey<br> + ds9.set(string cmd)<br> + vla<br> + vla m31 <br> + vla name m31 <br> + vla coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + vla size 60 60 arcmin<br> + vla save yes<br> + vla frame current<br> + vla update frame <br> + vla survey stripe82<br> + vla open<br> + vla close<br> + </tt> + <p><b> <a name="vlss"></a>vlss</b></p> + <p>Support for NRAO VLSS Sky Survey.</p> + <tt> Syntax: <br> + vlss []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> <dec> + degrees|sexagesimal] # in wcs fk5<br> + [size <width> <height> + degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [open|close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + vlss name <br> + vlss coord <br> + vlss size<br> + vlss save<br> + vlss frame<br> + ds9.set(string cmd)<br> + vlss<br> + vlss m31 <br> + vlss name m31 <br> + vlss coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + vlss size 60 60 arcmin<br> + vlss save yes<br> + vlss frame current<br> + vlss update frame<br> + vlss open<br> + vlss close</tt><br> + <p><b> <a name="vo"></a>vo</b></p> + <p>Invoke an connection to a Virtual Observatory site. </p> + <tt> Syntax: <br> + vo [method xpa|mime]<br> + [server <url>]<br> + [internal yes|no]<br> + [delay #]<br> + [<url>]<br> + [connect <url>]<br> + [disconnect <url>]<br> + [open|close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + vo<br> + vo method<br> + vo server<br> + vo internal<br> + vo delay<br> + vo connect<br> + ds9.set(string cmd)<br> + vo method xpa<br> + vo server "http://foo.bar.edu/list.txt"<br> + vo internal yes<br> + vo delay 15<br> + vo chandra-ed<br> + vo connect chandra-ed<br> + vo disconnect chandra-ed<br> + vo open<br> + vo close<br> + </tt> + <p><b> <a name="wcs"></a>wcs</b></p> + <p>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 <a + href="file.html#WCS">WCS</a> for more information. </p> + <tt> Syntax: <br> + wcs [[system] wcs|wcsa...wcsz] <br> + [[sky] fk4|fk5|icrs|galactic|ecliptic] <br> + [[skyformat] degrees|sexagesimal] <br> + [align yes|no] <br> + [reset [#]] <br> + [replace [#] <filename>] <br> + [append [#] <filename>] <br> + [open|close]<br> + <br> + Example: <br> + string value = ds9.get(string cmd)<br> + wcs <br> + wcs system <br> + wcs sky <br> + wcs skyformat <br> + wcs align <br> + ds9.set(string cmd)<br> + wcs wcs <br> + wcs system wcs<br> + </tt><tt>wcs fk5<br> + </tt><tt>wcs sky fk5<br> + </tt><tt>wcs sexagesimal <br> + </tt><tt>wcs skyformat sexagesimal <br> + wcs align yes <br> + wcs reset <br> + wcs reset 3<br> + wcs replace foo.wcs <br> + wcs replace 3 foo.wcs <br> + wcs append foo.wcs <br> + wcs append 3 foo.wcs <br> + ds9.set(string cmd, string url)<br> + wcs replace <br> + wcs append<br> + wcs open<br> + wcs close<br> + </tt> + <p><b> <a name="web"></a>web</b></p> + <p>Display specified URL in the web display. </p> + <tt> Syntax:<br> + web [new|<webname>] [<url>]<br> + [<webname>] [click + back|forward|stop|reload|#]<br> + [<webname>] [clear]<br> + [<webname>] [close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + web <br> + ds9.set(string cmd)<br> + web www.cnn.com<br> + web new www.cnn.com<br> + web hvweb www.apple.com<br> + web click back<br> + web click 2<br> + web clear<br> + web close<br> + </tt> + <p><b> <a name="width"></a>width</b></p> + <p>Set the width of the image display window.</p> + <tt> Syntax: <br> + width [<value>]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + width<br> + ds9.set(string cmd)<br> + width 512<br> + </tt> + <p><b> <a name="zscale"></a>zscale</b></p> + <p>Set Scale Limits based on the <i>IRAF</i> algorithm. </p> + <tt> Syntax: <br> + zscale []<br> + [contrast]<br> + [sample]<br> + [line]<br> + <br> + Example:<br> + string value = ds9.get(string cmd)<br> + zscale contrast<br> + zscale sample<br> + zscale line<br> + ds9.set(string cmd)<br> + zscale<br> + zscale contrast .25<br> + zscale sample 600<br> + zscale line 120<br> + </tt> + <p><b> <a name="zoom"></a>zoom</b></p> + <p>Controls the current zoom value for the current frame. </p> + <tt> Syntax: <br> + zoom [<value>] <br> + [<value> <value>]<br> + [to <value>] <br> + [to <value> <value>]<br> + [in]<br> + [out]<br> + [to fit] <br> + [open|close]<br> + <br> + Example:<br> + string value = ds9.get(string cmd) <br> + zoom <br> + ds9.set(string cmd)<br> + zoom 2 <br> + zoom 2 4<br> + zoom to 4 <br> + zoom to 2 4<br> + zoom in<br> + zoom out<br> + zoom to fit<br> + zoom open<br> + zoom close<br> + </tt> </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/vo.html b/ds9/doc/ref/vo.html new file mode 100644 index 0000000..3547d42 --- /dev/null +++ b/ds9/doc/ref/vo.html @@ -0,0 +1,69 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" + content="text/html; charset=ISO-8859-1"> + <meta name="GENERATOR" + content="Mozilla/4.78 [en] (X11; U; Linux 2.4.7-10 i686) [Netscape]"> + <title>Virtual Observatory</title> + </head> + <body alink="#ff0000" bgcolor="#ffffff" vlink="#551a8b" text="#000000" + link="#0000ff"> + <h3><img alt="" src="../sun.gif" align="middle" width="100" height="98"> + Virtual Observatory Reference</h3> + <blockquote> + <p><b>Summary</b></p> + <p>Use the Web proxy connection if your firewall does not allow your + computer to connect directly to external computers. In this case, you + also must use DS9's internal browser.</p> + <p><b>Details</b></p> + <p>When you click on one of the Virtual Observatory servers in the VO + list, DS9 will attempt to connect to that server and (if the internal + Web display is enabled) display its Web page. The square box to the left + of the server name turns yellow while the connection is being + established and then green to signal success. </p> + <p>A direct connection is fast and flexible. Among other things, it + allows + you to perform analysis on your own local data (the VO server will + retrieve the image from DS9) and also allows you to use an + external browser to load images. </p> + <p>Some system managers configure their firewall explicitly to + prevent + computers in their care from making a direct connection to an external + host. Instead, they only allow external access through a Web proxy<br> + server (such as SOCKS). If you are using a computer behind a restricted + firewall of this sort, then DS9 will not be able to connect directly to + a VO server. The yellow box will not turn green and + eventually DS9 will display an error message. </p> + <p>In this case, you can choose to have DS9 communicate with the VO + servers through your Web proxy server. DS9 will use your proxy to send + its commands and retrieve its data and analysis results, rather than + doing this directly. Note that the following restrictions apply:<br> + </p> + <blockquote> <i>The transfer of data is slower.<br> + You must use the internal Web browser for loading images, etc.<br> + You cannot perform analysis on local data.<br> + There is a (large but finite) restriction on the number of + annuli, and number of polygon points you can specify in a region, as + well as the total number of regions allowed.</i><br> + </blockquote> + <p>If your computer and firewall have been configured to require use + of a + Web proxy server, you will have to tell DS9 about this server. + Click the <b>Configure Web Proxy</b> button and type the relevant + information into the boxes. (Your systems administrator will be able to + tell you the details.) At this point, + you should be able to connect to a VO server successfully. Please let + us know if you have problems! </p> + <blockquote> + <p> <i>A final note: you may, of course, choose to use the Web + proxy + even + if your computer and firewall are configured to allow direct + connections. In this case, there is no need to configure the proxy + server.<br> + </i></p> + </blockquote> + </blockquote> + </body> +</html> diff --git a/ds9/doc/ref/xpa.html b/ds9/doc/ref/xpa.html new file mode 100644 index 0000000..db0c3de --- /dev/null +++ b/ds9/doc/ref/xpa.html @@ -0,0 +1,6216 @@ +<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; + charset=windows-1252"> + <meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux + 2.4.7-10 i686) [Netscape]"> + <title>XPA Access Points</title> + </head> + <body alink="#ff0000" link="#0000ff" vlink="#551a8b"> + <h3><img alt="" src="../sun.gif" align="middle" height="98" + width="100"> XPA Access Points</h3> + <blockquote> + <p>The <a href="http://hea-www.harvard.edu/RD/xpa/index.html">XPA + </a> messaging system provides seamless communication between + DS9 and other Unix programs, including X programs, Perl, <a + href="http://space.mit.edu/cxc/software/slang/modules/xpa/"> + S-Lang,</a> and Tcl/Tk. It also provides an easy way for users + to communicate with DS9 by executing XPA client commands in the + shell or by utilizing such commands in scripts. Because XPA + works both at the programming level and the shell level, it is a + powerful tool for unifying any analysis environment.</p> + <tt> <a href="#2mass">2mass</a><br> + <a href="#3d">3d</a><br> + <a href="#about">about</a><br> + <a href="#align">align</a><br> + <a href="#analysis">analysis</a><br> + <a href="#array">array</a><br> + <a href="#background">background</a><br> + <a href="#backup">backup</a><br> + <a href="#bin">bin</a><br> + <a href="#blink">blink</a><br> + <a href="#block">block</a><br> + <a href="#catalog">catalog</a><br> + <a href="#cd">cd</a><br> + <a href="#cmap">cmap</a><br> + <a href="#colorbar">colorbar</a><br> + <a href="#console">console</a><br> + <a href="#contour">contour</a><br> + <a href="#crop">crop</a><br> + <a href="#crosshair">crosshair</a><br> + <a href="#cube">cube</a><br> + <a href="#cursor">cursor</a><br> + <a href="#data">data</a><br> + <a href="#dsssao">dsssao</a><br> + <a href="#dsseso">dsseso</a><br> + <a href="#dssstsci">dssstsci</a><br> + <a href="#envi">envi</a><br> + <a href="#exit">exit</a><br> + <a href="#export">export</a><br> + <a href="#file">file</a><br> + <a href="#fits">fits</a><br> + <a href="#frame">frame</a><br> + <a href="#gif">gif</a><br> + <a href="#grid">grid</a><br> + <a href="#header">header</a><br> + <a href="#height">height</a><br> + <a href="#iconify">iconify</a><br> + </tt><tt><tt><a href="#iexam">iexam</a><br> + </tt><a href="#iis">iis</a><br> + <a href="#jpeg">jpeg</a><br> + <a href="#lock">lock</a><br> + <a href="#lower">lower</a><br> + <a href="#magnifier">magnifier</a><br> + <a href="#mask">mask</a><br> + <a href="#match">match</a><br> + <a href="#mecube">mecube</a><br> + <a href="#minmax">minmax</a><br> + <a href="#mode">mode</a><br> + <a href="#mosaic">mosaic</a><br> + <a href="#mosaicimage">mosaicimage</a><br> + <a href="#movie">movie</a><br> + <a href="#multiframe">multiframe</a><br> + <a href="#nameserver">nameserver</a><br> + <a href="#nrrd">nrrd</a><br> + <a href="#nvss">nvss</a><br> + <a href="#orient">orient</a><br> + <a href="#pagesetup">pagesetup</a><br> + <a href="#pan">pan</a><br> + <a href="#pixeltable">pixeltable</a><br> + <a href="#plot">plot</a><br> + <a href="#png">png</a><br> + <a href="#prefs">prefs</a><br> + <a href="#preserve">preserve</a><br> + <a href="#print">psprint</a><br> + <a href="#print">print</a><br> + <a href="#exit">quit</a><br> + <a href="#raise">raise</a><br> + <a href="#regions">regions</a><br> + <a href="#restore">restore</a><br> + <a href="#rgb">rgb</a><br> + <a href="#rgbarray">rgbarray</a><br> + <a href="#rgbcube">rgbcube</a><br> + <a href="#rgbimage">rgbimage</a><br> + <a href="#rotate">rotate</a><br> + <a href="#save">save</a><br> + <a href="#saveimage">saveimage</a><br> + <a href="#scale">scale</a><br> + <a href="#shm">shm</a></tt><br> + <tt><tt><a href="#sia">sia</a><br> + </tt> <a href="#single">single</a><br> + <a href="#skyview">skyview</a><br> + <a href="#sleep">sleep</a><br> + <a href="#smooth">smooth</a><br> + <a href="#source">source</a><br> + <a href="#tcl">tcl</a><br> + <a href="#threads">threads</a><br> + <a href="#tile">tile</a><br> + <a href="#update">update</a><br> + <a href="#url">url</a><br> + <a href="#version">version</a><br> + <a href="#view">view</a><br> + <a href="#vla">vla</a></tt><br> + <tt><tt><a href="#vlss">vlss</a><br> + </tt> <a href="#vo">vo</a><br> + <a href="#wcs">wcs</a><br> + <a href="#web">web</a><br> + <a href="#width">width</a><br> + <a href="#xpa">xpa</a><br> + <a href="#zscale">zscale</a><br> + <a href="#zoom">zoom</a><br> + </tt> + <p><b> <a name="2mass"></a>2mass</b></p> + <p> Support for 2MASS Digital Sky Survey.</p> + <tt> Syntax: <br> + 2mass []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> <dec> + degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [survey j|h|k]<br> + </tt><tt> [open|close]<br> + </tt><tt> <br> + Example:<br> + $xpaget ds9 2mass name <br> + $xpaget ds9 2mass coord <br> + $xpaget ds9 2mass size<br> + $xpaget ds9 2mass save<br> + $xpaget ds9 2mass frame<br> + $xpaget ds9 2mass survey <br> + $xpaset -p ds9 2mass<br> + </tt><tt>$xpaset -p ds9 2mass m31<br> + $xpaset -p ds9 2mass name m31 <br> + $xpaset -p ds9 2mass coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + $xpaset -p ds9 2mass size 60 60 arcmin<br> + $xpaset -p ds9 2mass save yes<br> + $xpaset -p ds9 2mass frame current<br> + $xpaset -p ds9 2mass update frame<br> + $xpaset -p ds9 2mass survey j<br> + </tt><tt>$xpaset -p ds9 2mass open<br> + $xpaset -p ds9 2mass close</tt><br> + <p><b> <a name="3d"></a>3d</b></p> + <p> Support for 3D frame.</p> + <tt> Syntax: <br> + 3d []<br> + [view <az> <el>]<br> + [az <az>]<br> + [el <el>]<br> + [scale <scale>]<br> + [method mip|aip]</tt><br> + <tt><tt> [background none|azimuth|elevation]<br> + </tt> </tt><tt> [border yes|no]<br> + [border color <color>]</tt><br> + <tt> </tt><tt> [highlite yes|no]<br> + [highlite color <color>]<br> + </tt><tt> [open|close]<br> + </tt><tt> <br> + Example:<br> + $xpaget ds9 3d view<br> + $xpaget ds9 3d az<br> + $xpaget ds9 3d el<br> + $xpaget ds9 3d scale<br> + $xpaget ds9 3d method<br> + </tt><tt>$xpaget ds9 3d background<br> + </tt><tt>$xpaget ds9 3d border<br> + $xpaget ds9 3d border color</tt><br> + <tt>$xpaget ds9 3d highlite<br> + $xpaget ds9 3d highlite color<br> + $xpaset -p ds9 3d # create new 3D frame<br> + $xpaset -p ds9 3d view 45 30<br> + $xpaset -p ds9 3d az 45<br> + $xpaset -p ds9 3d el 30<br> + $xpaset -p ds9 3d scale 10<br> + $xpaset -p ds9 3d method mip</tt><br> + <tt>$xpaset -p ds9 3d background azimuth<br> + </tt><tt>$xpaset -p ds9 3d border yes<br> + $xpaset -p ds9 3d border color red</tt><br> + <tt>$xpaset -p ds9 3d highlite yes<br> + $xpaset -p ds9 3d highlite color red<br> + $xpaset -p ds9 3d open<br> + $xpaset -p ds9 3d close<br> + </tt> + <p><b><a name="about"></a>about</b></p> + <p>Get DS9 credits. </p> + <tt> Syntax: <br> + about <br> + <br> + Example: <br> + $xpaget ds9 about<br> + </tt> + <p><b> <a name="align"></a>align</b></p> + <p>Controls the World Coordinate System alignment for the current + frame.</p> + <tt> Syntax: <br> + align []<br> + [yes|no]<br> + <br> + Example: <br> + $xpaget ds9 align<br> + $xpaset -p ds9 align yes<br> + </tt> + <p><b> <a name="analysis"></a>analysis</b></p> + <p>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. </p> + <tt> Syntax: <br> + analysis [<task number>]<br> + + [<filename>]<br> + [task <task + number>|<task name>]<br> + [load + <filename>]<br> + [clear]<br> + [clear][load + <filename>]<br> + [message + ok|okcancel|yesno <message>]<br> + [entry + <message>]<br> + [text]</tt><tt><tt><br> + <br> + </tt> Example: <br> + $xpaget ds9 analysis<br> + $xpaget ds9 analysis task<br> + $xpaget ds9 analysis entry 'Please enter something'<br> + $xpaget ds9 analysis entry okcancel 'Please enter something'<br> + $xpaset -p ds9 analysis 0 # invoke first analysis task<br> + $xpaset -p ds9 analysis task 0<br> + $xpaset -p ds9 analysis task foobar<br> + $xpaset -p ds9 analysis "{foo bar}"<br> + $xpaset -p ds9 analysis my.ans<br> + $xpaset -p ds9 analysis load my.ans <br> + $xpaset -p ds9 analysis clear <br> + $xpaset -p ds9 analysis clear load my.ans<br> + $xpaset -p ds9 analysis message ok {This is a message}<br> + $xpaset -p ds9 analysis text {this is text}<br> + $cat my.ans | xpaset ds9 analysis load <br> + $cat foo.txt | xpaset ds9 analysis text <br> + </tt> + <p><b> <a name="array"></a>array</b></p> + <p>Load raw data array into current frame.<br> + </p> + <tt> Syntax:<br> + array [native|big|little]<br> + array [new|mask] +[[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,endian=[little|big]]<br> + <br> + Example: <br> + $xpaget ds9 array > foo.arr<br> + $xpaget ds9 array little > foo.arr<br> + $xpaset -p ds9 array foo.arr[dim=512,bitpix=-32,endian=little]<br> + $xpaset -p ds9 array new foo.arr[dim=512,bitpix=</tt><tt>-32,endian=little]</tt><br> + <tt><tt>$xpaset -p ds9 array mask foo.arr[dim=512,bitpix=</tt></tt><tt>-32,endian=little]</tt><br> + <tt>$cat foo.arr | xpaset ds9 array + [dim=512,bitpix=-32,endian=little]</tt><br> + <tt>$cat foo.arr | xpaset ds9 array new + [dim=512,bitpix=-32,endian=little]</tt><br> + <tt>$cat foo.arr | xpaset ds9 array mask + [dim=512,bitpix=-32,endian=little]</tt> <tt> </tt> + <p><b> <a name="background"></a>bg<br> + background</b></p> + <p>Set image background color. </p> + <tt> Syntax: <br> + bg <color><br> + <br> + Example:<br> + $xpaget ds9 bg</tt><tt><br> + <tt>$xpaset -p ds9 bg red</tt><br> + </tt> + <p><b> <a name="backup"></a>backup</b></p> + <p>Create a backup save set. </p> + <tt> Syntax: <br> + backup <filename><br> + <br> + Example:<br> + $xpaset -p ds9 backup ds9.bck</tt><br> + <p><b> <a name="bin"></a>bin</b></p> + <p>Controls binning factor, binning buffer size, and binning + function for binning FITS bin tables. The access point blocking + is provided for backward compatibility. </p> + <tt> Syntax: <br> + bin [about <x> <y>]<br> + [about center]<br> + [buffersize <value>] <br> + [cols <x> <y>]<br> + [colsz <x> <y> <z>]<br> + [factor <value> [<vector>]]<br> + [depth <value>] <br> + [filter <string>] <br> + [function average|sum]<br> + [in]<br> + [out]<br> + [to fit] <br> + [match]<br> + [lock [yes|no]]<br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 bin about<br> + $xpaget ds9 bin buffersize<br> + $xpaget ds9 bin cols<br> + $xpaget ds9 bin factor<br> + $xpaget ds9 bin depth<br> + $xpaget ds9 bin filter<br> + $xpaget ds9 bin function<br> + $xpaget ds9 bin smooth<br> + $xpaget ds9 bin smooth function<br> + $xpaget ds9 bin smooth radius<br> + $xpaget ds9 bin lock<br> + $xpaset -p ds9 bin about 4096 4096<br> + $xpaset -p ds9 bin about center<br> + $xpaset -p ds9 bin buffersize 512<br> + $xpaset -p ds9 bin cols detx dety<br> + $xpaset -p ds9 bin colsz detx dety time<br> + $xpaset -p ds9 bin factor 4<br> + $xpaset -p ds9 bin factor 4 2<br> + $xpaset -p ds9 bin depth 10<br> + $xpaset -p ds9 bin filter 'pha > 5'<br> + $xpaset -p ds9 bin filter ''<br> + $xpaset -p ds9 bin function sum<br> + $xpaset -p ds9 bin in<br> + $xpaset -p ds9 bin out<br> + $xpaset -p ds9 bin to fit<br> + $xpaset -p ds9 bin match<br> + $xpaset -p ds9 bin lock yes<br> + $xpaset -p ds9 bin open<br> + $xpaset -p ds9 bin close</tt><tt><br> + </tt> + <p><b> <a name="blink"></a>blink</b></p> + <p>Blink mode parameters. Interval is in seconds. <br> + </p> + <tt> Syntax: <br> + blink []<br> + [yes|no]<br> + [interval <value>]<br> + <br> + Example: <br> + $xpaget ds9 blink<br> + $xpaget ds9 blink interval<br> + $xpaset -p ds9 blink<br> + $xpaset -p ds9 blink yes<br> + $xpaset -p ds9 blink interval 1</tt><br> + <p><b> <a name="block"></a>block</b></p> + <p>Controls blocking parameters. </p> + <tt> Syntax: <br> + block</tt><tt><tt> [<value>] <br> + [<value> <value>]<br> + [to <value>] <br> + [to <value> + <value>]<br> + [in]<br> + [out]<br> + </tt> [to fit] <br> + [match]<br> + [lock [yes|no]]<br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 block<br> + $xpaget ds9 block lock<br> + </tt><tt>$xpaset -p ds9 </tt><tt><tt><tt>block</tt></tt> 4<br> + $xpaset -p ds9 </tt><tt><tt><tt>block</tt></tt> 4 2<br> + </tt><tt><tt><tt>$xpaset -p ds9 </tt><tt><tt><tt>block</tt></tt> + to 4<br> + $xpaset -p ds9 </tt><tt><tt><tt>block</tt></tt> to 4 2<br> + </tt>$xpaset -p ds9 </tt><tt><tt><tt>block</tt></tt> in<br> + </tt></tt><tt><tt><tt>$xpaset -p ds9 </tt><tt><tt><tt>block</tt></tt> + out<br> + </tt></tt>$xpaset -p ds9 </tt><tt><tt><tt>block</tt></tt> to + fit<br> + $xpaset -p ds9 </tt><tt><tt><tt>block</tt></tt> match<br> + $xpaset -p ds9 </tt><tt><tt><tt>block</tt></tt> lock yes<br> + $xpaset -p ds9 </tt><tt><tt><tt>block</tt></tt> open<br> + $xpaset -p ds9 </tt><tt><tt><tt>block</tt></tt> close</tt><tt><br> + </tt> + <p><b> <a name="catalog"></a>catalog<br> + cat<br> + </b></p> + <p>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.</p> + <tt> Syntax: <br> + catalog []<br> + + [ned|simbad|denis|skybot]<br> + + [ascss|cmc|gsc1|gsc2|gsc3|ac|nomad|ppmx|sao|sdss5|sdss6|</tt><tt>sdss7|sdss8|</tt><tt>tycho|ua2|ub1|ucac2]<br> + [2mass|iras]<br> + [csc|xmm|rosat]<br> + [first|nvss]<br> + + [chandralog|cfhtlog|esolog|stlog|xmmlog]<br> + [cds <catalogname>]<br> + [cds + <catalogid>]<br> + <br> + [load <filename>]<br> + [import sb|tsv + <filename>]<br> + <br> + </tt><tt> [<ref>] [allcols]<br> + </tt><tt> </tt><tt> + [<ref>] [allrows]<br> + </tt><tt> [<ref>] + [cancel]<br> + </tt><tt> [<ref>] + [clear]<br> + </tt><tt> [<ref>] [close]</tt><br> + <tt> [<ref>] + [coordinate <ra> <dec> <coordsys>]</tt><tt><br> + </tt><tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [crosshair]</tt><br> + <tt> [<ref>] [dec + <col>]</tt><br> + <tt> [<ref>] [edit + yes|no]</tt><br> + <tt> [<ref>] + [export sb|tsv <filename>]<br> + </tt><tt> [<ref>] + [filter <string>]<br> + [<ref>] [filter load + <filename>]</tt><br> + <tt> [<ref>] + [header]</tt><br> + <tt> [<ref>] [hide]</tt><br> + <tt> [<ref>] [location + <code>]</tt><br> + <tt> [<ref>] + [match <ref> <ref>]<br> + </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match error <value> degrees|arcmin|arcsec]</tt><br> + <tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match function 1and2|1not2|2not1]<br> + </tt><tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match return 1and2|1only|2only]</tt><br> + <tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [match unique yes|no]</tt><br> + <tt> [<ref>] [maxrows + <number>]</tt><br> + <tt> [<ref>] [name + <object>]<br> + </tt><tt> [<ref>] + [panto yes|no]</tt><br> + <tt> [<ref>] [plot + <xcol> <ycol> <xerrcol> <yerrcol>]</tt><br> + <tt> [<ref>] [print]</tt><br> + <tt> [<ref>] [psky + <skyframe>]</tt><br> + <tt> [<ref>] [psystem + <coordsys>]</tt><br> + <tt> [<ref>] [ra + <col>]<br> + [<ref>] [regions]</tt><br> + <tt> [<ref>] [retrieve]</tt><br> + <tt> [<ref>] [samp]<br> + [<ref>] [samp + broadcast]<br> + [<ref>] [samp + send <application>]</tt><tt><br> + </tt><tt> [<ref>] + [save <filename>]</tt><br> + <tt> [<ref>] + [server cds|sao|cadc|adac|iucaa|bejing|cambridge|ukirt]</tt><br> + <tt> [<ref>] [show]</tt><br> + <tt> [<ref>] [size + <width> <height> degrees|arcmin|arcsec]</tt><br> + <tt> </tt><tt> [<ref>] + [sky <skyframe>]<br> + </tt><tt> [<ref>] + [skyformat <skyformat>]<br> + </tt><tt> [<ref>] [sort + <col> incr|decr]</tt><br> + <tt> [<ref>] [symbol + [#] + condition|shape|color|text|font|fontsize|fontweight|fontslant + <value>] <br> + </tt><tt> [<ref>] + [symbol [#] text|size|size2|units|angle <value>] <br> + </tt><tt> [<ref>] + [symbol shape {circle point}|{box point}|{diamond point}|<br> + + {cross point}|{x point}|{arrow + point}|{boxcircle point}|<br> + + circle|ellipse|box|text]<br> + [<ref>] [symbol + add| [#] remove]<br> + [<ref>] [symbol + save|load <filename>]</tt><br> + <tt> [<ref>] [system + <coordsys>]</tt><tt><br> + </tt><tt> </tt><tt>[<ref>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [update]</tt><br> + <tt> [<ref>] [x + <col>]</tt><br> + <tt> [<ref>] [y + <col>]</tt><br> + <tt> <br> + Example: <br> + $xpaget ds9 catalog<br> + </tt><tt>$xpaget ds9 catalog header</tt><br> + <tt><br> + $xpaset -p ds9 catalog<br> + $xpaset -p ds9 catalog 2mass<br> + $xpaset -p ds9 catalog cds 2mass<br> + $xpaset -p ds9 catalog cds "I/252"<br> + <br> + </tt><tt>$xpaset -p ds9 catalog load foo.xml<br> + $xpaset -p ds9 catalog import tsv foo.tsv<br> + <br> + </tt><tt>$xpaset -p ds9 catalog allrows<br> + $xpaset -p ds9 catalog allcols<br> + </tt><tt>$xpaset -p ds9 catalog cancel<br> + </tt><tt>$xpaset -p ds9 catalog clear<br> + </tt><tt>$xpaset -p ds9 catalog close<br> + </tt><tt>$xpaset -p ds9 catalog coordinate 202.48 47.21 fk5<br> + </tt><tt>$xpaset -p ds9 catalog crosshair<br> + </tt><tt>$xpaset -p ds9 catalog dec DEC<br> + </tt><tt>$xpaset -p ds9 catalog edit yes<br> + </tt><tt>$xpaset -p ds9 catalog export tsv bar.tsv<br> + </tt><tt>$xpaset -p ds9 catalog filter '$Jmag>10'<br> + $xpaset -p ds9 catalog filter load foo.flt<br> + $xpaset -p ds9 catalog header<br> + </tt><tt>$xpaset -p ds9 catalog hide<br> + </tt><tt>$xpaset -p ds9 catalog location 500</tt><br> + <tt>$xpaset -p ds9 catalog match error 2 arcsec<br> + $xpaset -p ds9 catalog match function 1and2<br> + $xpaset -p ds9 catalog match unique no<br> + $xpaset -p ds9 catalog match return 1only<br> + $xpaset -p ds9 catalog match 2mass csc<br> + </tt><tt>$xpaset -p ds9 catalog maxrows 2000<br> + </tt><tt>$xpaset -p ds9 catalog name m51<br> + $xpaset -p ds9 catalog panto no<br> + </tt><tt>$xpaset -p ds9 catalog plot '$Jmag' '$Hmag' '$e_Jmag' + '$e_Hmag'<br> + </tt><tt>$xpaset -p ds9 catalog print</tt><br> + <tt>$xpaset -p ds9 catalog psky fk5</tt><br> + <tt>$xpaset -p ds9 catalog psystem wcs</tt><br> + <tt>$xpaset -p ds9 catalog ra RA<br> + $xpaset -p ds9 catalog regions</tt><br> + <tt>$xpaset -p ds9 catalog retrieve<br> + </tt><tt> $xpaset -p ds9 catalog samp broadcast<br> + $xpaset -p ds9 catalog samp send aladin<br> + $xpaset -p ds9 catalog save foo.xml<br> + </tt><tt>$xpaset -p ds9 catalog server sao<br> + </tt><tt>$xpaset -p ds9 catalog show</tt><br> + <tt>$xpaset -p ds9 catalog size 1 1 degrees</tt><br> + <tt>$xpaset -p ds9 catalog symbol condition '$Jmag>15'<br> + $xpaset -p ds9 catalog symbol 2 shape "boxcircle point"<br> + $xpaset -p ds9 catalog symbol color red<br> + $xpaset -p ds9 catalog symbol font times<br> + </tt><tt>$xpaset -p ds9 catalog symbol fontsize 14<br> + </tt><tt>$xpaset -p ds9 catalog symbol fontweight bold<br> + </tt><tt>$xpaset -p ds9 catalog symbol fontslant italic<br> + </tt><tt>$xpaset -p ds9 catalog symbol add<br> + $xpaset -p ds9 catalog symbol 2 remove<br> + $xpaset -p ds9 catalog symbol load foo.sym<br> + $xpaset -p ds9 catalog symbol save bar.sym</tt><tt><br> + $xpaset -p ds9 catalog sky fk5<br> + $xpaset -p ds9 catalog skyformat degrees<br> + </tt><tt>$xpaset -p ds9 catalog sort "Jmag" incr<br> + </tt><tt>$xpaset -p ds9 catalog system wcs</tt><tt><br> + </tt><tt>$xpaset -p ds9 catalog update<br> + </tt><tt>$xpaset -p ds9 catalog x RA<br> + $xpaset -p ds9 catalog y DEC</tt><br> + <p><b> <a name="cd"></a>cd</b></p> + <p>Sets/Returns the current working directory. </p> + <tt> Syntax: <br> + cd [<directory>] <br> + <br> + Example: <br> + $xpaget ds9 cd<br> + $xpaset -p ds9 cd /home/mrbill<br> + </tt> + <p><b> <a name="cmap"></a>cmap</b></p> + <p>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. </p> + <tt> Syntax: <br> + cmap [<colormap>]<br> + [file]<br> + [load <filename>] <br> + </tt><tt> [save <filename>] <br> + </tt><tt> [invert yes|no] <br> + [value <constrast> <bias>] + <br> + [tag [load|save] <filename>]<br> + [tag delete]<br> + </tt><tt> [match]<br> + [lock [yes|no]]</tt><br> + <tt> [open|close]<br> + <br> + Example: <br> + $xpaget ds9 cmap <br> + $xpaget ds9 cmap file <br> + $xpaget ds9 cmap invert <br> + $xpaget ds9 cmap value <br> + </tt><tt>$xpaget ds9 cmap lock</tt><br> + <tt> $xpaset -p ds9 cmap Heat <br> + $xpaset -p ds9 cmap load foo.sao <br> + </tt><tt>$xpaset -p ds9 cmap save bar.sao <br> + </tt><tt>$xpaset -p ds9 cmap invert yes <br> + $xpaset -p ds9 cmap value 5 .5<br> + $xpaset -p ds9 cmap tag load foo.tag<br> + $xpaset -p ds9 cmap tag save foo.tag<br> + $xpaset -p ds9 cmap tag delete<br> + </tt><tt>$xpaset -p ds9 cmap match<br> + $xpaset -p ds9 cmap lock yes</tt><br> + <tt> $xpaset -p ds9 cmap open<br> + $xpaset -p ds9 cmap close<br> + </tt> + <p><b> <a name="colorbar"></a>colorbar<br> + </b></p> + <p>Controls colorbar parameters.</p> + <tt> Syntax: <br> + colorbar []<br> + [yes|no]<br> + + [horizontal|vertical]<br> + [orientation + horizontal|vertical]<br> + [numerics + yes|no]<br> + [space + value|distance] <br> + [font + times|helvetica|courier]<br> + [fontsize + <value>]<br> + [fontweight + normal|bold]<br> + [fontslant + roman|italic]<br> + [size]<br> + [ticks]<br> + <br> + Example: <br> + $xpaget ds9 colorbar<br> + $xpaget ds9 colorbar orientation<br> + $xpaget ds9 colorbar numerics<br> + $xpaget ds9 colorbar space<br> + $xpaget ds9 colorbar font<br> + $xpaget ds9 colorbar fontsize<br> + $xpaget ds9 colorbar fontweight<br> + $xpaget ds9 colorbar fontslant<br> + $xpaget ds9 colorbar size<br> + $xpaget ds9 colorbar ticks<br> + $xpaset -p ds9 colorbar yes<br> + $xpaset -p ds9 colorbar vertical<br> + $xpaset -p ds9 colorbar orientation vertical<br> + $xpaset -p ds9 colorbar numerics yes<br> + $xpaset -p ds9 colorbar space value<br> + $xpaset -p ds9 colorbar font times<br> + $xpaset -p ds9 colorbar fontsize 14<br> + $xpaset -p ds9 colorbar fontweight bold<br> + $xpaset -p ds9 colorbar fontslant italic<br> + $xpaset -p ds9 colorbar size 20<br> + $xpaset -p ds9 colorbar ticks 11<br> + </tt> + <p><b> <a name="console"></a>console</b></p> + <p>Display tcl console window.</p> + <tt> Syntax: <br> + -console<br> + <br> + Example:<br> + $xpaset -p ds9 console<br> + </tt> + <p><b> <a name="contour"></a>contour<br> + </b></p> + <p>Controls contours in the current frame. </p> + <tt> Syntax: <br> + contour []<br> + [yes|no]<br> + [<coordsys> + [<skyframe>]]<br> + [clear]<br> + [generate]<br> + [load + <filename> [<color> <width> yes|no]]<br> + [save <filename> + <coordsys> <skyframe>]<br> + [convert]<br> + [loadlevels + <filename>]<br> + [savelevels + <filename>]<br> + [copy]<br> + [paste + <coordsys> [<color> <width> yes|no]]<br> + [color <color>]<br> + [width <width>]<br> + [dash yes|no]<br> + [smooth <smooth>]<br> + [method block|smooth]<br> + [nlevels <number of + levels>]<br> + [scale + linear|log|pow|squared|sqrt|asinh|sinh|histequ]<br> + [log exp <value>]<br> + [mode + minmax|<value>|zscale|zmax]<br> + [limits <min> + <max>]<br> + [levels <value + value value...>] <br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 contour<br> + $xpaget ds9 contour wcs fk5<br> + $xpaget ds9 contour color<br> + $xpaget ds9 contour width<br> + $xpaget ds9 contour dash<br> + $xpaget ds9 contour smooth<br> + $xpaget ds9 contour method<br> + $xpaget ds9 contour nlevels<br> + $xpaget ds9 contour scale<br> + $xpaget ds9 contour log exp<br> + $xpaget ds9 contour mode<br> + $xpaget ds9 contour limits<br> + $xpaget ds9 contour levels<br> + $xpaset -p ds9 contour<br> + $xpaset -p ds9 contour yes<br> + $xpaset -p ds9 contour clear<br> + $xpaset -p ds9 contour generate<br> + </tt><tt><tt>$xpaset -p ds9 contour load ds9.ctr<br> + </tt></tt><tt>$xpaset -p ds9 contour load ds9.ctr red 2 yes<br> + $xpaset -p ds9 contour save ds9.ctr wcs fk5<br> + $xpaset -p ds9 contour convert<br> + $xpaset -p ds9 contour loadlevels ds9.ctr</tt><br> + <tt><tt>$xpaset -p ds9 contour savelevels ds9.lev<br> + </tt> $xpaset -p ds9 contour copy<br> + $xpaset -p ds9 contour paste wcs red 2 no<br> + $xpaset -p ds9 contour color yellow<br> + $xpaset -p ds9 contour width 2<br> + $xpaset -p ds9 contour dash yes<br> + $xpaset -p ds9 contour smooth 5<br> + $xpaset -p ds9 contour method smooth<br> + $xpaset -p ds9 contour nlevels 10<br> + $xpaset -p ds9 contour scale sqrt<br> + $xpaset -p ds9 contour log exp 1000<br> + $xpaset -p ds9 contour mode zscale<br> + $xpaset -p ds9 contour limits 1 100<br> + $xpaset -p ds9 contour levels "{1 10 100 1000}"<br> + $xpaset -p ds9 contour open<br> + $xpaset -p ds9 contour close<br> + </tt> + <p><b><a name="crop"></a>crop</b> </p> + <p>Set current image display area. </p> + <tt> Syntax: <br> + crop [<x> <y> <width> <height> + [<coordsys>][<skyframe>][<skyformat>][degrees|arcmin|arcsec] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <br> + [match <coordsys>]<br> + [lock <coordsys>|none]<br> + <br> + Example: <br> + $xpaget ds9 crop # get crop in physical coords <br> + $xpaget ds9 crop wcs galactic sexagesimal arcsec<br> + $xpaget ds9 crop lock<br> + $xpaset -p ds9 crop 40 30 10 20 # set crop in physical coords<br> + $xpaset -p ds9 crop +104:51:06.915 +68:33:40.761 28.144405 + 22.000204 wcs galactic arcsec<br> + $xpaset -p ds9 crop match wcs<br> + $xpaset -p ds9 crop lock wcs</tt><br> + <p><b> <a name="crosshair"></a>crosshair</b></p> + <p>Controls the current position of the crosshair in the current + frame. DS9 is placed in crosshair mode when the crosshair is + set. </p> + <tt> Syntax: <br> + crosshair [<x> <y> <coordsys> + [<skyframe>][<skyformat>]]<br> + [match + <coordsys>]<br> + [lock + <coordsys>|none]<br> + <br> + Example: <br> + $xpaget ds9 crosshair # get crosshair in physical coords <br> + $xpaget ds9 crosshair wcs fk4 sexagesimal # get crosshair in wcs + coords <br> + $xpaget ds9 crosshair lock<br> + $xpaset -p ds9 crosshair 100 100 physical # set crosshair in + physical <br> + $xpaset -p ds9 crosshair 345 58.8 wcs fk5 # set crosshair in wcs + coords <br> + $xpaset -p ds9 crosshair 23:01:00 +58:52:51 wcs fk5<br> + $xpaset -p ds9 crosshair match wcs<br> + $xpaset -p ds9 crosshair lock wcs<br> + </tt> + <p><b> <a name="cube"></a>cube<br> + </b></p> + <p>Controls FITS cube dialog. </p> + <tt> Syntax: <br> + cube [play|stop|next|prev|first|last]<br> + [<slice> + [<coordsys>][<axis>]]<br> + [interval <numeric>]<br> + [axis <axis>]<br> + [match <coordsys>]<br> + [lock <coordsys>|none]<br> + [order 123|132|213|231|312|321]<br> + [axes lock [yes|no]]<br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 cube<br> + $xpaget ds9 cube interval<br> + $xpaget ds9 cube axis<br> + $xpaget ds9 cube lock<br> + $xpaget ds9 cube order<br> + $xpaget ds9 cube axes lock<br> + $xpaset -p ds9 cube play<br> + $xpaset -p ds9 cube last<br> + $xpaset -p ds9 cube 3<br> + $xpaset -p ds9 cube 4.4 wcs 3<br> + $xpaset -p ds9 cube interval 2<br> + $xpaset -p ds9 cube axis 3<br> + $xpaset -p ds9 cube match wcs<br> + $xpaset -p ds9 cube lock wcs<br> + $xpaset -p ds9 cube order 123<br> + $xpaset -p ds9 cube axes lock yes<br> + $xpaset -p ds9 cube open<br> + $xpaset -p ds9 cube close</tt><br> + <p><b> <a name="cursor"></a>cursor</b></p> + <p>Move mouse pointer or crosshair in image pixels in the current + frame. Note, this will move selected Regions also. </p> + <tt> Syntax: <br> + cursor [<x> <y>] <br> + <br> + Example: <br> + $xpaset -p ds9 cursor 10 10<br> + </tt> + <p><b> <a name="data"></a>data</b></p> + <p>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.</p> + <tt> Syntax: <br> + data [<coordsys> [<skyframe>] <x> <y> + <width> <height> [yes|no]]<br> + <br> + Example: <br> + $xpaget ds9 data image 450 520 3 3 yes<br> + $xpaget ds9 data physical 899 1039 6 6 no<br> + $xpaget ds9 data fk5 202.47091 47.196811 0.00016516669 + 0.00016516669 no<br> + $xpaget ds9 data wcs fk5 13:29:53.018 +47:11:48.52 0.00016516669 + 0.00016516669 no</tt><tt><br> + </tt> + <p><b> <a name="dsssao"></a>dsssao<br> + dss<br> + </b></p> + <p>Support for Digital Sky Survey at SAO. </p> + <tt> Syntax:<br> + dsssao []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> + <dec> degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 dsssao name <br> + $xpaget ds9 dsssao coord <br> + $xpaget ds9 dsssao size<br> + $xpaget ds9 dsssao save<br> + $xpaget ds9 dsssao frame<br> + $xpaset -p ds9 dsssao<br> + $xpaset -p ds9 dsssao m31 <br> + $xpaset -p ds9 dsssao name m31 <br> + $xpaset -p ds9 dsssao coord 00:42:44.404 +41:16:08.78 + sexagesimal<br> + $xpaset -p ds9 dsssao size 60 60 arcmin<br> + $xpaset -p ds9 dsssao save yes<br> + $xpaset -p ds9 dsssao frame current<br> + $xpaset -p ds9 dsssao update frame<br> + $xpaset -p ds9 dsssao open<br> + </tt><tt>$xpaset -p ds9 dsssao close</tt><br> + <p><b> <a name="dsseso"></a>dsseso</b></p> + <p>Support for Digital Sky Survey at ESO. </p> + <tt> Syntax:<br> + dsseso []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> + <dec> degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [survey + DSS1|DSS2-red|DSS2-blue|DSS2-infrared]<br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 dsseso name <br> + $xpaget ds9 dsseso coord <br> + $xpaget ds9 dsseso size<br> + $xpaget ds9 dsseso save<br> + $xpaget ds9 dsseso frame<br> + $xpaget ds9 dsseso survey<br> + $xpaset -p ds9 dsseso<br> + $xpaset -p ds9 dsseso m31 <br> + $xpaset -p ds9 dsseso name m31 <br> + $xpaset -p ds9 dsseso coord 00:42:44.404 +41:16:08.78 + sexagesimal<br> + $xpaset -p ds9 dsseso size 60 60 arcmin<br> + $xpaset -p ds9 dsseso save yes<br> + $xpaset -p ds9 dsseso frame current<br> + $xpaset -p ds9 dsseso update frame<br> + $xpaset -p ds9 dsseso survey DSS2-red <br> + $xpaset -p ds9 dsseso open<br> + </tt><tt>$xpaset -p ds9 dsseso close</tt><br> + <p><b> <a name="dssstsci"></a>dssstsci</b></p> + <p>Support for Digital Sky Survey at STSCI.</p> + <tt> Syntax:<br> + dssstsci []<br> + + [<object>]<br> + [name <object>]<br> + [coord + <ra> <dec> degrees|sexagesimal] # in wcs fk5<br> + [size + <width> <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame + new|current]<br> + [update + frame|crosshair]<br> + [survey + poss2ukstu_red|poss2ukstu_ir|poss2ukstu_blue] <br> + [survey + poss1_blue|poss1_red]<br> + [survey + all|quickv|phase2_gsc2|phase2_gsc1]<br> + [open|close]<br> + <br> + Example:<br> + $xpaget ds9 dssstsci name <br> + $xpaget ds9 dssstsci coord <br> + $xpaget ds9 dssstsci size<br> + $xpaget ds9 dssstsci save<br> + $xpaget ds9 dssstsci frame<br> + $xpaget ds9 dssstsci survey<br> + $xpaset -p ds9 dssstsci<br> + $xpaset -p ds9 dssstsci m31 <br> + $xpaset -p ds9 dssstsci name m31 <br> + $xpaset -p ds9 dssstsci coord 00:42:44.404 +41:16:08.78 + sexagesimal<br> + $xpaset -p ds9 dssstsci size 60 60 arcmin<br> + $xpaset -p ds9 dssstsci save yes<br> + $xpaset -p ds9 dssstsci frame current<br> + $xpaset -p ds9 dssstsci update frame<br> + $xpaset -p ds9 dssstsci survey all<br> + $xpaset -p ds9 dssstsci open<br> + $xpaset -p ds9 dssstsci close</tt><br> + <p><b> <a name="envi"></a>envi</b></p> + <p>Load an ENVI header and file. Optional parameter: array endian.<br> + </p> + <tt> Syntax: <br> + envi <header> [<filename>]<br> + <br> + Example:<br> + </tt><tt><tt>$xpaset -p ds9 envi foo.hdr</tt></tt><br> + <tt><tt><tt><tt><tt><tt>$xpaset -p ds9 envi foo.hdr foo.bsq</tt></tt><br> + $xpaset -p ds9 envi new foo.hdr foo.bsq</tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><br> + </tt></tt></tt></tt></tt></tt> + <p><b> <a name="exit"></a>exit<br> + quit<br> + </b></p> + <p>Quits DS9. </p> + <tt> Syntax: <br> + exit<br> + quit<br> + <br> + Example: <br> + $xpaset -p ds9 exit<br> + </tt> + <p><b> <a name="export"></a>export<br> + </b></p> + <p>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.</p> + <tt> Syntax: </tt><tt><br> + </tt><tt> export </tt><tt>[array|nrrd|envi|gif|tiff|jpeg|png] </tt><tt><filename></tt><tt><br> + </tt><tt>export array <filename></tt><tt> </tt><tt>[big|little</tt><tt>|native]<br> + </tt><tt>export nrrd <filename> </tt><tt>[big|little</tt><tt>|native]</tt><tt><br> + export envi <header> [<filename>] </tt><tt>[big|little</tt><tt>|native]</tt><tt> + </tt><tt><br> + export jpeg <filename></tt><tt> [1-100]</tt><tt><br> + </tt><tt> </tt><tt>export tiff <filename</tt><tt>></tt><tt> + [none|jpeg|packbits|deflate]</tt><br> + <tt> <br> + Example: <br> + </tt><tt><tt>$xpaset -p ds9 export array foo.arr little</tt></tt><br> + <tt><tt>$xpaset -p ds9 export nrrd foo.nrrd little</tt></tt><br> + <tt><tt><tt><tt><tt><tt>$xpaset -p ds9 export envi foo.hdr little</tt></tt><br> + </tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>$xpaset + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -p ds9 export envi foo.hdr foo.bsq little</tt></tt><br> + </tt></tt></tt></tt>$xpaset -p ds9 export tiff + foo.tiff jpeg</tt></tt></tt><br> + $xpaset -p ds9 export jpeg foo.jpeg 75<br> + $xpaset -p ds9 export png foo.png</tt><br> + <p><b> <a name="file"></a>file</b></p> + <p>Query currently loaded file information. </p> + <tt> Syntax:<br> + file <br> + <br> + Example: <br> + $xpaget ds9 file </tt><br> + <p><b> <a name="fits"></a>fits</b></p> + <p>Load a FITS image into the current frame or query the currently + loaded image.<br> + </p> + <tt> Syntax: <br> + fits </tt><tt><tt>[new|mask|slice] [<filename>]</tt><tt><br> + </tt> [width|height|depth|bitpix|type]<br> + [size [wcs|wcsa...wcsz] + [fk4|fk5|icrs|galactic|ecliptic] [degrees|arcmin|arcsecs]]<br> + [header [<ext>] [keyword + <string>]]<br> + [image|table|slice]</tt><tt><br> + <br> + Example: <br> + $xpaget ds9 fits > foo.fits<br> + $xpaget ds9 fits width<br> + $xpaget ds9 fits height<br> + $xpaget ds9 fits depth<br> + $xpaget ds9 fits bitpix</tt><br> + <tt>$xpaget ds9 fits type </tt><br> + <tt><tt>$xpaget ds9 fits size<br> + </tt> $xpaget ds9 fits size wcs fk5 arcmin<br> + $xpaget ds9 fits header # primary<br> + $xpaget ds9 fits header 2 # hdu 2<br> + $xpaget ds9 fits header -2 # hdu 2 with inherit<br> + $xpaget ds9 fits header keyword BITPIX<br> + $xpaget ds9 fits header 1 keyword BITPIX</tt><br> + <tt><tt>$xpaget ds9 fits image > foo.fits<br> + $xpaget ds9 fits table > bar.fits<br> + $xpaget ds9 fits slice > foo.fits<br> + </tt> $xpaset -p ds9 fits foo.fits<br> + $xpaset -p ds9 fits new foo.fits<br> + $xpaset -p ds9 fits bar.fits[bin=detx,dety]<br> + $xpaset -p ds9 fits slice foo.fits<br> + $xpaset -p ds9 fits mask foo.fits<br> + $cat foo.fits | xpaset ds9 fits <br> + $cat foo.fits | xpaset ds9 fits new<br> + $cat bar.fits | xpaset ds9 fits -[bin=detx,dety]<br> + $cat foo.fits | xpaset ds9 fits slice<br> + $cat foo.fits | xpaset ds9 fits mask<br> + </tt> + <p><b> <a name="frame"></a>frame</b></p> + <p>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. </p> + <tt> Syntax: <br> + frame [center [#|all]]<br> + [clear [#|all]]<br> + [new [rgb|3d]]<br> + [delete [#|all]] <br> + [reset [#|all]]<br> + [refresh [#|all]]<br> + [hide [#|all]]<br> + [show [#|all]]<br> + [move first]<br> + [move back]<br> + [move forward]<br> + [move last]<br> + [first]<br> + [prev]<br> + [next]<br> + [last]<br> + [frameno #]<br> + [#]<br> + </tt><tt> [match <coordsys>]<br> + [lock <coordsys>|none]</tt><br> + <tt> [has +[amplifier|datamin|datasec|detector|grid|iis|irafmin|physical|smooth]]<br> + [has contour [aux]]]<br> + [has fits [bin|cube|mosaic]]<br> + [has marker + [highlite|paste|select|undo]]<br> + [has system <coordsys>]<br> + [has wcs + [<wcssys>|equatorial <wcssys>|linear + <wcssys>]]<br> + <br> + Example: <br> + $xpaget ds9 frame # returns the id of the current frame <br> + $xpaget ds9 frame frameno # returns the id of the current frame + <br> + $xpaget ds9 frame all # returns the id of all frames <br> + $xpaget ds9 frame active # returns the id of all active frames<br> + </tt><tt>$xpaget ds9 frame lock</tt><br> + <tt> $xpaget ds9 frame has amplifier<br> + $xpaget ds9 frame has datamin<br> + $xpaget ds9 frame has datasec<br> + $xpaget ds9 frame has detector<br> + $xpaget ds9 frame has grid<br> + $xpaget ds9 frame has iis<br> + $xpaget ds9 frame has irafmin<br> + $xpaget ds9 frame has physical<br> + $xpaget ds9 frame has smooth<br> + $xpaget ds9 frame has contour<br> + $xpaget ds9 frame has contour aux<br> + $xpaget ds9 frame has fits<br> + $xpaget ds9 frame has fits bin<br> + $xpaget ds9 frame has fits cube<br> + $xpaget ds9 frame has fits mosaic<br> + $xpaget ds9 frame has marker highlite<br> + $xpaget ds9 frame has marker paste<br> + $xpaget ds9 frame has marker select<br> + $xpaget ds9 frame has marker undo<br> + $xpaget ds9 frame has system physical<br> + $xpaget ds9 frame has wcs wcsa<br> + $xpaget ds9 frame has wcs equatorial wcsa<br> + $xpaget ds9 frame has wcs linear wcsa<br> + $xpaset -p ds9 frame center # center current frame<br> + $xpaset -p ds9 frame center 1 # center 'Frame1' <br> + $xpaset -p ds9 frame center all # center all frames <br> + $xpaset -p ds9 frame clear # clear current frame<br> + $xpaset -p ds9 frame new # create new frame <br> + $xpaset -p ds9 frame new rgb # create new rgb frame<br> + $xpaset -p ds9 frame delete # delete current frame <br> + $xpaset -p ds9 frame reset # reset current frame <br> + $xpaset -p ds9 frame refresh # refresh current frame <br> + $xpaset -p ds9 frame hide # hide current frame <br> + $xpaset -p ds9 frame show 1 # show frame 'Frame1'<br> + $xpaset -p ds9 frame move first # move frame to first in order<br> + $xpaset -p ds9 frame move back # move frame back in order<br> + $xpaset -p ds9 frame move forward # move frame forward in order<br> + $xpaset -p ds9 frame move last # move frame to last in order<br> + $xpaset -p ds9 frame first # goto first frame <br> + $xpaset -p ds9 frame prev # goto prev frame <br> + $xpaset -p ds9 frame next # goto next frame<br> + $xpaset -p ds9 frame last # goto last frame<br> + $xpaset -p ds9 frame frameno 4 # goto frame 'Frame4', create if + needed<br> + $xpaset -p ds9 frame 3 # goto frame 'Frame3', create if needed <br> + $xpaset -p ds9 frame match wcs<br> + $xpaset -p ds9 frame lock wcs</tt><br> + <p><b> <a name="gif"></a>gif</b></p> + <p>Load GIF image into current frame.<br> + </p> + <tt> Syntax:<br> + gif [new|slice] [<filename>]<br> + <br> + Example: <br> + $xpaget ds9 gif > foo.gif</tt><br> + <tt>$xpaset -p ds9 gif foo.gif</tt><br> + <tt><tt>$xpaset -p ds9 gif new foo.gif<br> + </tt></tt><tt><tt><tt>$xpaset -p ds9 gif slice foo.gif<br> + </tt></tt>$cat foo.gif | xpaset ds9 gif # not available + windows</tt> <br> + <tt><tt>$cat foo.gif | xpaset ds9 gif</tt><tt> new # not available + windows<br> + </tt>$cat foo.gif | xpaset ds9 gif</tt><tt> slice</tt><tt><tt><tt> + # not available windows</tt></tt></tt> + <p><b> <a name="grid"></a>grid</b></p> + <p> Controls coordinate grid. For grid numeric format + syntax, click <a href="grid.html#Format">here</a>.</p> + <tt> Syntax: <br> + grid []<br> + [yes|no] <br> + [type analysis|publication] <br> + [system <coordsys>] <br> + [sky <skyframe>] <br> + [skyformat <skyformat>]<br> + [grid yes|no]<br> + [grid color <color>]<br> + [grid width <value>]<br> + [grid style 0|1]<br> + [grid gap1 <value>]<br> + [grid gap2 <value>]<br> + [axes yes|no]<br> + [axes color <color>]<br> + [axes width <value>]<br> + [axes style 0|1]<br> + [axes type interior|exterior]<br> + [axes origin + lll|llu|lul|luu|ull|ulu|uul|uuu]<br> + [format1 <format>]<br> + [format2 <format>]<br> + [tickmarks yes|no]<br> + [tickmarks color <color>]<br> + [tickmarks width <value>]<br> + [tickmarks style 0|1]<br> + [border yes|no]<br> + [border color <color>]<br> + [border width <value>]<br> + [border style 0|1]<br> + [numerics yes|no]<br> + [numerics font + times|helvetica|courier]<br> + [numerics fontsize <value>]<br> + [numerics fontweight normal|bold]<br> + [numerics fontslant roman|italic]<br> + [numerics color <color>]<br> + [numerics gap1 <value>]<br> + [numerics gap2 <value>]<br> + [numerics type interior|exterior]<br> + [numerics vertical yes|no]<br> + [title yes|no]<br> + [title text <text>]<br> + [title def yes|no]<br> + [title gap <value>]<br> + [title font + times|helvetica|courier]<br> + [title fontsize <value>]<br> + [title fontweight normal|bold]<br> + [title fontslant roman|italic]<br> + [title color <color>]<br> + [labels yes|no]<br> + [labels text1 <text>]<br> + [labels def1 yes|no]<br> + [labels gap1 <value>]<br> + [labels text2 <text>]<br> + [labels def2 yes|no]<br> + [labels gap2 <value>]<br> + [labels font + times|helvetica|courier]<br> + [labels fontsize <value>]<br> + [labels fontweight normal|bold]<br> + [labels fontslant roman|italic]<br> + [labels color <color>]<br> + [reset]<br> + [load <filename>] <br> + [save <filename>] <br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 grid <br> + $xpaget ds9 grid type <br> + $xpaget ds9 grid system <br> + $xpaget ds9 grid sky <br> + $xpaget ds9 grid skyformat <br> + $xpaget ds9 grid grid <br> + $xpaget ds9 grid grid color <br> + $xpaget ds9 grid grid width <br> + $xpaget ds9 grid grid style <br> + $xpaget ds9 grid grid gap1 <br> + $xpaget ds9 grid grid gap2 <br> + $xpaget ds9 grid axes <br> + $xpaget ds9 grid axes color <br> + $xpaget ds9 grid axes width <br> + $xpaget ds9 grid axes style <br> + $xpaget ds9 grid axes type <br> + $xpaget ds9 grid axes origin<br> + $xpaget ds9 grid format1<br> + $xpaget ds9 grid format2<br> + $xpaget ds9 grid tickmarks <br> + $xpaget ds9 grid tickmarks color <br> + $xpaget ds9 grid tickmarks width <br> + $xpaget ds9 grid tickmarks style <br> + $xpaget ds9 grid border <br> + $xpaget ds9 grid border color <br> + $xpaget ds9 grid border width <br> + $xpaget ds9 grid border style <br> + $xpaget ds9 grid numerics <br> + $xpaget ds9 grid numerics font <br> + $xpaget ds9 grid numerics fontsize <br> + $xpaget ds9 grid numerics fontweight<br> + $xpaget ds9 grid numerics fontslant<br> + $xpaget ds9 grid numerics color <br> + $xpaget ds9 grid numerics gap1 <br> + $xpaget ds9 grid numerics gap2 <br> + $xpaget ds9 grid numerics type <br> + $xpaget ds9 grid numerics vertical <br> + $xpaget ds9 grid title <br> + $xpaget ds9 grid title text<br> + $xpaget ds9 grid title def <br> + $xpaget ds9 grid title gap <br> + $xpaget ds9 grid title font <br> + $xpaget ds9 grid title fontsize <br> + $xpaget ds9 grid title fontweight<br> + $xpaget ds9 grid title fontslant<br> + $xpaget ds9 grid title color <br> + $xpaget ds9 grid labels <br> + $xpaget ds9 grid labels text1 <br> + $xpaget ds9 grid labels def1 <br> + $xpaget ds9 grid labels gap1 <br> + $xpaget ds9 grid labels text2 <br> + $xpaget ds9 grid labels def2 <br> + $xpaget ds9 grid labels gap2 <br> + $xpaget ds9 grid labels font <br> + $xpaget ds9 grid labels fontsize <br> + $xpaget ds9 grid labels fontweight<br> + $xpaget ds9 grid labels fontslant<br> + $xpaget ds9 grid labels color <br> + $xpaset -p ds9 grid <br> + $xpaset -p ds9 grid yes<br> + $xpaset -p ds9 grid type analysis <br> + $xpaset -p ds9 grid system wcs <br> + $xpaset -p ds9 grid sky fk5 <br> + $xpaset -p ds9 grid skyformat degrees<br> + $xpaset -p ds9 grid grid yes<br> + $xpaset -p ds9 grid grid color red<br> + $xpaset -p ds9 grid grid width 2<br> + $xpaset -p ds9 grid grid style 1<br> + $xpaset -p ds9 grid grid gap1 10<br> + $xpaset -p ds9 grid grid gap2 10<br> + $xpaset -p ds9 grid axes yes<br> + $xpaset -p ds9 grid axes color red<br> + $xpaset -p ds9 grid axes width 2<br> + $xpaset -p ds9 grid axes style 1<br> + $xpaset -p ds9 grid axes type exterior<br> + $xpaset -p ds9 grid axes origin lll<br> + $xpaset -p ds9 grid format1 d.2<br> + $xpaset -p ds9 grid format2 d.2<br> + $xpaset -p ds9 grid tickmarks yes<br> + $xpaset -p ds9 grid tickmarks color red<br> + $xpaset -p ds9 grid tickmarks width 2<br> + $xpaset -p ds9 grid tickmarks style 1<br> + $xpaset -p ds9 grid border yes<br> + $xpaset -p ds9 grid border color red<br> + $xpaset -p ds9 grid border width 2<br> + $xpaset -p ds9 grid border style 1<br> + $xpaset -p ds9 grid numerics yes<br> + $xpaset -p ds9 grid numerics font courier<br> + $xpaset -p ds9 grid numerics fontsize 12<br> + $xpaset -p ds9 grid numerics fontweight bold<br> + $xpaset -p ds9 grid numerics fontslant italic<br> + $xpaset -p ds9 grid numerics color red<br> + $xpaset -p ds9 grid numerics gap1 10<br> + $xpaset -p ds9 grid numerics gap2 10<br> + $xpaset -p ds9 grid numerics type exterior<br> + $xpaset -p ds9 grid numerics vertical yes<br> + $xpaset -p ds9 grid title yes<br> + $xpaset -p ds9 grid title text {Hello World}<br> + $xpaset -p ds9 grid title def yes<br> + $xpaset -p ds9 grid title gap 10<br> + $xpaset -p ds9 grid title font courier<br> + $xpaset -p ds9 grid title fontsize 12<br> + $xpaset -p ds9 grid title fontweight bold<br> + $xpaset -p ds9 grid title fontslant italic<br> + $xpaset -p ds9 grid title color red<br> + $xpaset -p ds9 grid labels yes<br> + $xpaset -p ds9 grid labels text1 {Hello World}<br> + $xpaset -p ds9 grid labels def1 yes<br> + $xpaset -p ds9 grid labels gap1 10<br> + $xpaset -p ds9 grid labels text2 {Hello World}<br> + $xpaset -p ds9 grid labels def2 yes<br> + $xpaset -p ds9 grid labels gap2 10<br> + $xpaset -p ds9 grid labels font courier<br> + $xpaset -p ds9 grid labels fontsize 12<br> + $xpaset -p ds9 grid labels fontweight boldj<br> + $xpaset -p ds9 grid labels fontslant italic<br> + $xpaset -p ds9 grid labels color red<br> + $xpaset -p ds9 grid reset<br> + $xpaset -p ds9 grid load foo.grd <br> + $xpaset -p ds9 grid save foo.grd<br> + $xpaset -p ds9 grid open<br> + $xpaset -p ds9 grid close<br> + </tt> + <p><b> <a name="header"></a>header</b></p> + <p>Display current fits header dialog. Optional extension number + maybe specified. Please note, this differs from xpa fits header.</p> + <tt> Syntax: <br> + header [<ext>]<br> + [close [<ext>]]<br> + [save [<ext>] + <filename>]<br> + <br> + Example:<br> + $xpaset -p ds9 header<br> + $xpaset -p ds9 header 2<br> + $xpaset -p ds9 header close<br> + $xpaset -p ds9 header save 1 foo.txt<br> + </tt> + <p><b> <a name="height"></a>height</b></p> + <p>Set the height of the image display window. </p> + <tt> Syntax: <br> + height [<value>]<br> + <br> + Example: <br> + $xpaget ds9 height<br> + $xpaset -p ds9 height 512<br> + </tt> + <p><b> <a name="iconify"></a>iconify</b></p> + <p>Toggles iconification. </p> + <tt> Syntax: <br> + iconify []<br> + [yes|no] <br> + <br> + Example: <br> + $xpaget ds9 iconify <br> + $xpaset -p ds9 iconify</tt><br> + <tt> $xpaset -p ds9 iconify yes</tt><br> + <p><b><a name="iexam"></a>iexam</b> </p> + <p>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 + <tt>button</tt>. In the last form, the following macros will be + expanded if present: <tt>$width, $height, $depth, $bitpix, + $filename, $regions, $filename[$regions], $env, $pan, $value, + $x, $y, $z.</tt> See <a href="analysis.html#macros">Analysis + Macros</a> for more information.<br> + </p> + <tt> Syntax: <br> + iexam []<br> + [[]|button|key|any] coordinate + <coordsys> [<skyframe>] [<skyformat>]<br> + [[]|button|key|any] data + [width][height]<br> + </tt><tt><tt> [[]|button|key|any] + <macro string>]<br> + </tt><br> + Example: <br> + $xpaget ds9 iexam # image coordinates<br> + </tt><tt><tt>$xpaget ds9 iexam coordinate image<br> + </tt>$xpaget ds9 iexam key coordinate image # return coordinate + and key event<br> + $xpaget ds9 iexam coordinate wcs fk5 degrees<br> + $xpaget ds9 iexam coordinate wcs galactic sexagesimal<br> + $xpaget ds9 iexam coordinate fk5<br> + $xpaget ds9 iexam data # return data value<br> + $xpaget ds9 iexam key data # return data value and key event<br> + $xpaget ds9 iexam data 3 3 # return all data in 3x3 box about + selected point<br> + $xpaget ds9 iexam 'Click at $x,$y in file $filename'</tt><br> + <p><b> <a name="iis"></a>iis</b></p> + <p>Set/Get IIS Filename. Optional mosaic number maybe supplied.</p> + <tt> Syntax: <br> + iis [filename <filename> [#]]<br> + <br> + Example: <br> + $xpaget ds9 iis filename<br> + $xpaget ds9 iis filename 4<br> + $xpaset -p ds9 iis filename foo.fits<br> + $xpaset -p ds9 iis filename bar.fits 4</tt><br> + <p><b> <a name="jpeg"></a>jpeg</b></p> + <p>Load JPEG image into current frame. Optional parameters: <tt>jpeg + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </tt>quality (1-100) </p> + <tt> Syntax:<br> + jpeg [new|slice] [<filename>] [1-100]<br> + <br> + Example: <br> + $xpaget ds9 jpeg > foo.jpeg</tt><br> + <tt><tt>$xpaget ds9 jpeg 100 > foo.jpeg</tt><br> + $xpaset -p ds9 jpeg foo.jpeg</tt><br> + <tt><tt>$xpaset -p ds9 jpeg new foo.jpeg<br> + </tt></tt><tt><tt><tt>$xpaset -p ds9 jpeg slice foo.jpeg<br> + </tt></tt>$cat foo.jpeg | xpaset ds9 jpeg </tt><tt><tt><tt> # + not available windows</tt></tt></tt><br> + <tt><tt>$cat foo.jpeg | xpaset ds9 jpeg</tt><tt> new</tt></tt><tt><tt><tt><tt> + # not available windows</tt></tt><br> + </tt>$cat foo.jpeg | xpaset ds9 jpeg</tt><tt> slice </tt><tt><tt><tt> + # not available windows</tt></tt></tt> + <p><b> <a name="lock"></a>lock</b></p> + <p>Lock all other frames to the current frame. </p> + <tt> Syntax: <br> + lock</tt><tt> </tt><tt>[frame <coordsys>|none]<br> + </tt><tt>[crosshair + <coordsys>|none] </tt><tt><br> + </tt><tt> [crop <coordsys>|none]</tt><br> + <tt> [slice <coordsys>|none]]<br> + </tt><tt> [bin [yes|no]]<br> + [axes [yes|no]]<br> + [scale [yes|no]]<br> + [scalelimites [yes|no]]<br> + [colorbar [yes|no]]<br> + [block [yes|no]]<br> + [smooth [yes|no]]</tt><br> + <tt><tt> </tt><br> + Example:<br> + $xpaget -p ds9 lock frame<br> + $xpaget -p ds9 lock crosshair<br> + </tt><tt>$xpaget -p ds9 lock crop</tt><br> + <tt> $xpaget -p ds9 lock slice</tt><br> + <tt>$xpaget -p ds9 lock bin<br> + $xpaget -p ds9 lock axes<br> + $xpaget -p ds9 lock scale<br> + $xpaget -p ds9 lock scalelimits<br> + $xpaget -p ds9 lock colorbar<br> + $xpaget -p ds9 lock block <br> + $xpaget -p ds9 lock smooth<br> + $xpaset -p ds9 lock frame wcs</tt><tt><br> + </tt><tt>$xpaset -p ds9 lock crosshair wcs<br> + </tt><tt>$xpaset -p ds9 lock crop wcs</tt><br> + <tt>$xpaset -p ds9 lock slice wcs</tt><br> + <tt>$xpaset -p ds9 lock bin yes<br> + $xpaset -p ds9 lock axes yes<br> + </tt><tt>$xpaset -p ds9 lock scale yes<br> + $xpaset -p ds9 lock scalelimits yes<br> + </tt><tt>$xpaset -p ds9 lock colorbar yes<br> + $xpaset -p ds9 lock block yes<br> + $xpaset -p ds9 lock smooth yes<br> + <br> + </tt><b><a name="lower"></a>lower</b> + <p>Lower in the window stacking order. </p> + <tt> Syntax: <br> + lower <br> + <br> + Example: <br> + $xpaset -p ds9 lower</tt><tt><br> + </tt> + <p><b> <a name="magnifier"></a>magnifier</b></p> + <p>Controls the magnifier settings. </p> + <tt> Syntax: <br> + magnifier [color <color>]<br> + [zoom + <value>]<br> + [cursor + yes|no]<br> + [region + yes|no]<br> + <br> + Example: <br> + $xpaget ds9 magnifier color<br> + $xpaget ds9 magnifier zoom<br> + $xpaget ds9 magnifier cursor<br> + $xpaget ds9 magnifier region<br> + $xpaset -p ds9 magnifier color yellow<br> + $xpaset -p ds9 magnifier zoom 2<br> + $xpaset -p ds9 magnifier cursor no<br> + $xpaset -p ds9 magnifier region no</tt><br> + <p><b> <a name="mask"></a>mask<br> + </b></p> + <p>Controls mask parameters. </p> + <tt> Syntax: <br> + mask [color <color>]<br> + [mark 1|0]<br> + [transparency <value>]<br> + [clear]<br> + [open|close]<br> + <br> + Example:<br> + $xpaget ds9 mask color<br> + $xpaget ds9 mask mark<br> + $xpaget ds9 mask transparency<br> + $xpaset -p ds9 mask color red<br> + $xpaset -p ds9 mask mark 0<br> + $xpaset -p ds9 mask transparency 50<br> + $xpaset -p ds9 mask clear<br> + $xpaset -p ds9 mask open<br> + $xpaset -p ds9 mask close<br> + </tt> + <p><b> <a name="match"></a>match</b></p> + <p>Match all other frames to the current frame. </p> + <tt> Syntax: <br> + </tt><tt>match </tt><tt>[frame <coordsys>]<br> + </tt><tt>[crosshair + <coordsys>] </tt><tt><br> + </tt><tt> [crop <coordsys>]</tt><br> + <tt> [slice <coordsys>]</tt><br> + <tt> [bin]<br> + [axes]<br> + [scale]<br> + [scalelimits]<br> + [colorbar]<br> + [block]<br> + [smooth]</tt><br> + <tt><tt><br> + </tt> <tt> </tt> Example: <br> + $xpaset -p ds9 match frame wcs <br> + </tt><tt>$xpaset -p ds9 match crosshair wcs<br> + </tt><tt>$xpaset -p ds9 match crop wcs</tt><br> + <tt>$xpaset -p ds9 match slice</tt><tt> wcs<br> + </tt><tt>$xpaset -p ds9 match bin<br> + $xpaset -p ds9 match axes<br> + $xpaset -p ds9 match scale<br> + $xpaset -p ds9 match scalelimits<br> + $xpaset -p ds9 match colorbar<br> + $xpaset -p ds9 match block<br> + $xpaset -p ds9 match smooth<br> + <br> + </tt><b><a name="mecube"></a>mecube</b> + <p>Load FITS multiple extension file as data cube.<br> + </p> + <tt> Syntax:<br> + mecube [new] [<filename>]<br> + <br> + Example: <br> + $xpaget ds9 mecube > foo.fits<br> + $xpaset -p ds9 mecube foo.fits</tt><br> + <tt><tt>$xpaset -p ds9 mecube new foo.fits<br> + </tt>$cat foo.fits | xpaset ds9 mecube</tt><br> + <tt>$cat foo.fits | xpaset ds9 mecube</tt><tt> new</tt> + <p><b> <a name="minmax"></a>minmax</b></p> + <p>This is how DS9 determines the min and max data values + from the data. <tt>SCAN</tt> will scan all data. <tt>DATAMIN</tt> + and <tt>IRAFMIN</tt> will use the values of the keywords if + present.<br> + </p> + <tt> Syntax: <br> + minmax [scan|sample|datamin|irafmin]<br> + [mode + scan|sample|datamin|irafmin]<br> + [interval #] <br> + <br> + Example: <br> + $xpaget ds9 minmax mode<br> + $xpaget ds9 minmax interval <br> + $xpaset -p ds9 minmax scan <br> + $xpaset -p ds9 minmax mode scan<br> + $xpaset -p ds9 minmax interval 100<br> + </tt> + <p><b> <a name="mode"></a>mode</b></p> + <p>Controls the first mouse button mode. </p> + <tt> Syntax: <br> + mode + [none|region|crosshair|colorbar|pan|zoom|rotate|catalog|examine] + <br> + <br> + Example: <br> + $xpaget ds9 mode <br> + $xpaset -p ds9 mode crosshair</tt><br> + <p><b> <a name="mosaic"></a>mosaic</b></p> + <p>Load FITS mosaic segment into current frame.</p> + <tt> Syntax:<br> + mosaic [wcs|wcsa...wcsz|iraf] [new|mask] [<filename>]<br> + <br> + Example: <br> + $xpaget ds9 mosaic > foo.fits</tt><tt><br> + $xpaset -p ds9 mosaic foo.fits</tt><br> + <tt><tt>$xpaset -p ds9 mosaic wcs foo.fits</tt></tt><br> + <tt><tt>$xpaset -p ds9 mosaic wcs new foo.fits</tt></tt><br> + <tt><tt>$xpaset -p ds9 mosaic wcs mask foo.fits</tt></tt><tt><tt><tt><br> + </tt></tt>$cat foo.fits | xpaset ds9 mosaic</tt><br> + <tt><tt>$cat foo.fits | xpaset ds9 mosaic wcs<br> + $cat foo.fits | xpaset ds9 mosaic wcs</tt><tt> new<br> + </tt>$cat foo.fits | xpaset ds9 mosaic wcs</tt><tt> mask<br> + </tt> + <p><b> <a name="mosaicimage"></a>mosaicimage</b></p> + <p>Load FITS mosaic image into current frame.</p> + <tt> Syntax:<br> + mosaicimage [wcs|wcsa...wcsz|iraf|wfpc2] [new|mask] + [<filename>]<br> + <br> + Example: <br> + $xpaget ds9 mosaicimage > foo.fits</tt><tt><br> + $xpaset -p ds9 mosaicimage foo.fits</tt><br> + <tt><tt>$xpaset -p ds9 mosaicimage wcs foo.fits</tt></tt><br> + <tt><tt>$xpaset -p ds9 mosaicimage wcs new foo.fits</tt></tt><br> + <tt><tt>$xpaset -p ds9 mosaicimage wcs mask foo.fits</tt></tt><tt><tt><tt><br> + </tt></tt>$cat foo.fits | xpaset ds9 mosaicimage</tt><br> + <tt><tt>$cat foo.fits | xpaset ds9 mosaicimage wcs<br> + $cat foo.fits | xpaset ds9 mosaicimage wcs new</tt><tt><br> + </tt>$cat foo.fits | xpaset ds9 mosaicimage wcs mask</tt><br> + <p><b> <a name="movie"></a>movie<br> + savempeg<br> + </b></p> + <p>Create mpeg1 movie from snap shots of the DS9 window. A <tt>slice</tt> + movie cycles though all slices of a cube. A <tt>frame</tt> + movie cycles through all active frames. A <tt>3d</tt> movie + cycles through specified viewing angles. The default is <tt>frame</tt>. + Optional parameters for <tt>3d</tt>: number of frames, azimuth + from/to, elevation from/to, slice from/to, oscillate/repeat + times.</p> + <tt> Syntax:<br> + movie </tt><tt>[slice|frame|3d] </tt><tt><filename><br> + </tt><tt>movie 3d <filename> + [number|azfrom|azto|elfrom|elto|slfrom|slto|oscillate|repeat + <#>]</tt><br> + <tt> <br> + Example:<br> + $xpaset -p ds9 movie slice ds9.mpg<br> + </tt><tt>$xpaset -p ds9 movie 3d ds9.mpg number 10 azfrom -60 azto + 60 oscillate 1</tt><br> + <p><b> <a name="multiframe"></a>multiframe</b></p> + <p>Load FITS multiple extension file as multiple images.<br> + </p> + <tt> Syntax:<br> + multiframe [<filename>]<br> + <br> + Example: <br> + $xpaset -p ds9 multiframe foo.fits</tt><tt><tt><br> + </tt>$cat foo.fits | xpaset ds9 multiframe</tt><tt><tt><tt> # + not available windows</tt></tt></tt><br> + <p><b> <a name="nameserver"></a>nameserver</b></p> + <p>Support Name Server functions. Coordinates are in fk5. </p> + <tt> Syntax: <br> + nameserver [<object>] <br> + + [name <object>]<br> + + [server ned-sao|ned-eso|simbad-sao|simbad-eso]<br> + + [skyformat degrees|sexagesimal]<br> + + [pan]<br> + + [crosshair] <br> + + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 nameserver<br> + $xpaget ds9 nameserver server<br> + $xpaget ds9 nameserver skyformat<br> + $xpaget ds9 nameserver m31<br> + $xpaset -p ds9 nameserver m31 <br> + $xpaset -p ds9 nameserver name m31 <br> + $xpaset -p ds9 nameserver server ned-sao <br> + $xpaset -p ds9 nameserver skyformat sexagesimal<br> + $xpaset -p ds9 nameserver pan<br> + $xpaset -p ds9 nameserver crosshair<br> + $xpaset -p ds9 nameserver open<br> + $xpaset -p ds9 nameserver close<br> + </tt> + <p><b> <a name="nan"></a>nan</b></p> + <p>Set image not-a-number color. </p> + <tt> Syntax: <br> + nan <color><br> + <br> + Example:<br> + $xpaget ds9 nan<br> + $xpaset -p ds9 nan red</tt><tt><br> + </tt> + <p><b> <a name="nrrd"></a>nrrd</b></p> + <p>Load an NRRD (Nearly Raw Raster Data) file. Optional parameter: + array endian.<br> + </p> + <tt> Syntax: <br> + nrrd [<filename>] [little|big]<br> + <br> + Example:<br> + $xpaget ds9 nrrd</tt><br> + <tt><tt>$xpaget ds9 nrrd big<br> + $xpaset -p ds9 nrrd foo.nrrd</tt></tt><br> + <tt><tt><tt><tt>$xpaset -p ds9 nrrd new foo.nrrd</tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt>$xpaset -p ds9 nrrd mask foo.nrrd<br> + </tt></tt></tt></tt></tt>$cat foo.nrrd | xpaset ds9 nrrd</tt><br> + <tt>$cat foo.nrrd | xpaset ds9 nrrd</tt><tt> new<br> + $cat foo.nrrd | xpaset ds9 nrrd mask</tt> + <p><b> <a name="nvss"></a>nvss</b></p> + <p>Support for NRAO VLA Sky Survey.</p> + <tt> Syntax: <br> + nvss []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> <dec> + degrees|sexagesimal] # in wcs fk5<br> + [size <width> <height> + degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 nvss name <br> + $xpaget ds9 nvss coord <br> + $xpaget ds9 nvss size<br> + $xpaget ds9 nvss save<br> + $xpaget ds9 nvss frame<br> + $xpaset -p ds9 nvss<br> + $xpaset -p ds9 nvss m31 <br> + $xpaset -p ds9 nvss name m31 <br> + $xpaset -p ds9 nvss coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + $xpaset -p ds9 nvss size 60 60 arcmin<br> + $xpaset -p ds9 nvss save yes<br> + $xpaset -p ds9 nvss frame current<br> + $xpaset -p ds9 nvss update frame<br> + $xpaset -p ds9 nvss open<br> + </tt><tt>$xpaset -p ds9 nvss close</tt><br> + <p><b> <a name="orient"></a>orient</b></p> + <p>Controls the orientation of the current frame. </p> + <tt> Syntax: <br> + orient [none|x|y|xy] <br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 orient <br> + $xpaset -p ds9 orient xy<br> + $xpaset -p ds9 orient open<br> + $xpaset -p ds9 orient close<br> + </tt> + <p><b> <a name="pagesetup"></a>pagesetup</b></p> + <p>Controls Page Setup options.<br> + </p> + <tt> Syntax: <br> + pagesetup [orient portrait|landscape] <br> + [scale + <numberic>]</tt><br> + <tt> [size + letter|legal|tabloid|poster|a4]</tt><br> + <tt> <br> + Example: <br> + $xpaget ds9 pagesetup orient<br> + $xpaget ds9 pagesetup scale <br> + $xpaget ds9 pagesetup size <br> + $xpaset -p ds9 pagesetup orient portrait <br> + $xpaset -p ds9 pagesetup scale 50<br> + $xpaset -p ds9 pagesetup size poster<br> + </tt> + <p><b> <a name="pan"></a>pan</b></p> + <p>Controls the current image cursor location for the current + frame. </p> + <tt> Syntax: <br> + pan [<x> <y> <coordsys> + [<skyframe>][<skyformat>]] # relative<br> + [to <x> <y> <coordsys> + [<skyframe>][<skyformat>] # absolute<br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 pan # get current image coords <br> + $xpaget ds9 pan wcs fk4 sexagesimal # get current wcs coords <br> + $xpaset -p ds9 pan 200 200 image # pan relative <br> + $xpaset -p ds9 pan to 400 400 physical # pan to physical coords + <br> + $xpaset -p ds9 pan to 13:29:55 47:11:50 wcs fk5 # pan to wcs + coords<br> + $xpaset -p ds9 pan open<br> + $xpaset -p ds9 pan close<br> + </tt> + <p><b> <a name="pixeltable"></a>pixeltable</b></p> + <p>Display/Hide the pixel table. </p> + <tt> Syntax: <br> + pixeltable []<br> + [yes|open]<br> + + [no|close]<br> + <br> + Example: <br> + $xpaget ds9 pixeltable <br> + $xpaset -p ds9 pixeltable<br> + $xpaset -p ds9 pixeltable yes<br> + $xpaset -p ds9 pixeltable open<br> + $xpaset -p ds9 pixeltable close</tt><br> + <p><b> <a name="plot"></a>plot</b></p> + <p>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:</p> + <blockquote>xy x and y coordinates<br> + xyex x,y coordinates with x errors<br> + xyey x,y coordinates with y errors<br> + xyexey x,y coordinates with x and y + errors<br> + </blockquote> + <p>To create a new plot, use the plot new command.</p> + <tt> Syntax: <br> + # create new empty plot window<br> + plot<br> + plot [bar|scatter]<br> + [new [name <plotname>] + [line|bar|scatter]]<br> + [new [name <plotname>] + [line|bar|scatter] <title> <xaxis label> <yaxis + label> </tt><tt>xy|xyex|xyey|xyexey</tt><tt>]<br> + <br> + # create new plot with data<br> + plot [new [name <plotname>] </tt><tt>[line|bar|scatter] </tt><tt>stdin] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + # title, title xaxis, title yaxis, dimension on line 1<br> + [new [name <plotname>] + [line|bar|scatter] <title> <xaxis label> <yaxis + label> xy|xyex|xyey|xyexey]<br> + <br> + # load dataset into an existing plot<br> + plot [<plotname>] [data xy|xyex|xyey|xyexey]<br> + </tt><tt><tt><br> + plot [<plotname>] load <filename> + [xy|xyex|xyey|xyexey]<br> + [<plotname>] save + <filename><br> + </tt> [<plotname>] clear<br> + </tt><tt><tt><tt><tt><tt><tt> </tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + duplicate<br> + </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </tt>[<plotname>] stats<br> + </tt></tt> </tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + list<br> + </tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + loadconfig <filename><br> + [<plotname>] saveconfig + <filename><br> + </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [<plotname>] pagesetup orient [portrait|landscape]<br> + [<plotname>] pagesetup + size [letter|legal|tabloid|poster|a4]</tt><br> + <tt> </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [<plotname>] print<br> + [<plotname>] print destination + [printer|file] <br> + [<plotname>] print + command <command><br> + [<plotname>] print + filename <filename><br> + [<plotname>] print color + [rgb|gray]<br> + </tt> </tt>[<plotname>] + close<br> + </tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><br> + plot </tt>[<plotname>] mode [pointer|zoom]<br> + </tt></tt></tt></tt></tt></tt><tt><br> + # configure graph<br> + plot [<plotname>] axis [x|y] grid [yes|no]<br> + [<plotname>] axis [x|y] log + [yes|no]<br> + </tt><tt> [<plotname>] axis [x|y] + flip [yes|no]</tt><br> + <tt><tt> [<plotname>] axis [x|y] auto + [yes|no]<br> + [<plotname>] axis [x|y] min + <value><br> + [<plotname>] axis [x|y] max + <value></tt><tt><br> + </tt><tt><tt> [<plotname>] axis [x|y] + format <string></tt><tt><br> + </tt></tt> </tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + legend [yes|no]<br> + [<plotname>] legend position + [right|left|top|bottom]</tt><br> + </tt><tt><tt> [<plotname>] font + [title|labels|numbers] font [times|helvetica|courier]<br> + [<plotname>] font </tt></tt><tt><tt><tt><tt>[title|labels|numbers]</tt></tt> + size <value><br> + [<plotname>] font </tt></tt><tt><tt><tt><tt>[title|labels|numbers]</tt></tt> + weight [normal|bold]<br> + [<plotname>] font </tt></tt><tt><tt><tt><tt>[title|labels|numbers]</tt></tt> + slant [roman|italic]<br> + </tt></tt><tt> [<plotname>] title + <string></tt><br> + <tt><tt> [<plotname>] title [x|y] + <string><br> + </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + barmode [normal|stacked|aligned|overlap]<br> + <br> + </tt> # configure current dataset<br> + </tt>plot [<plotname>] show [yes|no]<br> + </tt> <tt></tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + shape + [circle|square|diamond|plus|splus|scross|triangle|arrow]</tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt> <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + shape fill [yes|no]</tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt> <tt> + </tt></tt><tt><tt><tt><tt>[<plotname>] + shape color <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + smooth + [step|linear|cubic|quadratic|catrom]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + color + <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + width + <value><br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + dash [yes|no]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error [yes|no]</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error color + <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + color + <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error width + <value></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <tt> </tt></tt><tt><tt><tt><tt>[<plotname>] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + name + <string><br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><br> + # select current dataset<br> + </tt></tt></tt>plot [<plotname>] select <value><br> + <br> + Example: <br> + </tt><tt><tt> </tt><tt><tt># return all plotnames<br> + </tt></tt>$xpaget ds9 plot</tt><tt><tt><br> + </tt><br> + # create new empty plot window<br> + $xpaset -p ds9 plot<br> + $xpaset -p ds9 plot scatter<br> + $xpaset -p ds9 plot new<br> + $xpaset -p ds9 plot new bar<br> + $xpaset -p ds9 plot new name foo<br> + $xpaset -p ds9 plot new name foo scatter<br> + <br> + # create new plot with data<br> + $cat foo.dat | xpaset ds9 plot new stdin <br> + $cat foo.dat | xpaset ds9 plot new name foo stdin<br> + $cat bar.dat | xpaset ds9 plot new "{The Title}" "{X}" "{Y}" xy<br> + $cat bar.dat | xpaset ds9 plot new name foo "{The Title}" "{X}" + "{Y}" xy<br> + <br> + # load additional dataset into an existing plot<br> + $cat bar.dat | xpaset ds9 plot data xy # plot additional data<br> + $cat bar.dat | xpaset ds9 plot foo data xy # plot additional + data<br> + </tt><tt><tt><br> + </tt></tt><tt><tt><tt><tt><tt><tt>$xpaget ds9 plot stats<br> + </tt></tt></tt></tt></tt></tt><tt><tt><tt><tt>$xpaget + ds9 plot list<br> + </tt></tt>$xpaset -p ds9 plot load foo.dat xy # load new + dataset with dimension xy<br> + $xpaset -p ds9 plot save bar.dat # save current dataset<br> + </tt></tt><tt><tt>$xpaset -p ds9 plot clear # clear all datasets<br> + $xpaset -p ds9 plot duplicate # duplicate current dataset<br> + </tt></tt><tt><tt><tt><tt><tt><tt>$xpaset -p ds9 plot stats<br> + </tt></tt></tt></tt></tt></tt><tt><tt>$xpaset -p ds9 + plot list<br> + </tt></tt><tt><tt>$xpaset -p ds9 plot loadconfig foo.plt # load + plot configuration <br> + $xpaset -p ds9 plot saveconfig bar.plt # save current plot + configuration<br> + </tt></tt><tt><tt>$xpaset -p ds9 plot pagesetup orient portrait<br> + $xpaset -p ds9 plot pagesetup size letter<br> + </tt></tt><tt><tt>$xpaset -p ds9 plot print<br> + $xpaset -p ds9 plot print destination file<br> + $xpaset -p ds9 plot print command "lp"<br> + $xpaset -p ds9 plot print filename "foo.ps"<br> + $xpaset -p ds9 plot print color rgb<br> + </tt>$xpaset -p ds9 plot close # close current plot<br> + </tt><tt><tt><br> + $xpaget ds9 plot mode<br> + $xpaset -p ds9 plot mode pointer</tt><br> + </tt><tt><br> + # configure plot<br> + $xpaget ds9 plot axis x grid<br> + </tt><tt><tt>$xpaget ds9 plot axis x log<br> + </tt></tt><tt><tt><tt>$xpaget ds9 plot axis x flip</tt></tt></tt><br> + <tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + ds9 plot axis x auto<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot axis x min<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot axis x max<br> + $xpaget ds9 plot axis x format<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot legend<br> + </tt></tt></tt></tt><tt><tt><tt><tt><tt>$xpaget ds9 plot + legend position<br> + </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>$xpaget + ds9 plot font numbers font<br> + </tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot font numbers size<br> + </tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot font numbers weight<br> + </tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot font numbers slant<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot title<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot title x</tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><br> + $xpaget ds9 plot barmode<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt> + </tt></tt>$xpaset -p ds9 plot axis x grid yes<br> + $xpaset -p ds9 plot axis x log yes</tt><br> + <tt>$xpaset -p ds9 plot axis x flip yes</tt><tt><br> + </tt><tt><tt>$xpaset -p ds9 plot axis x auto no<br> + $xpaset -p ds9 plot axis x min 0<br> + $xpaset -p ds9 plot axis x max 100<br> + $xpaset -p ds9 plot axis x format {%f}<br> + </tt>$xpaset -p ds9 plot legend yes # show legend<br> + </tt><tt>$xpaset -p ds9 plot legend position left</tt><tt><tt><tt><tt><br> + </tt></tt>$xpaset -p ds9 plot font numbers font times<br> + $xpaset -p ds9 plot font numbers size 12<br> + $xpaset -p ds9 plot font numbers weight bold<br> + $xpaset -p ds9 plot font numbers slant italic<br> + </tt></tt><tt>$xpaset -p ds9 plot title {The Title}<br> + $xpaset -p ds9 plot title x {X Axis}<br> + $xpaset -p ds9 plot barmode aligned<br> + <br> + # configure current dataset<br> + $xpaget ds9 plot show<br> + $xpaget ds9 plot shape</tt> <br> + <tt><tt>$xpaget ds9 plot shape fill<br> + </tt></tt><tt><tt><tt>$xpaget ds9 plot shape color<br> + </tt></tt></tt><tt><tt><tt><tt>$xpaget ds9 plot smooth<br> + </tt></tt></tt></tt><tt><tt><tt><tt><tt>$xpaget ds9 plot + color<br> + </tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt>$xpaget + ds9 plot width<br> + </tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot dash<br> + </tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot error<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot error + color<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot error + width<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt><tt>$xpaget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ds9 plot name<br> + </tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt></tt>$xpaset + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -p ds9 plot show yes<br> + $xpaset -p ds9 plot shape circle<br> + </tt><tt><tt>$xpaset -p ds9 plot shape fill no<br> + </tt></tt><tt><tt><tt>$xpaset -p ds9 plot shape color cyan<br> + </tt></tt></tt><tt><tt>$xpaset -p ds9 plot smooth step<br> + </tt>$xpaset -p ds9 plot color red<br> + $xpaset -p ds9 plot width 2<br> + $xpaset -p ds9 plot dash yes<br> + $xpaset -p ds9 plot error yes<br> + $xpaset -p ds9 plot error color red</tt><br> + <tt>$xpaset -p ds9 plot error width 2</tt><br> + <tt>$xpaset -p ds9 plot name {My Data}</tt><br> + <tt><br> + # select current dataset<br> + $xpaget ds9 plot select<br> + $xpaset -p ds9 plot select 2</tt><br> + <p><b><b><a name="png"></a></b>png</b></p> + <p>Load PNG image into current frame.<br> + </p> + <tt> Syntax:<br> + png [new|slice] [<filename>]<br> + <br> + Example: <br> + $xpaget ds9 png > foo.png</tt><br> + <tt>$xpaset -p ds9 png foo.png</tt><br> + <tt><tt>$xpaset -p ds9 png new foo.png<br> + </tt></tt><tt><tt><tt>$xpaset -p ds9 png slice foo.png<br> + </tt></tt>$cat foo.png | xpaset ds9 png</tt><tt><tt><tt> # not + available windows</tt></tt></tt><br> + <tt><tt>$cat foo.png | xpaset ds9 png</tt><tt> new </tt></tt><tt><tt><tt><tt> + # not available windows</tt></tt><br> + </tt>$cat foo.png | xpaset ds9 png</tt><tt> slice</tt><tt><tt><tt> + # not available windows</tt></tt></tt> + <p><b> <a name="prefs"></a>prefs</b></p> + <p>Controls various preference settings. </p> + <tt> Syntax: <br> + prefs [clear]<br> + [irafalign yes|no]<br> + <br> + Example:<br> + $xpaget ds9 prefs irafalign <br> + $xpaset -p ds9 prefs clear<br> + $xpaset -p ds9 prefs iraf yes<br> + </tt> + <p><b><a name="preserve"></a>preserve</b> </p> + <p>Preserve the follow attributes while loading a new image. </p> + <tt> Syntax: <br> + preserve [pan yes|no]<br> + [regions yes|no]<br> + <br> + Example: <br> + $xpaget ds9 preserve pan<br> + $xpaget ds9 preserve regions<br> + $xpaset -p ds9 preserve pan yes<br> + $xpaset -p ds9 preserve regions yes<br> + </tt> + <p><b> <a name="psprint"></a>psprint</b></p> + <p>Invokes postscript printing. Please see <a + href="command.html#print">print</a> for further details.</p> + <p><b> <a name="print"></a>print</b></p> + <p>Controls printing. Use print option to set printing options. + Only available for <tt>XPA_METHOD local.</tt> </p> + <tt> Syntax: <br> + print [destination printer|file] <br> + [command <command>] <br> + [filename <filename>]<br> + [color rgb|cmyk|gray] <br> + [level 1|2] <br> + [resolution 53|72|75|150|300|600] + <br> + <br> + Example: <br> + $xpaget ds9 print destination <br> + $xpaget ds9 print command <br> + $xpaget ds9 print filename <br> + $xpaget ds9 print color<br> + $xpaget ds9 print level <br> + $xpaget ds9 print resolution <br> + $xpaset -p ds9 print <br> + $xpaset -p ds9 print destination file <br> + $xpaset -p ds9 print command '{gv -}' <br> + $xpaset -p ds9 print filename foo.ps <br> + $xpaset -p ds9 print color cmyk <br> + $xpaset -p ds9 print level 2 <br> + $xpaset -p ds9 print resolution 75 </tt> + <p><b> <a name="raise"></a>raise</b></p> + <p>Raise in the window stacking order. </p> + <tt> Syntax: <br> + raise <br> + <br> + Example: <br> + $xpaset -p ds9 raise </tt> + <p><b> <a name="regions"></a>regions</b></p> + <p>Controls regions in the current frame. </p> + <tt> Syntax: <br> + regions [<filename>]<br> + [load [all] + <filename>] <br> + [save + <filename>] <br> + [list [close]]<br> + [epsilon <integer>]<br> + [show yes|no]<br> + [showtext yes|no]<br> + [centroid]<br> + [centroid auto + yes|no]<br> + [centroid radius + <value>|iteration <value>]<br> + [getinfo]<br> + [move front] <br> + [move back]<br> + [select all]<br> + [select none] <br> + [select invert]<br> + [delete all] <br> + [delete select] <br> + [format + ds9|xml|ciao|saotng|saoimage|pros|xy] <br> + [system + image|physical|wcs|wcsa...wcsz]<br> + [sky + fk4|fk5|icrs|galactic|ecliptic] <br> + [skyformat + degrees|sexagesimal]<br> + [strip yes|no]<br> + [shape <shape>]<br> + [color + &ltcolor>] <br> + [width <width>]<br> + </tt><tt> + [fixed|edit|rotate|delete yes|no]<br> + + [include|exclude|source|background]</tt><br> + <tt> [delim + [nl|<char>]]<br> + [command <marker + command>]<br> + [composite]<br> + [dissolve]<br> + [template + <filename>]<br> + [template <filename> + at <ra> <dec> <coordsys> <skyframe>]<br> + [savetemplate + <filename>]<br> + [groups] <br> + [group new]<br> + [group <tag> + new]<br> + [group <tag> update]<br> + [group <tag> + select]<br> + [group <tag> color + &ltcolor>] <br> + [group <tag> copy] <br> + [group <tag> delete] + <br> + [group <tag> cut]<br> + [group <tag> font + <font>] <br> + [group <tag> move + <int> <int>]<br> + [group <tag> + movefront] <br> + [group <tag> + moveback] <br> + [group <tag> + property <property> yes|no] <br> + [copy]<br> + [cut]<br> + [paste + image|physical|wcs|wcsa...wcsz]<br> + [undo]<br> + [-format + ds9|ciao|saotng|saoimage|pros|xy]<br> + [-system + image|physical|wcs|wcsa...wcsz]<br> + [-sky + fk4|fk5|icrs|galactic|ecliptic] <br> + [-skyformat + degrees|sexagesimal]<br> + [-delim [nl|<char>]]<br> + [-prop + select|edit|move|rotate|delete|fixed|include|source 1|0] <br> + [-group <tag>]<br> + [-strip yes|no]<br> + [-wcs yes|no]<br> + <br> + Example: <br> + $xpaget ds9 regions<br> + $xpaget ds9 regions -format ds9 -system wcs -sky fk5 -skyformat + sexagesimal -prop edit 1 -group foo <br> + $xpaget ds9 regions epsilon<br> + $xpaget ds9 regions show<br> + $xpaget ds9 regions showtext<br> + $xpaget ds9 regions centroid auto<br> + $xpaget ds9 regions centroid radius<br> + $xpaget ds9 regions centroid iteration<br> + $xpaget ds9 regions selected<br> + $xpaget ds9 regions format <br> + $xpaget ds9 regions system <br> + $xpaget ds9 regions sky <br> + $xpaget ds9 regions skyformat <br> + $xpaget ds9 regions strip<br> + $xpaget ds9 regions shape <br> + $xpaget ds9 regions color <br> + $xpaget ds9 regions width<br> + $xpaget ds9 regions delim<br> + $xpaget ds9 regions source <br> + $xpaget ds9 regions background <br> + $xpaget ds9 regions include <br> + $xpaget ds9 regions exclude <br> + $xpaget ds9 regions selected<br> + $xpaget ds9 regions groups<br> + $cat foo.reg | xpaset ds9 regions -format xy -system wcs -sky + fk5<br> + $cat bar.reg | xpaset ds9 regions -format ds9<br> + $echo "image; circle 100 100 20" | xpaset ds9 regions <br> + $echo "image; circle 100 100 20" | xpaset ds9 regions<br> + $echo "fk5; circle 13:29:55 47:11:50 .5'" | xpaset ds9 regions <br> + $echo "physical; ellipse 100 100 20 40" | xpaset ds9 regions <br> + $echo "box 100 100 20 40 25" | xpaset ds9 regions <br> + $echo "image; line 100 100 200 400" | xpaset ds9 regions <br> + $echo "physical; ruler 200 300 200 400" | xpaset ds9 regions <br> + $echo "image; text 100 100 # text={Hello, World}" | xpaset ds9 + regions <br> + $echo "fk4; boxcircle point 13:29:55 47:11:50" | xpaset ds9 + regions <br> + $xpaset -p ds9 regions foo.reg <br> + $xpaset -p ds9 regions -format ciao bar.reg # load as ciao + format<br> + $xpaset -p ds9 regions foo.fits # FITS regions files do not need + a format specification<br> + $xpaset -p ds9 regions load foo.reg # load foo.reg into current + frame<br> + $xpaset -p ds9 regions load all foo.reg # load foo.reg into all + frames<br> + $xpaset -p ds9 regions load '*.reg'# expand *.reg and load into + current frame<br> + $xpaset -p ds9 regions load all '*.reg' # expand *.reg and load + into all frames<br> + $xpaset -p ds9 regions save foo.reg<br> + $xpaset -p ds9 regions list <br> + $xpaset -p ds9 regions list close<br> + $xpaset -p ds9 regions epsilon 5<br> + $xpaset -p ds9 regions show yes<br> + $xpaset -p ds9 regions showtext no<br> + $xpaset -p ds9 regions centroid<br> + $xpaset -p ds9 regions centroid auto yes<br> + $xpaset -p ds9 regions centroid radius 10<br> + $xpaset -p ds9 regions centroid iteration 20<br> + $xpaset -p ds9 regions getinfo<br> + $xpaset -p ds9 regions move back <br> + $xpaset -p ds9 regions move front <br> + $xpaset -p ds9 regions select all <br> + $xpaset -p ds9 regions select none <br> + $xpaset -p ds9 regions select invert<br> + $xpaset -p ds9 regions delete all <br> + $xpaset -p ds9 regions delete select <br> + $xpaset -p ds9 regions format ds9 <br> + $xpaset -p ds9 regions system wcs<br> + $xpaset -p ds9 regions sky fk5 <br> + $xpaset -p ds9 regions skyformat degrees <br> + $xpaset -p ds9 regions delim nl <br> + $xpaset -p ds9 regions strip yes<br> + $xpaset -p ds9 regions shape ellipse <br> + $xpaset -p ds9 regions color red <br> + $xpaset -p ds9 regions width 3<br> + $xpaset -p ds9 regions edit yes<br> + $xpaset -p ds9 regions include<br> + $xpaset -p ds9 regions command '{circle 100 100 20 # color=red}'<br> + $xpaset -p ds9 regions composite<br> + $xpaset -p ds9 regions dissolve<br> + $xpaset -p ds9 regions template foo.tpl<br> + $xpaset -p ds9 regions template foo.tpl at 13:29:55.92 + +47:12:48.02 fk5<br> + $xpaset -p ds9 regions savetemplate foo.tpl<br> + $xpaset -p ds9 regions group new<br> + $xpaset -p ds9 regions group foo new<br> + </tt><tt>$xpaset -p ds9 regions group foo update</tt><br> + <tt>$xpaset -p ds9 regions group foo select</tt><br> + <tt>$xpaset -p ds9 regions group foo color red<br> + $xpaset -p ds9 regions group foo copy<br> + $xpaset -p ds9 regions group foo delete<br> + $xpaset -p ds9 regions group foo cut<br> + $xpaset -p ds9 regions group foo font {times 14 bold}<br> + $xpaset -p ds9 regions group foo move 100 100 <br> + $xpaset -p ds9 regions group foo movefront <br> + $xpaset -p ds9 regions group foo moveback <br> + $xpaset -p ds9 regions group foo property delete no <br> + <br> + $xpaset -p ds9 regions copy<br> + $xpaset -p ds9 regions cut<br> + $xpaset -p ds9 regions paste wcs<br> + $xpaset -p ds9 regions undo<br> + </tt> + <p><b> <a name="restore"></a>restore</b></p> + <p>Restore DS9 to a previous state from a backup save set. </p> + <tt> Syntax: <br> + restore <filename><br> + <br> + Example:<br> + $xpaset -p ds9 restore ds9.bck</tt><br> + <p><b> <a name="rgb"></a>rgb</b></p> + <p>Create RGB frame and control RGB frame parameters.</p> + <tt> Syntax: <br> + rgb []<br> + [red|green|blue]<br> + [channel [red|green|blue]]<br> + [view [red|green|blue] [yes|no]]<br> + [system <coordsys>]<br> + [lock + wcs|crop|slice|bin|scale|scalelimits|colorbar|block|smooth + [yes|no]]<br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 rgb channel<br> + </tt><tt>$xpaget ds9 rgb lock wcs</tt><br> + <tt>$xpaget ds9 rgb lock crop</tt><br> + <tt>$xpaget ds9 rgb lock slice</tt><br> + <tt> $xpaget ds9 rgb lock bin<br> + $xpaget ds9 rgb lock scale<br> + $xpaset ds9 rgb lock scalelimits<br> + $xpaget ds9 rgb lock colorbar<br> + $xpaget ds9 rgb lock block<br> + $xpaget ds9 rgb lock smooth<br> + $xpaget ds9 rgb system<br> + $xpaget ds9 rgb view red<br> + $xpaget ds9 rgb view green<br> + $xpaget ds9 rgb view blue<br> + $xpaset -p ds9 rgb # create new rgb frame<br> + $xpaset -p ds9 rgb red # set current channel to red<br> + $xpaset -p ds9 rgb channel red # set current channel to red<br> + $xpaset -p ds9 rgb view blue no # turn off blue channel<br> + $xpaset -p ds9 rgb system wcs # set rgb coordinate system<br> + </tt><tt>$xpaset -p ds9 rgb lock wcs yes</tt><br> + <tt>$xpaset -p ds9 rgb lock crop yes</tt><br> + <tt>$xpaset -p ds9 rgb lock slice yes</tt><br> + <tt>$xpaset -p ds9 rgb lock bin yes</tt><br> + <tt> $xpaset -p ds9 rgb lock scale yes<br> + $xpaset -p ds9 rgb lock scalelimits yes<br> + $xpaset -p ds9 rgb lock colorbar yes<br> + $xpaset -p ds9 rgb lock block yes<br> + $xpaset -p ds9 rgb lock smooth yes<br> + $xpaset -p ds9 rgb open<br> + $xpaset -p ds9 rgb close</tt><br> + <p><b> <a name="rgbarray"></a>rgbarray</b></p> + <p>Load raw data array cube into rgb frame.<br> + </p> + <tt> Syntax:<br> + rgbarray [native|big|little]<br> + rgbarray [new|mask] +[[xdim=<x>,ydim=<y>|dim=<dim>],[zdim=3],bitpix=<b>,skip=<s>,endian=[little|big]]<br> + <br> + Example: <br> + $xpaget ds9 rgbarray > foo.arr<br> + $xpaget ds9 rgbarray little > foo.arr<br> + $xpaset -p ds9 rgbarray + foo.arr[dim=512,zdim=3,bitpix=-32,endian=little]<br> + $xpaset -p ds9 rgbarray new foo.arr[dim=512,zdim=3,bitpix=</tt><tt>-32,endian=little]</tt><br> + <tt>$cat foo.arr | xpaset ds9 rgbarray + [dim=512,zdim=3,bitpix=-32,endian=little]</tt><br> + <tt>$cat foo.arr | xpaset ds9 rgbarray new + [dim=512,zdim=3,bitpix=-32,endian=little]</tt><br> + <p><b> <a name="rgbcube"></a>rgbcube</b></p> + <p>Load FITS rgbcube into rgb frame.<br> + </p> + <tt> Syntax:<br> + rgbcube [new] [<filename>]<br> + <br> + Example: <br> + $xpaget ds9 rgbcube > foo.fits<br> + $xpaset -p ds9 rgbcube foo.fits</tt><br> + <tt><tt>$xpaset -p ds9 rgbcube new foo.fits<br> + </tt>$cat foo.fits | xpaset ds9 rgbcube</tt><br> + <tt>$cat foo.fits | xpaset ds9 rgbcube</tt><tt> new</tt><br> + <p><b> <a name="rgbimage"></a>rgbimage</b></p> + <p>Load FITS rgbimage into rgb frame.<br> + </p> + <tt> Syntax:<br> + rgbimage [new] [<filename>]<br> + <br> + Example: <br> + $xpaget ds9 rgbimage > foo.fits<br> + $xpaset -p ds9 rgbimage foo.fits</tt><br> + <tt><tt>$xpaset -p ds9 rgbimage new foo.fits<br> + </tt>$cat foo.fits | xpaset ds9 rgbimage</tt><br> + <tt>$cat foo.fits | xpaset ds9 rgbimage</tt><tt> new<br> + </tt> + <p><b> <a name="rotate"></a>rotate</b></p> + <p>Controls the rotation angle (in degrees) of the current frame. + </p> + <tt> Syntax: <br> + rotate [<value>] <br> + [to <value>] <br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 rotate <br> + $xpaset -p ds9 rotate 45 <br> + $xpaset -p ds9 rotate to 30<br> + $xpaset -p ds9 rotate open<br> + $xpaset -p ds9 rotate close<br> + </tt> + <p><b> <a name="save"></a>save<br> + </b></p> + <p>Save loaded image data of current frame as FITS.</p> + <tt> Syntax: <br> + save </tt><tt>[fits|rgbimage|rgbcube|mecube|mosaic|mosaicimage] + <filename> [image|table|slice]</tt> <br> + <tt> <br> + Example: <br> + $xpaset -p ds9 save foo.fits</tt><br> + <tt>$xpaset -p ds9 save fits foo.fits image</tt><br> + <tt>$xpaset -p ds9 save fits foo.fits table<br> + $xpaset -p ds9 save fits foo.fits slice</tt><br> + <tt>$xpaset -p ds9 save rgbimage foo.fits<br> + </tt><tt>$xpaset -p ds9 save rgbcube foo.fits</tt><br> + <tt>$xpaset -p ds9 save mecube foo.fits</tt><br> + <tt>$xpaset -p ds9 save mosaic foo.fits</tt><br> + <tt>$xpaset -p ds9 save mosaicimage foo.fits</tt><br> + <p><b> <a name="saveimage"></a>saveimage<br> + </b></p> + <p>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: <tt>jpeg </tt>quality (1-100) and <tt>tiff </tt>compression + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + method. </p> + <tt> Syntax: <br> + saveimage </tt><tt>[fits|eps|gif|tiff|jpeg|png] </tt><tt><filename><br> + saveimage <filename>.jpeg [1-100]<br> + saveimage <filename>.tiff [none|jpeg|packbits|deflate]<br> + <br> + Example: <br> + $xpaset -p ds9 saveimage ds9.tiff<br> + $xpaset -p ds9 saveimage jpeg ds9.jpeg 75</tt><br> + <p><b> <a name="scale"></a>scale</b></p> + <p>Controls the limits and color scale distribution. </p> + <tt> Syntax: <br> + scale [linear|log|pow|sqrt|squared|asinh|sinh|histequ]<br> + [log exp <value>] <br> + [datasec yes|no] <br> + [limits <minvalue> + <maxvalue>] <br> + [mode + minmax|<value>|zscale|zmax] <br> + [scope local|global] <br> + [match]<br> + [match limits]<br> + [lock [yes|no]]<br> + [lock limits [yes|no]]<br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 scale<br> + $xpaget ds9 scale log exp <br> + $xpaget ds9 scale datasec <br> + $xpaget ds9 scale limits <br> + $xpaget ds9 scale mode <br> + $xpaget ds9 scale scope <br> + $xpaget ds9 scale lock<br> + $xpaget ds9 scale lock limits<br> + $xpaset -p ds9 scale linear<br> + $xpaset -p ds9 scale log 100<br> + $xpaset -p ds9 scale datasec yes <br> + $xpaset -p ds9 scale histequ <br> + $xpaset -p ds9 scale limits 1 100 <br> + $xpaset -p ds9 scale mode zscale <br> + $xpaset -p ds9 scale mode 99.5 <br> + $xpaset -p ds9 scale scope local<br> + $xpaset -p ds9 scale match<br> + $xpaset -p ds9 scale match limits<br> + $xpaset -p ds9 scale lock yes<br> + $xpaset -p ds9 scale lock limits yes<br> + $xpaset -p ds9 scale open<br> + $xpaset -p ds9 scale close<br> + </tt> + <p><b> <a name="shm"></a>shm</b></p> + <p>Load a shared memory segment into the current frame. </p> + <tt> Syntax: <br> + shm [<key> [<filename>]] <br> + [key <key> [<filename>]] <br> + [shmid <id> [<filename>]]<br> + [fits [key|shmid] <id> + [<filename>]]<br> + [mosaicimage [iraf|wcs|wcsa...wcsz|wfpc2] + [key|shmid] <id> [<filename>]]<br> + [mosaicimagenext [wcs|wcsa...wcsz] + [key|shmid] <id> [<filename>]]<br> + [mosaic [iraf|wcs|wcsa...wcsz] [key|shmid] + <id> [<filename>]] <br> + [rgbcube [key|shmid] <id> + [<filename>]<br> + [rgbimage [key|shmid] <id> + [<filename>]]<br> + [rgbarray [key|shmid] <id> +[xdim=<x>,ydim=<y>|dim=<dim>,zdim=3],bitpix=<b>,[skip=<s>]]<br> + [array [key|shmid] <id> +[xdim=<x>,ydim=<y>|dim=<dim>],bitpix=<b>,[skip=<s>]]<br> + [startload|finishload]<br> + <br> + Example: <br> + $xpaget ds9 shm <br> + $xpaset -p ds9 shm 102 <br> + $xpaset -p ds9 shm key 102<br> + $xpaset -p ds9 shm shmid 102 foo<br> + $xpaset -p ds9 shm fits key 100 foo <br> + $xpaset -p ds9 shm mosaicimage iraf key 100 foo <br> + $xpaset -p ds9 shm mosaicimage wcs key 100 foo <br> + $xpaset -p ds9 shm mosaicimage wcsa key 100 foo <br> + $xpaset -p ds9 shm mosaicimage wfpc2 key 100 foo <br> + $xpaset -p ds9 shm mosaicimagenext wcs key 100 foo<br> + $xpaset -p ds9 shm mosaic iraf key 100 foo <br> + $xpaset -p ds9 shm mosaic wcs key 100 foo <br> + $xpaset -p ds9 shm rgbcube key 100 foo <br> + $xpaset -p ds9 shm rgbimage key 100 foo<br> + $xpaset -p ds9 shm rgbarray key 100 [dim=200,zdim=3,bitpix=-32]<br> + $xpaset -p ds9 shm array shmid 102 [dim=32,bitpix=-32]<br> + $xpaset -p ds9 shm startload # start a multiple load sequence + without updating the display<br> + $xpaset -p ds9 shm finishload # finish multiple load sequence</tt><br> + <p><b> <a name="sia"></a>sia<br> + </b></p> + <p>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.</p> + <tt> Syntax: <br> + sia [2mass|akari|astrowise|cadc|cxc|mast|sdss|skyview|tgssadr</tt><tt>]<br> + <br> + </tt><tt> </tt><tt> [<ref>] [cancel]<br> + </tt><tt> [<ref>] [clear]<br> + </tt><tt> [<ref>] [close]</tt><br> + <tt> [<ref>] [coordinate <ra> + <dec> <coordsys>]</tt><tt><br> + </tt><tt> </tt><tt>[<ref>] [crosshair]</tt><br> + <tt> [<ref>] [export sb|tsv + <filename>]<br> + </tt><tt> [<ref>] [name <object>]<br> + </tt><tt> [<ref>] [print]</tt><br> + <tt> [<ref>] [retrieve]</tt><br> + <tt> </tt><tt> [<ref>] [save + <filename>]</tt><br> + <tt> [<ref>] [size <width> + <height> degrees|arcmin|arcsec]</tt><br> + <tt> </tt><tt> [<ref>] [sky + <skyframe>]<br> + </tt><tt> [<ref>] [skyformat + <skyformat>]<br> + </tt><tt> [<ref>] [system + <coordsys>]</tt><tt><br> + </tt><tt> </tt><tt>[<ref>] [update]</tt><br> + <tt><br> + Example: <br> + $xpaget ds9 sia<br> + </tt><tt><br> + $xpaset -p ds9 sia 2mass<br> + </tt><tt>$xpaset -p ds9 sia cancel<br> + </tt><tt>$xpaset -p ds9 sia clear<br> + </tt><tt>$xpaset -p ds9 sia close<br> + </tt><tt>$xpaset -p ds9 sia coordinate 202.48 47.21 fk5<br> + </tt><tt>$xpaset -p ds9 sia crosshair<br> + </tt><tt>$xpaset -p ds9 sia export tsv bar.tsv<br> + </tt><tt>$xpaset -p ds9 sia name m51<br> + </tt><tt>$xpaset -p ds9 sia print</tt><br> + <tt>$xpaset -p ds9 sia retrieve<br> + $xpaset -p ds9 sia save foo.xml<br> + </tt><tt> </tt><tt>$xpaset -p ds9 sia size 1 1 degrees</tt><br> + <tt>$xpaset -p ds9 sia sky fk5<br> + $xpaset -p ds9 sia skyformat degrees<br> + </tt><tt>$xpaset -p ds9 sia system wcs</tt><tt><br> + </tt><tt>$xpaset -p ds9 sia update<br> + <br> + </tt><b><a name="single"></a>single</b> + <p>Select Single Display mode </p> + <tt> Syntax: <br> + single <br> + <br> + Example: <br> + $xpaget ds9 single <br> + $xpaset -p ds9 single<br> + </tt> + <p><b> <a name="skyview"></a>skyview </b></p> + <p>Support for SkyView image server at HEASARC. </p> + <tt> Syntax: <br> + skyview []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> + <dec> degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [pixels <width> + <height>]<br> + [save yes|no]<br> + [frame new|current]<br> + [update + frame|crosshair]<br> + [survey <survey>] <br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 skyview name <br> + $xpaget ds9 skyview coord <br> + $xpaget ds9 skyview size<br> + $xpaget ds9 skyview pixels<br> + $xpaget ds9 skyview save<br> + $xpaget ds9 skyview frame<br> + $xpaget ds9 skyview survey<br> + $xpaset -p ds9 skyview<br> + $xpaset -p ds9 skyview m31 <br> + $xpaset -p ds9 skyview name m31 <br> + $xpaset -p ds9 skyview coord 00:42:44.404 +41:16:08.78 + sexagesimal<br> + $xpaset -p ds9 skyview size 60 60 arcmin<br> + $xpaset -p ds9 skyview pixels 600 600<br> + $xpaset -p ds9 skyview save yes<br> + $xpaset -p ds9 skyview frame current<br> + $xpaset -p ds9 skyview update frame<br> + $xpaset -p ds9 skyview survey sdssi<br> + $xpaset -p ds9 skyview open<br> + </tt><tt>$xpaset -p ds9 skyview close</tt><br> + <p><b> <a name="sleep"></a>sleep </b></p> + <p>Delays execution for specified number of seconds. Default is 1 + second. <br> + </p> + <tt> Syntax: <br> + sleep [#]<br> + <br> + Example: <br> + $xpaset -p ds9 sleep<br> + $xpaset -p ds9 sleep 2<br> + </tt> + <p><b> <a name="smooth"></a>smooth</b></p> + <p>Smooth current image or set smooth parameters.</p> + <tt> Syntax:<br> + smooth []<br> + [yes|no]<br> + [function + boxcar|tophat|gaussian]<br> + [radius <int>]<br> + [open|close]<br> + [match]<br> + [lock [yes|no]]<br> + <br> + Example:<br> + $xpaget ds9 smooth<br> + $xpaget ds9 smooth function<br> + $xpaget ds9 smooth radius<br> + $xpaget ds9 smooth lock<br> + $xpaset -p ds9 smooth<br> + $xpaset -p ds9 smooth yes<br> + $xpaset -p ds9 smooth function tophat<br> + $xpaset -p ds9 smooth radius 4<br> + $xpaset -p ds9 smooth open<br> + $xpaset -p ds9 smooth close<br> + $xpaset -p ds9 smooth match<br> + $xpaset -p ds9 smooth lock yes<br> + </tt> + <p><b> <a name="source"></a>source</b></p> + <p>Source TCL code from a file. Only available for <tt>XPA_METHOD + local.</tt></p> + <tt> Syntax: <br> + source [<filename>] <br> + <br> + Example: <br> + $xpaset -p ds9 source foo.tcl </tt> + <p><b> <a name="tcl"></a>tcl</b></p> + <p>Execute one tcl command. Only available for <tt>XPA_METHOD + local.</tt><tt></tt> </p> + <tt> Syntax: <br> + tcl [<tcl command>] <br> + <br> + Example: <br> + $echo 'puts "Hello, World"' | xpaset ds9 tcl<br> + $xpaset -p ds9 tcl 'puts "Hello, World"'</tt><tt><br> + </tt> + <p><b> <a name="threads"></a>threads</b></p> + <p>Set number of process threads for functions which are + multi-threaded.<br> + </p> + <tt> Syntax:<br> + threads #<br> + <br> + Example: <br> + $xpaget ds9 threads<br> + $xpaset -p ds9 threads 8</tt><br> + <p><b> <a name="tiff"></a>tiff</b></p> + <p>Load TIFF image into current frame. Optional parameters: <tt>tiff + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + </tt>compression method. </p> + <tt> Syntax:<br> + tiff [new|slice] [<filename>] [none|jpeg|packbits|deflate]<br> + <br> + Example: <br> + $xpaget ds9 tiff > foo.tiff</tt><br> + <tt><tt>$xpaget ds9 tiff jpeg > foo.tiff</tt><br> + $xpaset -p ds9 tiff foo.tiff</tt><br> + <tt><tt>$xpaset -p ds9 tiff new foo.tiff<br> + </tt></tt><tt><tt><tt>$xpaset -p ds9 tiff slice foo.tiff<br> + </tt></tt>$cat foo.tiff | xpaset ds9 tiff</tt><tt><tt><tt> # + not available windows</tt></tt></tt><br> + <tt><tt>$cat foo.tiff | xpaset ds9 tiff</tt><tt> new</tt></tt><tt><tt><tt><tt> + # not available windows</tt></tt><br> + </tt>$cat foo.tiff | xpaset ds9 tiff</tt><tt> slice</tt><tt><tt><tt> + # not available windows</tt></tt></tt> + <p><b> <a name="tile"></a>tile</b></p> + <p>Controls the tile display mode. </p> + <tt> Syntax: <br> + tile []<br> + [yes|no] <br> + [mode grid|column|row] <br> + [grid] <br> + [grid mode automatic|manual]<br> + [grid direction x|y]<br> + [grid layout <col> <row>] <br> + [grid gap <pixels>] <br> + [row] <br> + [column] <br> + <br> + Example: <br> + $xpaget ds9 tile <br> + $xpaget ds9 tile mode <br> + $xpaget ds9 tile grid mode<br> + $xpaget ds9 tile grid direction <br> + $xpaget ds9 tile grid layout <br> + $xpaget ds9 tile grid gap <br> + $xpaset -p ds9 tile<br> + $xpaset -p ds9 tile yes <br> + $xpaset -p ds9 tile mode row <br> + $xpaset -p ds9 tile grid <br> + $xpaset -p ds9 tile grid mode manual<br> + $xpaset -p ds9 tile grid direction x <br> + $xpaset -p ds9 tile grid layout 5 5 <br> + $xpaset -p ds9 tile grid gap 10 <br> + $xpaset -p ds9 tile row <br> + $xpaset -p ds9 tile column </tt> + <p><b> <a name="update"></a>update</b></p> + <p>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. </p> + <tt> Syntax: <br> + update [] <br> + [# x1 y1 x2 y2] <br> + [now] <br> + [now # x1 y1 x2 y2]<br> + <br> + Example: <br> + $xpaset -p ds9 update <br> + $xpaset -p ds9 update 1 100 100 300 400 <br> + $xpaset -p ds9 update now <br> + $xpaset -p ds9 update now 1 100 100 300 400</tt><br> + <p><b> <a name="url"></a>url</b></p> + <p>Load FITS from URL into the current frame</p> + <tt> Syntax: <br> + url <url><br> + <br> + Example: <br> + $xpaset -p ds9 url http://foo.bar.edu/foo.fits <br> + </tt> + <p><b> <a name="version"></a>version</b></p> + <p>Returns the current version of DS9. </p> + <tt> Syntax: <br> + version <br> + <br> + Example: <br> + $xpaget ds9 version </tt> + <p><b> <a name="view"></a>view</b></p> + <p>Controls the GUI. </p> + <tt> Syntax: <br> + view [layout horizontal|vertical]<br> + [keyvalue <string>]<br> + [info yes|no] <br> + [panner yes|no] <br> + [magnifier yes|no] <br> + [buttons yes|no] <br> + [colorbar yes|no]<br> + [colorbar horizontal|vertical]<br> + [colorbar numerics yes|no]<br> + [graph horizontal|vertical + yes|no]<br> + [filename yes|no[<br> + [object yes|no]<br> + [keyword yes|no]<br> + [minmax yes|no]<br> + [lowhigh yes|no]<br> + [units yes|no]<br> + [image|physical|wcs|wcsa...wcsz + yes|no]<br> + </tt><tt><tt><tt> [frame yes|no] <br> + </tt></tt> [red yes|no]<br> + [green yes|no]<br> + [blue yes|no]</tt><br> + <tt><tt> </tt> <br> + Example: <br> + $xpaget ds9 view layout<br> + $xpaget ds9 view keyvalue<br> + $xpaget ds9 view info <br> + $xpaget ds9 view panner<br> + $xpaget ds9 view magnifier<br> + $xpaget ds9 view buttons<br> + $xpaget ds9 view colorbar<br> + $xpaget ds9 view graph horizontal<br> + $xpaget ds9 view filename<br> + $xpaget ds9 view object<br> + $xpaget ds9 view keyword<br> + $xpaget ds9 view minmax<br> + $xpaget ds9 view lowhigh<br> + $xpaget ds9 view units<br> + $xpaget ds9 view image<br> + $xpaget ds9 view wcsa</tt><br> + <tt>$xpaget ds9 view red<br> + </tt><tt><tt><tt>$xpaget ds9 view frame<br> + </tt> </tt>$xpaset -p ds9 view layout vertical<br> + $xpaset -p ds9 view keyvalue BITPIX<br> + $xpaset -p ds9 view info yes<br> + $xpaset -p ds9 view panner yes<br> + $xpaset -p ds9 view magnifier yes<br> + $xpaset -p ds9 view buttons yes<br> + $xpaset -p ds9 view colorbar yes<br> + $xpaset -p ds9 view graph horizontal yes<br> + $xpaset -p ds9 view filename yes<br> + $xpaset -p ds9 view object yes<br> + $xpaset -p ds9 view keyword yes<br> + $xpaset -p ds9 view minmax yes<br> + $xpaset -p ds9 view lowhigh yes<br> + $xpaset -p ds9 view units yes<br> + $xpaset -p ds9 view wcsa yes<br> + </tt><tt><tt>$xpaset -p ds9 view frame yes </tt></tt><br> + <b> </b><tt>$xpaset -p ds9 view red yes<br> + $xpaset -p ds9 view green yes<br> + $xpaset -p ds9 view blue yes</tt><br> + <br> + <b><a name="vla"></a>vla</b> + <p>Support for VLA Sky Survey. </p> + <tt> Syntax:<br> + vla []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> <dec> + degrees|sexagesimal] # in wcs fk5<br> + [size <width> + <height> degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [survey first|stripe82]<br> + [open|close]<br> + <br> + Example:<br> + $xpaget ds9 vla name <br> + $xpaget ds9 vla coord <br> + $xpaget ds9 vla size<br> + $xpaget ds9 vla save<br> + $xpaget ds9 vla frame<br> + $xpaget ds9 vla survey<br> + $xpaset -p ds9 vla<br> + $xpaset -p ds9 vla m31 <br> + $xpaset -p ds9 vla name m31 <br> + $xpaset -p ds9 vla coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + $xpaset -p ds9 vla size 60 60 arcmin<br> + $xpaset -p ds9 vla save yes<br> + $xpaset -p ds9 vla frame current<br> + $xpaset -p ds9 vla update frame<br> + $xpaset -p ds9 vla survey stripe82<br> + $xpaset -p ds9 vla open<br> + </tt><tt>$xpaset -p ds9 vla close<br> + </tt> + <p><b> <a name="vlss"></a>vlss</b></p> + <p>Support for NRAO VLSS Sky Survey.</p> + <tt> Syntax: <br> + vlss []<br> + [<object>]<br> + [name <object>]<br> + [coord <ra> <dec> + degrees|sexagesimal] # in wcs fk5<br> + [size <width> <height> + degrees|arcmin|arcsec]<br> + [save yes|no]<br> + [frame new|current]<br> + [update frame|crosshair]<br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 vlss name <br> + $xpaget ds9 vlss coord <br> + $xpaget ds9 vlss size<br> + $xpaget ds9 vlss save<br> + $xpaget ds9 vlss frame<br> + $xpaset -p ds9 vlss<br> + $xpaset -p ds9 vlss m31 <br> + $xpaset -p ds9 vlss name m31 <br> + $xpaset -p ds9 vlss coord 00:42:44.404 +41:16:08.78 sexagesimal<br> + $xpaset -p ds9 vlss size 60 60 arcmin<br> + $xpaset -p ds9 vlss save yes<br> + $xpaset -p ds9 vlss frame current<br> + $xpaset -p ds9 vlss update frame<br> + $xpaset -p ds9 vlss open<br> + </tt><tt>$xpaset -p ds9 vlss close</tt><br> + <b> </b><br> + <p><b> <a name="vo"></a>vo</b></p> + <p>Invoke an connection to a Virtual Observatory site. </p> + <tt> Syntax: <br> + vo [method xpa|mime]<br> + [server <url>]<br> + [internal yes|no]<br> + [delay #]<br> + [<url>]<br> + [connect <url>]<br> + [disconnect <url>]<br> + [open|close]<br> + <br> + Example:<br> + $xpaget ds9 vo <br> + $xpaget ds9 vo method<br> + $xpaget ds9 vo server<br> + $xpaget ds9 vo internal<br> + $xpaget ds9 vo delay<br> + $xpaget ds9 vo connect<br> + $xpaset -p ds9 vo method xpa<br> + $xpaset -p ds9 vo server "http://foo.bar.edu/list.txt"<br> + $xpaset -p ds9 vo internal yes<br> + $xpaset -p ds9 vo delay 15 # keep-alive delay<br> + $xpaset -p ds9 vo chandra-ed<br> + $xpaset -p ds9 vo connect chandra-ed<br> + $xpaset -p ds9 vo disconnect chandra-ed<br> + $xpaset -p ds9 vo open<br> + $xpaset -p ds9 vo close<br> + </tt> + <p><b> <a name="wcs"></a>wcs</b></p> + <p>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 <a + href="file.html#WCS">WCS</a> for more information. </p> + <tt> Syntax: <br> + wcs [[system] wcs|wcsa...wcsz] <br> + [[sky] fk4|fk5|icrs|galactic|ecliptic] <br> + [[skyformat] degrees|sexagesimal] <br> + [align yes|no] <br> + [reset [#]] <br> + [replace [#] <filename>] <br> + [append [#] <filename>] <br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 wcs <br> + $xpaget ds9 wcs system <br> + $xpaget ds9 wcs sky <br> + $xpaget ds9 wcs skyformat <br> + $xpaget ds9 wcs align <br> + $xpaset -p ds9 wcs wcs <br> + $xpaset -p ds9 wcs system wcs<br> + $xpaset -p ds9 wcs fk5 <br> + </tt><tt>$xpaset -p ds9 wcs sky fk5 <br> + </tt><tt>$xpaset -p ds9 wcs sexagesimal <br> + </tt><tt>$xpaset -p ds9 wcs skyformat sexagesimal <br> + $xpaset -p ds9 wcs align yes<br> + $xpaset -p ds9 wcs reset<br> + $xpaset -p ds9 wcs reset 3<br> + $xpaset -p ds9 wcs replace foo.wcs<br> + $xpaset -p ds9 wcs replace 3 foo.wcs <br> + $xpaset -p ds9 wcs append foo.wcs<br> + $xpaset -p ds9 wcs append 3 foo.wcs <br> + $cat foo.wcs | xpaset ds9 wcs replace <br> + $cat foo.wcs | xpaset ds9 wcs append <br> + $echo "OBJECT = 'foobar'" | xpaset ds9 wcs append<br> + $xpaset -p ds9 open<br> + $xpaset -p ds9 close<br> + </tt> + <p><b> <a name="web"></a>web</b></p> + <p>Display specified URL in the web display. </p> + <tt> Syntax:<br> + web [new|<webname>] [<url>]<br> + [<webname>] [click + back|forward|stop|reload|#]<br> + [<webname>] [clear]<br> + [<webname>] [close]<br> + <br> + Example: <br> + $xpaget ds9 web <br> + $xpaset -p ds9 web www.cnn.com<br> + $xpaset -p ds9 web new www.cnn.com<br> + $xpaset -p ds9 web hvweb www.apple.com<br> + $xpaset -p ds9 web click back<br> + $xpaset -p ds9 web click 2<br> + $xpaset -p ds9 web clear<br> + $xpaset -p ds9 web close<br> + </tt> + <p><b> <a name="width"></a>width</b></p> + <p>Set the width of the image display window.</p> + <tt> Syntax: <br> + width [<value>]<br> + <br> + Example: <br> + $xpaget ds9 width<br> + $xpaset -p ds9 width 512</tt><br> + <p><b> <a name="xpa"></a>xpa</b></p> + <p>Configure XPA.</p> + <tt> Syntax:<br> + -xpa [disconnect] <br> + [info] <br> + <br> + Example:<br> + $xpaget ds9 info <br> + $xpaset -p ds9 disconnect <br> + $xpaset -p ds9 info <br> + </tt> + <p><b> <a name="zscale"></a>zscale</b></p> + <p>Set Scale Limits based on the <i>IRAF</i> algorithm. </p> + <tt> Syntax: <br> + zscale []<br> + [contrast]<br> + [sample]<br> + [line]<br> + <br> + Example:<br> + $xpaget ds9 zscale contrast<br> + $xpaget ds9 zscale sample<br> + $xpaget ds9 zscale line<br> + $xpaset -p ds9 zscale<br> + $xpaset -p ds9 zscale contrast .25<br> + $xpaset -p ds9 zscale sample 600<br> + $xpaset -p ds9 zscale line 120<br> + </tt> + <p><b> <a name="zoom"></a>zoom</b></p> + <p>Controls the current zoom value for the current frame. </p> + <tt> Syntax: <br> + zoom [<value>] <br> + [<value> <value>]<br> + [to <value>] <br> + [to <value> <value>]<br> + [in]<br> + [out]<br> + [to fit] <br> + [open|close]<br> + <br> + Example: <br> + $xpaget ds9 zoom <br> + $xpaset -p ds9 zoom 2 <br> + $xpaset -p ds9 zoom 2 4<br> + $xpaset -p ds9 zoom to 4 <br> + $xpaset -p ds9 zoom to 2 4<br> + $xpaset -p ds9 zoom in<br> + $xpaset -p ds9 zoom out<br> + <$xpaset -p ds9 zoom to fit<br> + $xpaset -p ds9 zoom open<br> + $xpaset -p ds9 zoom close<br> + </tt> </blockquote> + </body> +</html> |
