diff options
| author | William Joye <wjoye@cfa.harvard.edu> | 2019-04-30 19:20:55 (GMT) |
|---|---|---|
| committer | William Joye <wjoye@cfa.harvard.edu> | 2019-04-30 19:20:55 (GMT) |
| commit | e1bd0194e9fda1370ed8e177bc6438a05982598d (patch) | |
| tree | e563cf1b26631f1a47bcc446b77936b4fa38992e /ds9 | |
| parent | c3564c38dae0f1755e53182ad95b57f01d1004a7 (diff) | |
| download | blt-e1bd0194e9fda1370ed8e177bc6438a05982598d.zip blt-e1bd0194e9fda1370ed8e177bc6438a05982598d.tar.gz blt-e1bd0194e9fda1370ed8e177bc6438a05982598d.tar.bz2 | |
clean up doc
Diffstat (limited to 'ds9')
| -rw-r--r-- | ds9/doc/ref/contour.html | 129 | ||||
| -rw-r--r-- | ds9/doc/ref/file.html | 830 | ||||
| -rw-r--r-- | ds9/doc/ref/region.html | 660 |
3 files changed, 1052 insertions, 567 deletions
diff --git a/ds9/doc/ref/contour.html b/ds9/doc/ref/contour.html index b18e374..6d85056 100644 --- a/ds9/doc/ref/contour.html +++ b/ds9/doc/ref/contour.html @@ -1,53 +1,114 @@ <!DOCTYPE doctype PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<meta name="generator" content="HTML Tidy for Mac OS X (vers 31 October 2006 - Apple Inc. build 16.1), see www.w3.org"> -<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> -<meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux 2.4.7-10 i686) [Netscape]"> +<meta name="generator" content= +"HTML Tidy for Mac OS X (vers 31 October 2006 - Apple Inc. build 15.18.1), see www.w3.org"> +<meta http-equiv="Content-Type" content= +"text/html; charset=us-ascii"> +<meta name="GENERATOR" content= +"Mozilla/4.78 [en] (X11; U; Linux 2.4.7-10 i686) [Netscape]"> <title>Contours</title> </head> -<body vlink="#551A8B" text="#000000" link="#0000EE" bgcolor="#FFFFFF" alink="#FF0000"> -<h3><img alt="" src="../sun.gif" width="100" height="98" align="middle"> Contours</h3> +<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>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>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>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>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" id="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> +<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" id="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> -<tt> # Contour file format: DS9 version 7.5</tt><br> +<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> -<tt> global color=green width=1 dash=1 dashlist=8 3</tt><br> +<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> -<tt> PHYSICAL # pixel coords of original file using LTM/LTV<br> - IMAGE # pixel coords of current file<br> - FK4,B1950 # sky coordinate systems<br> - FK5,J2000 # sky coordinate systems<br> - ICRS # sky coordinate systems<br> - GALACTIC # sky coordinate systems<br> - ECLIPTIC # sky coordinate systems<br> - WCS # primary WCS<br> - WCSA # secondary WCS<br> - LINEAR # linear primary WCS<br></tt> +<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> -<tt> level=15.78775 color=pink width=2 dash=yes dashlist=2 2</tt><br> +<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> -<tt> (202.4836468 47.22380226<br> - 202.4833538 47.2239185<br> - 202.4831634 47.22409874<br> - 202.4829883 47.22428858)<br></tt><br></blockquote> +<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> +<p><br></p> +</blockquote> </body> </html> diff --git a/ds9/doc/ref/file.html b/ds9/doc/ref/file.html index 92e0d42..b1aebc8 100644 --- a/ds9/doc/ref/file.html +++ b/ds9/doc/ref/file.html @@ -1,33 +1,42 @@ <!DOCTYPE doctype PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<meta name="generator" content="HTML Tidy for Mac OS X (vers 31 October 2006 - Apple Inc. build 16.1), see www.w3.org"> -<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> -<meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux 2.4.7-10 i686) [Netscape]"> +<meta name="generator" content= +"HTML Tidy for Mac OS X (vers 31 October 2006 - Apple Inc. build 15.18.1), see www.w3.org"> +<meta http-equiv="Content-Type" content= +"text/html; charset=us-ascii"> +<meta name="GENERATOR" content= +"Mozilla/4.78 [en] (X11; U; Linux 2.4.7-10 i686) [Netscape]"> <title>File Formats</title> </head> -<body vlink="#551A8B" text="#000000" bgcolor="#FFFFFF" alink="#FF0000" link="#0000EE"> -<h3><img alt="" src="../sun.gif" width="100" align="middle" height="98"> File Formats</h3> +<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="#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= +"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="#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> @@ -36,7 +45,9 @@ <a href="#StartupFile">Startup File</a><br> <a href="#TCL">TCL</a><br> <p><b><a name="FITS" id="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: +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> @@ -44,245 +55,357 @@ DS9 supports FITS images and FITS binary tables. The following algorithm is used <li style="list-style: none"> <ul> <li><tt>If IMAGE, load.<br></tt></li> -<li><tt>If BINARY TABLE, create IMAGE if the following is true:</tt></li> +<li><tt>If BINARY TABLE, create IMAGE if the following is +true:</tt></li> <li style="list-style: none"> <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 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> </li> </ul> </li> -<li><tt>If DS9 traverses the entire FITS file without satisfying one of the above, an error is generated.</tt></li> +<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:<br> -<br> -<tt>OBJECT</tt><br> -<tt>UNITS</tt><br> -<tt>BSCALE / BZERO</tt><br> -<tt>BLANK</tt><br> -<tt>DATASEC</tt><br> -<tt>LTV / LTM for physical coords</tt><br> -<tt>DTV / DTM for detector coords</tt><br> -<tt>ATV / ATM for amplifier coords</tt><br> -<tt>WCS keywords</tt><br> -<tt>WCS# keywords</tt><br> +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" id="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> -<br> -<tt>Syntax:<br> +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<br> +where</tt><tt><br> <br> ext:<br> [extension name | extension #]<br> <br> sect:<br> -[x0:x1,y0:y1[p]]<br> -[x0:x1,y0:y1,block[p]]<br> -[x0:x1,y0:y1,z0:z1[p]]<br> -[x0:x1,y0:y1,block,z0:z1[p]]<br> -[*,y0:y1[p]]<br> -[*,y0:y1,block[p]]<br> -[*,y0:y1,z0:z1[p]]<br> -[*,y0:y1,block,z0:z1[p]]<br> -[x0:x1,*[p]]<br> -[x0:x1,*,block[p]]<br> -[x0:x1,*,z0:z1[p]]<br> -[x0:x1,*,block,z0:z1[p]]<br> -[*,*,block]<br> -[*,*,z0:z1]<br> -[*,*,block,z0:z1]<br> -<br> -[dim1@xcen,dim2@ycen[p]]<br> -[dim1@xcen,dim2@ycen,block[p]]<br> -[dim1@xcen,dim2@ycen,dim3@zcen[p]]<br> -[dim1@xcen,dim2@ycen,block,dim3@zcen[p]]<br> -[*,dim2@ycen[p]]<br> -[*,dim2@ycen,block[p]]<br> -[*,dim2@ycen,dim3@zcen[p]]<br> -[*,dim2@ycen,block,dim3@zcen[p]]<br> -[dim1@xcen,*[p]]<br> -[dim1@xcen,*,block[p]]<br> -[dim1@xcen,*,dim3@zcen[p]]<br> -[dim1@xcen,*,block,dim3@zcen[p]]<br> -[*,*,block]<br> -[*,*,dim3@zcen]<br> -[*,*,block,dim3@zcen]<br> -<br> -[dim@xcen@ycen]<br> -[dim@xcen@ycen,block]<br> -[dim@xcen@ycen,zdim@zcen]<br> -[dim@xcen@ycen,block,zdim@zcen]<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> -$ds9 foo.fits[10:200,40:100,2] # image section, blocked by 2<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> -$ds9 foo.fits[2][100:200,100:200,2] # second extension, image section, blocked by 2<br> -$ds9 foo.fits[10:200,40:100,5:20] # cube section<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<br> -$ds9 foo.fits[2][100:200,100:200,2,5:20] # second extension, cube section, blocked by 2<br> -<br></tt> <b><a name="FITSBinaryEventsTable" id="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><tt>Syntax:<br> -filename<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" id= +"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> -<br> -filename[ext][bin]<br> -filename[ext][bin][sect]<br> -filename[ext][sect][bin]<br> -filename[bin]<br> -filename[bin][sect]<br> -filename[sect][bin]<br> -filename[ext,bin]<br> -<br> -where:<br> -ext: see<a href="FITSImage">FITS Image</a><br> -sect: see<a href="FITSImage">FITS Image</a><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> -[bin=colx,coly,filter] # bin counts with filter<br> -[bin=colx,coly,colz] # bin on colz<br> -[bin=colx,coly,colz,filter] # bin on colz with filter<br> -[bin=colz] # bin cols 'x', 'y', and colz<br> -[bin=colz,filter] # bin cols 'x', 'y', and colz with filter<br> -[key=colx,coly]<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:<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[bin=detx,dety] # bin on detx,dety<br> -$ds9 foo.fits[2][bin=rawx,rawy] # load ext 2, cols rawx,rawy<br> -$ds9 foo.fits[bg_events,bin=rawx,rawy] # load ext bg_events, cols rawx,rawy<br> -$ds9 foo.fits[bin=x,y,pha] # bin on x,y,pi<br> -$ds9 foo.fits[bin=pi] # bin on x,y,pi<br> -$ds9 'foo.fits[ccd_id==3&&energy>4000]' # quoted filter<br> -$ds9 '"foo.fits[ccd_id==3 && energy>4000]"' # double quoted filter<br> -$ds9 'foo.fits[events][pha>5,pi<2]' # load extension 'events' and filter</tt><br></blockquote> +(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> -<p>The shell environment variable <tt>DS9_BINKEY</tt> may be used to specify default bin cols for FITS bin tables. Example:</p> -<tt>$ export DS9_BINKEY='[bin=rawx,rawy]'<br> -$ ds9 foo.fits # load FITS bin table, bin on rawx, rawy</tt><br> -<p><b><a name="FITSHEALPIXTable" id="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> -<br> -<tt>Syntax:<br> -filename<br> +<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" id="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><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> -filename[ext][hpx]<br> -filename[ext][hpx][sect]<br> -filename[ext][sect][hpx]<br> -filename[hpx]<br> -filename[hpx][sect]<br> -filename[sect][hpx]<br> -filename[ext,hpx]<br> -<br> -where:<br> -ext: see<a href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS Image</a><br> -sect: see<a href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS Image</a><br> -<br> -hpx:<br> -[order=ring|nested] # default ring<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<br> -<br> -Example:<br> -$ds9 foo.fits # default load<br> -$ds9 foo.fits[1] # load first extension<br> -$ds9 foo.fits[order=ring,layout=equatorial,col=1,quad=1,system=unknown]<br> -$ds9 foo.fits[1,order=nested] # first extension, nested order</tt><br> -<p><b><a name="FITSDataCube" id="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" id="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> -<br> -<tt>Example:<br> -$ds9 -mecube foo.fits # load multiple extension fits file as data cube</tt><br> -<p><b><a name="FITSMultipleExtensionMultipleFrames" id="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> -<br> -<tt>Example:<br> -$ds9 -multiframe foo.fits # load multiple extension fits file as multiple frames</tt><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> +<p><b><a name="FITSDataCube" id="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" id= +"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" id= +"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" id="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> +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 summary="" width="50%" cellspacing="2" cellpadding="2" border="1" align="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> +See <a href= +"http://iraf.noao.edu/projects/ccdmosaic/imagedef/imagedef.html">NOAO +IRAF Mosaic Data Structures</a></tt><br></td> </tr> <tr> -<td valign="top" align="left"><tt>WCS</tt><br></td> -<td valign="top" align="left"><tt>each FITS image contains a valid WCS.</tt><br></td> +<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 valign="top" align="left"><tt>HST WFPC2</tt><br></td> -<td valign="top" align="left"><tt>valid HST WFPC2 data cube, consisting of 4 planes, along with a fits ascii table containing wcs information.</tt></td> +<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> -<br> -<tt>Example:<br> -$ds9 -mosaicimage iraf foo.fits # load mosaic iraf from one fits file with multiple exts<br> -$ds9 -mosaic iraf foo.fits bar.fits wow.fits # load mosaic iraf from 3 files<br> -$ds9 -mosaicimage wcs foo.fits # load mosaic wcs from one fits file with multiple exts<br> -$ds9 -mosaic wcs foo.fits bar.fits wow.fits # load mosaic wcs from 3 files<br> -$ds9 -mosaicimage wfpc2 bar.fits # load wfpc2 mosaic<br> -$ds9 -mosaic foo.fits bar.fits wow.fits # load mosaic (wcs) from 3 files</tt><br> -<p><b><a name="FITSMosaicDataCube" id="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. +<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></blockquote> +<p><b><a name="FITSMosaicDataCube" id="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" id="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> -<br> -<tt>Example:<br> -$ds9 -rgbimage rgb.fits # load rgb image consisting of one fits file with 3 image exts<br> -$ds9 -rgbcube cube.fits # load rgb image consisting of one fits data cube<br> -$ds9 -rgb -red foo.fits -green bar.fits -blue wow.fits # rgb image from 3 fits images</tt><br> +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></blockquote> <p><b><a name="SplitFITS" id="SplitFITS"></a>Split FITS</b></p> -A split fits is a valid fits file in which two files contain the header and data segments. +A split fits is a valid fits file in which two files contain the +header and data segments. <p><b><a name="array" id="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> -filename[arr]<br> -filename[arr][sect]<br> -filename[sect][arr]<br> - </tt><br> -where<br> -<tt>sect: see <a href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS Image</a><br> -arr:<br></tt> +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> @@ -292,11 +415,15 @@ arr:<br></tt> <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> +$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:</tt> @@ -313,88 +440,115 @@ type:</tt> int.int # x,y dim<br> int.int.int # x,y,z dim<br></tt></blockquote> <tt>skip:</tt> -<blockquote><tt>int # number of bytes to skip</tt></blockquote> +<blockquote><tt>int # number of bytes to +skip</tt></blockquote> <tt>endian:</tt> <blockquote><tt>'l' little endian<br> 'b' big endian<br></tt></blockquote> <tt>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> +$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" id="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> filename<br> -filename[sect]<br> -<br> -where:<br> -sect: see <a href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS Image</a><br> -Example:<br> -$ds9 -nrrd foo.nrrd<br> -$ds9 -nrrd foo.nrrd[100:200,100:200] # cropped<br> +<p><b><a name="nrrd" id="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" id="envi"></a>ENVI</b><br></p> -Images in ENVI are supported directly. Encodings supported: BIL, BIP, BSQ.<br> -Syntax:<br> -filename<br> +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:<br> -sect: see <a href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS Image</a><br> -<br> -Example:<br> -$ds9 -envi foo.hdr foo.bsq<br> -$ds9 -envi foo.hdr foo.bsq[100:200,100:200] # cropped<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" id="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> +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> -filename<br> -<br> -Example:<br> -$ ds9 -gif foo.gif</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" id="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> -filename<br> -<br> -Example:<br> -$ ds9 -tiff foo.tiff</tt><br> +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" id="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> +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> -filename<br> -<br> -Example:<br> -$ ds9 -jpeg foo.jpeg</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" id="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> -filename<br> -<br> -Example:<br> -$ ds9 -png foo.png</tt><br> -<p><b><a name="ExternalFileSupport" id="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:<br> -<br> -<tt>Help description</tt><br> -<tt>A space-separated list of templates</tt><br> -<tt>A space-separated list of file types (not currently used)</tt><br> -<tt>The command line for the loading this file type</tt><br> -<br> -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> +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" id= +"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> -<br> -<tt>For Example:</tt><br> +<blockquote><tt>For Example:</tt><br> <tt># File access descriptions:</tt><br> <tt># help explanation</tt><br> <tt># file template</tt><br> @@ -403,60 +557,126 @@ The following macros are supported: <tt>$filename</tt><br> <tt>IRAF IMH files</tt><br> <tt>*.imh</tt><br> <tt>IMH</tt><br> -<tt>i2f -s $filename</tt><br> -<p><b><a name="ExternalAnalysisSupport" id="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" id="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.<br> -<br> -<tt><a href="region.html#RegionDescriptions">DS9</a></tt><br> -<tt><a href="region.html#FUNTools">FUNTools</a></tt><br> -<tt><a href="region.html#Ciao">Ciao</a></tt><br> -<tt><a href="region.html#SAOimage">SAOimage</a></tt><br> -<tt><a href="region.html#IRAFPROS">IRAF PROS</a></tt><br> -<tt><a href="region.html#FITSREGIONBinaryTable">FITS REGION Binary Table</a></tt><br> -<tt><a href="region.html#XY">X Y</a></tt><br> -<p><b><a name="ContourFiles" id="ContourFiles"></a>Contour Files</b></p> -See <a href="contour.html">Contours</a> documentation for more information.<br> -<p><b><a name="ColorLookupTable" id="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:<br> -<br> -<tt>SAOimage</tt><br> -<tt>SAOtng</tt><br> -<tt>XImtool</tt><br> -<br> -DS9 uses the file extension to determine the color table format:<br> -<br> -<tt>.lut # XImtool, SAOtng<br> -.sao # DS9, SAOImage</tt><br> +<tt>i2f -s $filename</tt></blockquote> +<p><b><a name="ExternalAnalysisSupport" id= +"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" id="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" id="ContourFiles"></a>Contour +Files</b></p> +See <a href= +"file:///Users/joye/saods9/ds9/doc/ref/contour.html#ContourFiles">Contours</a> +documentation for more information.<br> +<p><b><a name="ColorLookupTable" id="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" id="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.<br> -<br> -<tt>CRPIX1 = 257.75</tt><br> -<tt>CRPIX2 = 258.93</tt><br> -<tt>CRVAL1 = -201.94541667302</tt><br> -<tt>CRVAL2 = -47.45444</tt><br> -<tt>CDELT1 = -2.1277777E-4</tt><br> -<tt>CDELT2 = 2.1277777E-4</tt><br> -<tt>CTYPE2 = 'DEC--TAN'</tt><br> -<br> -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:<br> -<br> -<tt>CRPIX1 257.75</tt><br> -<tt>CRPIX2 258.93</tt><br> -<tt>CRVAL1 -201.94541667302</tt><br> -<tt>CRVAL2 -47.45444</tt><br> -<tt>CDELT1 -2.1277777E-4</tt><br> -<tt>CDELT2 2.1277777E-4</tt><br> -<tt>CTYPE1 'RA---TAN'</tt><br> -<tt>CTYPE2 'DEC--TAN'</tt><br></blockquote> -<blockquote> -<p><b><a name="PreferenceFile" id="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" id="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> +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" id="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" id="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" id="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> +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/region.html b/ds9/doc/ref/region.html index 41c3063..d98b940 100644 --- a/ds9/doc/ref/region.html +++ b/ds9/doc/ref/region.html @@ -1,132 +1,199 @@ <!DOCTYPE doctype PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> -<meta name="generator" content="HTML Tidy for Mac OS X (vers 31 October 2006 - Apple Inc. build 16.1), see www.w3.org"> -<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> -<meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux 2.4.7-10 i686) [Netscape]"> +<meta name="generator" content= +"HTML Tidy for Mac OS X (vers 31 October 2006 - Apple Inc. build 15.18.1), see www.w3.org"> +<meta http-equiv="Content-Type" content= +"text/html; charset=us-ascii"> +<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=us-ascii"> -<meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux 2.4.7-10 i686) [Netscape]"> +<meta http-equiv="Content-Type" content= +"text/html; charset=us-ascii"> +<meta name="GENERATOR" content= +"Mozilla/4.78 [en] (X11; U; Linux 2.4.7-10 i686) [Netscape]"> </head> -<body vlink="#551A8B" text="#000000" link="#0000FF" bgcolor="#FFFFFF" alink="#FF0000"> -<h3><img alt="" src="../sun.gif" width="100" height="98" align="middle"> Regions</h3> +<body vlink="#551A8B" text="#000000" link="#0000FF" bgcolor= +"#FFFFFF" alink="#FF0000"> +<h3><img alt="" src="../sun.gif" width="100" height="98" align= +"middle"> 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> +<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" id="RegionDescriptions"></a>Region Descriptions</b></p> +<p><b><a name="RegionDescriptions" id= +"RegionDescriptions"></a>Region Descriptions</b></p> <p><tt>Circle<br> Usage: circle x y radius # fill=[0|1]<br></tt></p> <p><tt>Ellipse<br> -Usage: ellipse x y radius radius angle# fill=[0|1]</tt></p> +Usage: ellipse x y radius radius angle</tt> <tt># +fill=[0|1]</tt></p> <p><tt>Box<br> -Usage: box x y width height angle# fill=[0|1]</tt></p> +Usage: box x y width height angle</tt> <tt># fill=[0|1]</tt></p> <p><tt>Polygon<br> -Usage: polygon x1 y1 x2 y2 x3 y3 ...# fill=[0|1]</tt></p> +Usage: polygon x1 y1 x2 y2 x3 y3 ...</tt> <tt># fill=[0|1]</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> +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> + text x y {Your Text +Here}</tt></p> <p><tt>Ruler<br> -Usage: ruler x1 y1 x2 y2 # ruler=[pixels|degrees|arcmin|arcsec] [format=<spec>]<br></tt></p> +Usage: ruler x1 y1 x2 y2 # ruler=[pixels|degrees|arcmin|arcsec] +[format=<spec>]<br></tt></p> <p><tt>Compass<br> -Usage: compass x1 y1 length # compass=<coordinate system> <north label> <east label> [0|1] [0|1]</tt></p> +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> + annulus x y r1 r2 +r3...</tt></p> <p><tt>Ellipse Annulus<br> -Usage: ellipse x y r11 r12 r21 r22 n=# [angle]<br></tt> <tt> ellipse x y r11 r12 r21 r22 r31 r32 ... [angle]</tt></p> +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> + 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> +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> +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> +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" id="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> +<p><b><a name="RegionProperties" id="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>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:</tt><br> -<tt>circle(100,100,20) # color=green</tt><br> -<tt>circle(100,100,20) # color=#48f</tt> +<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> +<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> +<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> +<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> +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> +<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> +<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> +<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> +<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> +<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> +<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)</tt><br> +<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</tt><br> -<tt> circle(200,200,10) # background</tt><br> +<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>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>Circle | Ellipse | Box | Polygon<br></b></p> -<p>Circle, ellipse, box, and polygon regions may be rendered with outline or solid color fill. To indicate fill, use the fill property. A '1' indicates fill, '0' indicates no outline.</p> +<p>Circle, ellipse, box, and polygon regions may be rendered with +outline or solid color fill. To indicate fill, use the fill +property. A '1' indicates fill, '0' indicates no outline.</p> <tt>Example: circle(100,100,20) # fill=1</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> +<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> +<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> +<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> -<tt>text={}</tt><br> +<blockquote><tt>text={}</tt><br> <tt>color=green</tt><br> <tt>font="helvetica 10 normal roman"</tt><br> <tt>select=1</tt><br> @@ -135,202 +202,339 @@ The Highlite property specifies if the edit handles become visible when the regi <tt>delete=1</tt><br> <tt>highlite=1</tt><br> <tt>include=1</tt><br> -<tt>fixed=0</tt><br> -<p><b><a name="RegionFileFormat" id="RegionFileFormat"></a>Region File Format</b></p> +<tt>fixed=0</tt></blockquote> +</blockquote> +<p><b><a name="RegionFileFormat" id="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> -<tt>circle 100 100 10</tt><br> +<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><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> -<tt># This is a comment</tt><br> +<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> -<tt>circle 100 100 10</tt><br> -<tt>ellipse 200 200 20 40 ; box 300 300 20 40</tt><br> +<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> -<tt># Region file format: DS9 version 4.0</tt><br> +<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> -<tt>global color=green font="helvetica 10 normal roman" edit=1 move=1 delete=1 highlite=1 include=1 wcs=wcs</tt><br> +<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> -<tt>physical;circle(504,513,20) # color=red text={This is a Circle}</tt><br> +<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> -<tt>PHYSICAL<br> -IMAGE<br> -FK4,B1950<br> -FK5,J2000<br> -ICRS<br> -GALACTIC<br> -ECLIPTIC<br> -WCS<br> -WCSA<br> -LINEAR</tt><br> +<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> +</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> +<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.<br> -<br> -Example: wcsa;linear;point(100,100) # point=diamond</tt></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> +<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> +<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><br> -<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> -<tt>IMAGE<br> -LINEAR<br> -FK4, B1950<br> -FK5, J2000<br> -GALACTIC<br> -ECLIPTIC<br> -ICRS<br> -PHYSICAL<br> -AMPLIFIER<br> -DETECTOR<br> -WCS,WCSA-WCSZ<br></tt> -<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> -<tt>image; circle 100 100 10</tt><br> +<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></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> -<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> -<tt>circle 10:10:0 20:22:0 3'</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> -<tt>j2000; circle 10:10:0 20:22:0 3'</tt><br> -<p>Note that by using units as described above, you may mix coordinate systems within a region specifier; e.g.,</p> -<tt>physical; circle 6500 9320 3'</tt><br> -<p>Note that, for regions which accept a rotation angle such as:</p> -<tt>ellipse (x, y, r1, r2, angle)</tt><br> -<tt>box(x, y, w, h, angle)</tt><br> -<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> -<tt>fk4;ellipse(22:59:43.985, +58:45:26.92,320", 160", 30)</tt><br> +<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></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> -<tt>physical;ellipse(465, 578, 40, 20, 30)</tt><br> -<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> -<p><b><a name="CompositeRegion" id="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" id="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" id="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> -<p><b><a name="FUNTools" id="FUNTools"></a><a href="http://hea-www.harvard.edu/RD/funtools/regions.html">Funtools</a></b><br></p> -<tt>When using DS9 regions file in FUNTOOLS:<br> -LINE is ignored<br> -VECTOR is ignored<br> -PROJECTION is ignored<br> +<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" id="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" id="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" id= +"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" id="FUNTools"></a><a href= +"http://hea-www.harvard.edu/RD/funtools/regions.html">Funtools</a></b><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> -RULER is ignored<br> -COMPASS is ignored<br> -<br></tt> <a name="Ciao" id="Ciao"></a>CIAO<br> -<br> -<tt>When importing from CIAO into DS9:<br> -POINT is translated into BOX CIRCLE POINT<br> -ROTBOX is translated into BOX<br> -RECTANGLE is translated into BOX<br> -PANDA is translated as PIE<br> +TEXT is ignored<br></tt> <tt>RULER is ignored</tt><br> +<tt>COMPASS is ignored</tt><br></blockquote> +<a name="Ciao" id="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<br> -REGION is ignored<br> -<br> -When exporting from DS9 into CIAO:<br> -PANDA is translated into PIE<br> -LINE is ignored<br> -VECTOR is ignored<br> -PROJECTION is ignored<br> -SEGMENT is ignored<br> -TEXT is ignored<br> -RULER is ignored<br> -COMPASS is ignored<br> -ELLIPSE ANNULUS is ignored<br> -BOX ANNULUS is ignored<br> -EPANDA is ignored<br> -BPANDA is ignored<br> -<br></tt> <a name="SAOimage" id="SAOimage"></a><a href="http://tdc-www.harvard.edu/software/saoimage/saoimage.region.html">SAOimage</a><br> - <br> -<tt>When importing from SAOIMAGE into DS9:<br> -POINT is translated into BOX CIRCLE POINT<br> -ROTBOX is translated into BOX<br> -<br> -When exporting from DS9 into SAOIMAGE:<br> -LINE is ignored<br> -VECTOR is ignored<br> -PROJECTION is ignored<br> -SEGMENT is ignored<br> -TEXT is ignored<br> -RULER is ignored<br> -COMPASS is ignored<br> -ELLIPSE ANNULUS is ignored<br> -BOX ANNULUS is ignored<br> -PANDA is ignored<br> -EPANDA is ignored<br> -BPANDA is ignored<br> -<br></tt> <a name="IRAFPROS" id="IRAFPROS"></a>IRAF PROS<br> -<br> -<tt>When importing from PROS into DS9:<br> -POINT is translated into BOX CIRCLE POINT<br> -ROTBOX is translated into BOX<br> -<br> -When exporting from DS9 into SAOIMAGE:<br> -LINE is ignored<br> -VECTOR is ignored<br> -PROJECTION is ignored<br> -SEGMENT is ignored<br> -TEXT is ignored<br> -RULER is ignored<br> -COMPASS is ignored<br> -ELLIPSE ANNULUS is ignored<br> -BOX ANNULUS is ignored<br> -PANDA is ignored<br> -EPANDA is ignored<br> -BPANDA is ignored<br></tt><br> -<a name="FITSREGIONBinaryTable" id="FITSREGIONBinaryTable"></a>FITS REGION Binary Table<br> -<br> -<tt>When importing from FITS REGION into DS9:<br> -POINT is translated into BOX CIRCLE POINT<br> -ROTBOX is translated into BOX<br> -RECTANGLE is translated into BOX<br> -ROTRECTANGLE is translated into a BOX<br> -PIE is translated into PANDA<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" id="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" id="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" id="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> -FIELD is ignored<br> -DIAMONDis ignored<br> -RHOMBUSis ignored<br> -ROTDIAMONDis ignored<br> -ROTRHOMBUSis ignored<br> - <br> -DS9 currently can not export into this format.<br> -<br></tt> <a name="XY" id="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> -<tt>Example:# this is a comment<br> -physical # this overrides the specified coordinate system<br> -300 300<br> -400 400 # this is a comment</tt><br> -<br></blockquote> +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" id="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> |