diff options
| author | William Joye <wjoye@cfa.harvard.edu> | 2019-04-30 19:44:23 (GMT) |
|---|---|---|
| committer | William Joye <wjoye@cfa.harvard.edu> | 2019-04-30 19:44:23 (GMT) |
| commit | afadb7ab3d41f2eb64a0582db3aa3feb3c0712b7 (patch) | |
| tree | 18de0513466cddf04d73c9d89dcbc0e0c64b4f64 /ds9/doc | |
| parent | 5fb1b1197abbafb1a560a40c3f87b6a54e62ef2f (diff) | |
| download | blt-afadb7ab3d41f2eb64a0582db3aa3feb3c0712b7.zip blt-afadb7ab3d41f2eb64a0582db3aa3feb3c0712b7.tar.gz blt-afadb7ab3d41f2eb64a0582db3aa3feb3c0712b7.tar.bz2 | |
clean up doc
Diffstat (limited to 'ds9/doc')
| -rw-r--r-- | ds9/doc/ref/file.html | 284 |
1 files changed, 259 insertions, 25 deletions
diff --git a/ds9/doc/ref/file.html b/ds9/doc/ref/file.html index ba76cfa..32fda5a 100644 --- a/ds9/doc/ref/file.html +++ b/ds9/doc/ref/file.html @@ -58,32 +58,176 @@ DS9 supports FITS images and FITS binary tables. The following algorithm is used </ul> </blockquote> FITS keyword inheritance is supported. All valid FITS <tt>BITPIX</tt> values are supported, along with <tt>-16,</tt> for <tt>UNSIGNED SHORT</tt>. The following FITS keywords are supported: -<blockquote><tt>OBJECT</tt><tt><br></tt> <tt>UNITS</tt><tt><br></tt> <tt>BSCALE / BZERO</tt><tt><br></tt> <tt>BLANK</tt><tt><br></tt> <tt>DATASEC</tt><tt><br></tt> <tt>LTV / LTM for physical coords</tt><tt><br></tt> <tt>DTV / DTM for detector coords</tt><tt><br></tt> <tt>ATV / ATM for amplifier coords</tt><tt><br></tt> <tt>WCS keywords</tt><tt><br></tt> <tt>WCS# keywords</tt></blockquote> +<blockquote><tt>OBJECT</tt><tt><br> +UNITS</tt><tt><br> +BSCALE / BZERO</tt><tt><br> +BLANK</tt><tt><br> +DATASEC</tt><tt><br> +LTV / LTM for physical coords</tt><tt><br> +DTV / DTM for detector coords</tt><tt><br> +ATV / ATM for amplifier coords</tt><tt><br> +WCS keywords</tt><tt><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> -<blockquote><tt>Syntax:</tt><tt><br></tt> <tt>filename</tt><tt><br></tt> <tt>filename[ext]</tt><tt><br></tt> <tt>filename[ext][sect]</tt><tt><br></tt> <tt>filename[sect]</tt><tt><br></tt> <tt>filename[ext,sect]</tt><tt><br></tt> <tt><br></tt> <tt>where</tt><tt><br></tt> <tt><br></tt> <tt>ext:</tt><tt><br></tt> <tt>[extension name | extension #]</tt><tt><br></tt> <tt><br></tt> <tt>sect:</tt><tt><br></tt> <tt>[x0:x1</tt><tt>,y0:y1[p]]</tt><tt><br></tt> <tt>[x0:x1</tt><tt>,y0:y1</tt><tt>,block</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[x0:x1</tt><tt>,y0:y1</tt><tt>,z0:z1</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[x0:x1</tt><tt>,y0:y1</tt><tt>,block,z0:z1</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[*,y0:y1</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[*,y0:y1</tt><tt>,block</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[*,y0:y1</tt><tt>,z0:z1</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[*,y0:y1</tt><tt>,block,z0:z1</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[x0:x1</tt><tt>,*</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[x0:x1</tt><tt>,*</tt><tt>,block</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[x0:x1</tt><tt>,*,z0:z1</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[x0:x1</tt><tt>,*,block,z0:z1</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[*,*</tt><tt>,block</tt><tt>]</tt><tt><br></tt> <tt>[*,*,z0:z1</tt><tt>]</tt><tt><br></tt> <tt>[*,*,block,z0:z1</tt><tt>]</tt><tt><br></tt> <tt><br></tt> <tt>[dim1@xcen,dim2@ycen</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[dim1@xcen,dim2@ycen,block</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[dim1@xcen,dim2@ycen,dim3@zcen</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[dim1@xcen,dim2@ycen,block,dim3@zcen</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[*,dim2@ycen</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[*,dim2@ycen,block</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[*,dim2@ycen,dim3@zcen</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[*,dim2@ycen,block,dim3@zcen</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[dim1@xcen,*</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[dim1@xcen,*,block</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[dim1@xcen,*,dim3@zcen</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[dim1@xcen,*,block,dim3@zcen</tt><tt>[p]</tt><tt>]</tt><tt><br></tt> <tt>[*,*,block]</tt><tt><br></tt> <tt>[*,*,dim3@zcen]</tt><tt><br></tt> <tt>[*,*,block,dim3@zcen]</tt><tt><br></tt> <tt><br></tt> <tt>[dim@xcen@ycen]</tt><tt><br></tt> <tt>[dim@xcen@ycen,block]</tt><tt><br></tt> <tt>[dim@xcen@ycen,zdim@zcen]</tt><tt><br></tt> <tt>[dim@xcen@ycen,block,zdim@zcen]</tt><tt><br></tt> <tt><br></tt> <tt>Example:</tt><tt><br></tt> <tt>$ds9 foo.fits # default load</tt><tt><br></tt> <tt>$ds9 foo.fits[1] # load first extension</tt><tt><br></tt> <tt>$ds9 foo.fits[BCKGRD] # load extension named 'BCKGRD'</tt><tt><br></tt> <tt>$ds9 foo.fits[10:200,40:100] # image section</tt><tt><br></tt> <tt>$ds9 foo.fits[10:200,40:100,2] # image section, blocked by 2</tt><tt><br></tt> <tt>$ds9 foo.fits[*,40:100] # only section y axis</tt><tt><br></tt> <tt>$ds9 foo.fits[256@512@512] # section box at 512,512</tt><tt><br></tt> <tt>$ds9 foo.fits[2][100:200,100:200] # second extension, image section</tt><tt><br></tt> <tt>$ds9 foo.fits[2][100:200,100:200,2] # second extension, image section, blocked by 2</tt><tt><br></tt> <tt>$ds9 foo.fits[10:200,40:100,5:20] # cube section</tt><tt><br></tt> <tt>$ds9 foo.fits[*,40:100,5:20] # only section y and z axes</tt><tt><br></tt> <tt>$ds9 foo.fits[256@512@512] # section cube at 512,512</tt><tt><br></tt> <tt>$ds9 foo.fits[2][100:200,100:200,5:20] # second extension, cube section</tt><tt><br></tt> <tt>$ds9 foo.fits[2][100:200,100:200,2,5:20] # second extension, cube section, blocked by 2</tt></blockquote> +<blockquote><tt>Syntax:</tt><tt><br> +filename</tt><tt><br> +filename[ext]<br> +filename[ext][sect]<br> +filename[sect]<br> +filename[ext,sect]<br> +<br> +where<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> +<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[*,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[*,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</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>Syntax:</tt><tt><br></tt> <tt>filename</tt><tt><br></tt> <tt>filename[ext]</tt><tt><br></tt> <tt>filename[ext][sect]</tt><tt><br></tt> <tt>filename[sect]</tt><tt><br></tt> <tt>filename[ext,sect]</tt><tt><br></tt> <tt><br></tt> <tt>filename[ext][bin]</tt><tt><br></tt> <tt>filename[ext][bin][sect]</tt><tt><br></tt> <tt>filename[ext][sect][bin]</tt><tt><br></tt> <tt>filename[bin]</tt><tt><br></tt> <tt>filename[bin][sect]</tt><tt><br></tt> <tt>filename[sect][bin]</tt><tt><br></tt> <tt>filename[ext,bin]</tt><tt><br></tt> <tt><br></tt> <tt>where:</tt><tt><br></tt> <tt>ext: see</tt> <tt><a href="FITSImage">FITS Image</a></tt><tt><br></tt> <tt>sect: see</tt> <tt><a href="FITSImage">FITS Image</a></tt><tt><br></tt> <tt><br></tt> <tt>bin:</tt><tt><br></tt> <tt>[bin=colx,coly] # bin counts</tt><tt><br></tt> <tt>[bin=colx,coly,filter] # bin counts with filter</tt><tt><br></tt> <tt>[bin=colx,coly,colz] # bin on colz</tt><tt><br></tt> <tt>[bin=colx,coly,colz,filter] # bin on colz with filter</tt><tt><br></tt> <tt>[bin=colz] # bin cols 'x', 'y', and colz</tt><tt><br></tt> <tt>[bin=colz,filter] # bin cols 'x', 'y', and colz with filter</tt><tt><br></tt> <tt>[key=colx,coly]</tt><tt><br></tt> <tt>[binkey=colx,coly]</tt><tt><br></tt><br> +<blockquote><tt>Syntax:<br> +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> +<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> +[binkey=colx,coly]<br></tt><br> (see <a href="http://hea-www.harvard.edu/saord/funtools/filters.html">Introduction to Filtering</a>)<br> <br> -<tt>Example:</tt><tt><br></tt> <tt>$ds9 foo.fits # default load</tt><tt><br></tt> <tt>$ds9 foo.fits[1] # load first extension</tt><tt><br></tt> <tt>$ds9 foo.fits[BCKGRD] # load extension named 'BCKGRD'</tt><tt><br></tt> <tt>$ds9 foo.fits[bin=detx,dety] # bin on detx,dety</tt><tt><br></tt> <tt>$ds9 foo.fits[2][bin=rawx,rawy] # load ext 2, cols rawx,rawy</tt><tt><br></tt> <tt>$ds9 foo.fits[bg_events,bin=rawx,rawy] # load ext bg_events, cols rawx,rawy</tt><tt><br></tt> <tt>$ds9 foo.fits[bin=x,y,pha] # bin on x,y,pi</tt><tt><br></tt> <tt>$ds9 foo.fits[bin=pi] # bin on x,y,pi</tt><tt><br></tt> <tt>$ds9 'foo.fits[ccd_id==3&&energy>4000]' # quoted filter</tt><tt><br></tt> <tt>$ds9 '"foo.fits[ccd_id==3 && energy>4000]"' # double quoted filter</tt><tt><br></tt> <tt>$ds9 'foo.fits[events][pha>5,pi<2]' # load extension 'events' and filter</tt></blockquote> +<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></blockquote> </blockquote> <blockquote> <p>The shell environment variable <tt>DS9_BINKEY</tt> may be used to specify default bin cols for FITS bin tables. Example:</p> -<blockquote><tt>$ export DS9_BINKEY='[bin=rawx,rawy]'</tt><tt><br></tt> <tt>$ ds9 foo.fits # load FITS bin table, bin on rawx, rawy<br></tt></blockquote> +<blockquote><tt>$ export DS9_BINKEY='[bin=rawx,rawy]'<br> +$ 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>Syntax:</tt><tt><br></tt> <tt>filename</tt><tt><br></tt> <tt>filename[ext]</tt><tt><br></tt> <tt>filename[ext][sect]</tt><tt><br></tt> <tt>filename[sect]</tt><tt><br></tt> <tt>filename[ext,sect]</tt><tt><br></tt> <tt><br></tt> <tt>filename[ext][hpx]</tt><tt><br></tt> <tt>filename[ext][hpx][sect]</tt><tt><br></tt> <tt>filename[ext][sect][hpx]</tt><tt><br></tt> <tt>filename[hpx]</tt><tt><br></tt> <tt>filename[hpx][sect]</tt><tt><br></tt> <tt>filename[sect][hpx]</tt><tt><br></tt> <tt>filename[ext,hpx]</tt><tt><br></tt> <tt><br></tt> <tt>where:</tt><tt><br></tt> <tt>ext: see</tt> <tt><a href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS Image</a></tt><tt><br></tt> <tt>sect: see</tt> <tt><a href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS Image</a></tt><tt><br></tt> <tt><br></tt> <tt>hpx:</tt><tt><br></tt> <tt>[order=ring|nested] # default ring</tt><tt><br></tt> <tt>[layout=equatorial|north|south] # default equatorial</tt><tt><br></tt> <tt>[col=<column number>] # defaut 1</tt><tt><br></tt> <tt>[quad=<quadurant number>] # (1-4) default 1</tt><tt><br></tt> <tt>[system=equatorial|galactic|ecliptic|unknown] # default unknown</tt><tt><br></tt> <tt><br></tt> <tt>Example:</tt> <tt><br></tt> <tt>$ds9 foo.fits # default load</tt> <tt><br></tt> <tt>$ds9 foo.fits[1] # load first extension</tt> <tt><br></tt> <tt>$ds9 foo.fits[order=ring,layout=equatorial,col=1,quad=1,system=unknown]</tt><tt><br></tt> <tt>$ds9 foo.fits[1,order=nested] # first extension, nested order</tt><br></blockquote> +<blockquote><tt>Syntax:<br> +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> +[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></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><tt><br></tt> <tt>$ds9 -mecube foo.fits # load multiple extension fits file as data cube</tt></blockquote> +<blockquote><tt>Example:<br> +$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><tt><br></tt> <tt>$ds9 -multiframe foo.fits # load multiple extension fits file as multiple frames</tt></blockquote> +<blockquote><tt>Example:<br> +$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> <br> @@ -107,57 +251,131 @@ See <a href="http://iraf.noao.edu/projects/ccdmosaic/imagedef/imagedef.html">NOA </tbody> </table> </center> -<blockquote><tt>Example:</tt><tt><br></tt> <tt>$ds9 -mosaicimage iraf foo.fits # load mosaic iraf from one fits file with multiple exts</tt><tt><br></tt> <tt>$ds9 -mosaic iraf foo.fits bar.fits wow.fits # load mosaic iraf from 3 files</tt><tt><br></tt> <tt>$ds9 -mosaicimage wcs foo.fits # load mosaic wcs from one fits file with multiple exts</tt><tt><br></tt> <tt>$ds9 -mosaic wcs foo.fits bar.fits wow.fits # load mosaic wcs from 3 files</tt><tt><br></tt> <tt>$ds9 -mosaicimage wfpc2 bar.fits # load wfpc2 mosaic</tt><tt><br></tt> <tt>$ds9 -mosaic foo.fits bar.fits wow.fits # load mosaic (wcs) from 3 files</tt><br></blockquote> +<blockquote><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></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> -<blockquote><tt>Example:</tt><tt><br></tt> <tt>$ds9 -rgbimage rgb.fits # load rgb image consisting of one fits file with 3 image exts</tt><tt><br></tt> <tt>$ds9 -rgbcube cube.fits # load rgb image consisting of one fits data cube</tt><tt><br></tt> <tt>$ds9 -rgb -red foo.fits -green bar.fits -blue wow.fits # rgb image from 3 fits images</tt><br></blockquote> +<blockquote><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></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. <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:</tt><tt><br></tt> <tt>filename[arr]</tt><tt><br></tt> <tt>filename[arr][sect]</tt><tt><br></tt> <tt>filename[sect][arr]</tt><tt><br></tt> <tt> </tt><tt><br></tt> <tt>where</tt><tt><br></tt> <tt>sect: see</tt> <tt><a href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS Image</a></tt><tt><br></tt> <tt>arr:</tt><tt><br></tt> -<blockquote><tt>xdim=value</tt><tt><br></tt> <tt>ydim=value</tt><tt><br></tt> <tt>zdim=value # default is a depth of 1</tt><tt><br></tt> <tt>dim=value</tt><tt><br></tt> <tt>dims=value</tt><tt><br></tt> <tt>bitpix=[8|16|-16|32|64|-32|-64]</tt><tt><br></tt> <tt>skip=value # must be even, most must be factor of 4</tt><tt><br></tt> <tt>arch|endian=[big|bigendian|little|littleendian]</tt><tt><br></tt></blockquote> +<blockquote><tt>Syntax:<br> +filename[arr]<br> +filename[arr][sect]<br> +filename[sect][arr]<br> + <br> +where<br> +sect: see<a href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS Image</a><br> +arr:<br></tt> +<blockquote><tt>xdim=value<br> +ydim=value<br> +zdim=value # default is a depth of 1<br> +dim=value<br> +dims=value<br> +bitpix=[8|16|-16|32|64|-32|-64]<br> +skip=value # must be even, most must be factor of 4<br> +arch|endian=[big|bigendian|little|littleendian]<br></tt></blockquote> <tt>Example:<br> $ds9 -array bar.arr[xdim=512,ydim=512,zdim=1,bitpix=16] # load 512x512 short<br> $ds9 -array bar.arr[dim=256,bitpix=-32,skip=4] # load 256x256 float with 4 byte head<br> $ds9 -array bar.arr[dim=512,bitpix=32,arch=little] # load 512x512 long, intel<br></tt> <p>or alternate format:</p> -<tt>filename[array(<type><dim><:skip><endian>)]</tt><tt><br></tt> <tt><br></tt> <tt>where:</tt><tt><br></tt> <tt>type:</tt> -<blockquote><tt>'b' 8 -bit unsigned char</tt><tt><br></tt> <tt>'s' 16-bit short int</tt><tt><br></tt> <tt>'u' 16-bit unsigned short int</tt><tt><br></tt> <tt>'i' 32-bit int</tt><tt><br></tt> <tt>'l' 64-bit int</tt><tt><br></tt> <tt>'r' 32-bit float</tt><tt><br></tt> <tt>'f' 32-bit float</tt><tt><br></tt> <tt>'d' 64-bit float</tt></blockquote> +<tt>filename[array(<type><dim><:skip><endian>)]<br> +<br> +where:<br> +type:</tt> +<blockquote><tt>'b' 8 -bit unsigned char<br> +'s' 16-bit short int<br> +'u' 16-bit unsigned short int<br> +'i' 32-bit int<br> +'l' 64-bit int<br> +'r' 32-bit float<br> +'f' 32-bit float<br> +'d' 64-bit float</tt></blockquote> <tt>dim:</tt> -<blockquote><tt>int # x,y dim</tt><tt><br></tt> <tt>int.int # x,y dim</tt><tt><br></tt> <tt>int.int.int # x,y,z dim</tt><tt><br></tt></blockquote> +<blockquote><tt>int # x,y dim<br> +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> <tt>endian:</tt> -<blockquote><tt>'l' little endian</tt><tt><br></tt> <tt>'b' big endian</tt><tt><br></tt></blockquote> -<tt>Example:</tt><tt><br></tt> <tt>$ds9 -array bar.arr[array(s512)] # load 512x512 short</tt><tt><br></tt> <tt>$ds9 -array bar.arr[array(r256:4)] # load 256x256 float with 4 byte head</tt><tt><br></tt> <tt>$ds9 -array bar.arr[array(i512l)] # load 512x512 long, intel</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> <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:</tt><tt><br></tt> <tt>filename</tt><tt><br></tt> <tt>filename[sect]</tt><tt><br></tt> <tt><br></tt> <tt>where:</tt><tt><br></tt> <tt>sect: see</tt> <tt><a href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS Image</a></tt><tt><br></tt> <tt><br></tt> <tt>Example:</tt><tt><br></tt> <tt>$ds9 -nrrd foo.nrrd</tt><tt><br></tt> <tt>$ds9 -nrrd foo.nrrd[100:200,100:200] # cropped</tt><br> +<tt>Syntax:<br> +filename<br> +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 -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: <tt>BIL, BIP, BSQ.<br></tt><br> -<tt>Syntax:</tt><tt><br></tt> <tt>filename</tt><tt><br></tt> <tt>filename[sect]</tt><tt><br></tt> <tt><br></tt> <tt>where:</tt><tt><br></tt> <tt>sect: see</tt> <tt><a href="file:///Users/joye/saods9/ds9/doc/ref/FITSImage">FITS Image</a></tt><tt><br></tt> <tt><br></tt> <tt>Example:</tt><tt><br></tt> <tt>$ds9 -envi foo.hdr foo.bsq<br> +<tt>Syntax:<br> +filename<br> +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></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> -<tt><br></tt> <tt>Syntax:</tt><tt><br></tt> <tt>filename</tt><tt><br></tt> <tt><br></tt> <tt>Example:</tt><tt><br></tt> <tt>$ ds9 -gif foo.gif</tt><br> +<tt><br> +Syntax:<br> +filename<br> +<br> +Example:<br> +$ 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:</tt><tt><br></tt> <tt>filename</tt><tt><br></tt> <tt><br></tt> <tt>Example:</tt><tt><br></tt> <tt>$ ds9 -tiff foo.tiff</tt><br> +<tt>Syntax:<br> +filename<br> +<br> +Example:<br> +$ 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> -<tt><br></tt> <tt>Syntax:</tt><tt><br></tt> <tt>filename</tt><tt><br></tt> <tt><br></tt> <tt>Example:</tt><tt><br></tt> <tt>$ ds9 -jpeg foo.jpeg</tt><br> +<tt><br> +Syntax:<br> +filename<br> +<br> +Example:<br> +$ 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:</tt><tt><br></tt> <tt>filename</tt><tt><br></tt> <tt><br></tt> <tt>Example:</tt><tt><br></tt> <tt>$ ds9 -png foo.png</tt><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> @@ -170,7 +388,16 @@ The command line for the loading this file type<br></tt></blockquote> Note that blank lines separate the file descriptions and should not be used as part of a description. Also, the '#' character is a comment character.<br> <br> The following macros are supported: <tt>$filename</tt><br> -<blockquote><tt>For Example:</tt><tt><br></tt> <tt># File access descriptions:</tt><tt><br></tt> <tt># help explanation</tt><tt><br></tt> <tt># file template</tt><tt><br></tt> <tt># file type</tt><tt><br></tt> <tt># access command</tt><tt><br></tt> <tt>IRAF IMH files</tt><tt><br></tt> <tt>*.imh</tt><tt><br></tt> <tt>IMH</tt><tt><br></tt> <tt>i2f -s $filename</tt></blockquote> +<blockquote><tt>For Example:<br> +# File access descriptions:<br> +# help explanation<br> +# file template<br> +# file type<br> +# access command<br> +IRAF IMH files<br> +*.imh<br> +IMH<br> +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> @@ -228,7 +455,14 @@ A new WCS specification can be loaded and used by the current image regardless o 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</tt><tt><br></tt> <tt> CRPIX2 258.93</tt><tt><br></tt> <tt> CRVAL1 -201.94541667302</tt><tt><br></tt> <tt> CRVAL2 -47.45444</tt><tt><br></tt> <tt> CDELT1 -2.1277777E-4</tt><tt><br></tt> <tt> CDELT2 2.1277777E-4</tt><tt><br></tt> <tt> CTYPE1 'RA---TAN'</tt><tt><br></tt> <tt> CTYPE2 'DEC--TAN'</tt></blockquote> +<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> |