3D

From c3564c38dae0f1755e53182ad95b57f01d1004a7 Mon Sep 17 00:00:00 2001 From: William Joye Date: Tue, 30 Apr 2019 15:17:19 -0400 Subject: clean up doc --- ds9/doc/ref/3d.html | 69 ++----- ds9/doc/ref/analysis.html | 469 ++++++++++++---------------------------------- ds9/doc/ref/backup.html | 48 ++--- ds9/doc/ref/bin.html | 43 ++--- ds9/doc/ref/catalog.html | 151 ++++----------- ds9/doc/ref/colorbar.html | 127 ++++++------- ds9/doc/ref/contour.html | 106 +++-------- ds9/doc/ref/file.html | 408 +++++++++++----------------------------- ds9/doc/ref/grid.html | 92 +++------ ds9/doc/ref/how.html | 155 ++++----------- ds9/doc/ref/index.html | 92 +++------ ds9/doc/ref/iraf.html | 107 ++--------- ds9/doc/ref/keyboard.html | 83 +++----- ds9/doc/ref/prefs.html | 33 +--- ds9/doc/ref/print.html | 47 ++--- ds9/doc/ref/region.html | 358 +++++++++-------------------------- ds9/doc/ref/vo.html | 64 ++----- 17 files changed, 654 insertions(+), 1798 deletions(-) diff --git a/ds9/doc/ref/3d.html b/ds9/doc/ref/3d.html index 964e09c..1be3358 100644 --- a/ds9/doc/ref/3d.html +++ b/ds9/doc/ref/3d.html @@ -1,77 +1,32 @@ - - - + + + 3D - -

3-D Frames

+ +

3-D Frames

-
Previous versions of DS9 would allow users to load 3-D data into -the traditional 2-D frames, and would allow users to step through -successive z-dimension pixel slices of the data cube. To visualize -the 3-D data in DS9 v. 7.0, a new module, encompassed by the new -Frame 3D option, allows users to load and view data cubes -in multiple dimensions.
-
The new module implements a simple ray-trace algorithm. For each -pixel on the screen, a ray is projected back into the view volume, -based on the current viewing parameters, returning a data value if -the ray intersects the FITS data cube. To determine the value -returned, there are 2 methods available, Maximum Intensity -Projection (MIP) and Average Intensity Projection (AIP). MIP -returns the maximum value encountered, AIP returns an average of -all values encountered. At this point, normal DS9 operations are -applied, such as scaling, clipping and applying a color -map.
-
Rendering time is independent upon the actual data cube size. -Instead, the time it takes to render is based on how many rays are -needed to project the data cube upon the screen in the view volume -and the current zoom factor. The new module requires no special -hardware or graphical processor unit (GPU) and the rendering time -is adequate for interactive GUI manipulation on most computers. The -rendering engine is developed using the POSIX thread library, -allowing multiple light weight processes to be spawned to complete -an image in parallel. The number of threads actually generated is a -user specified parameter. Since all modern hardware contain -multiple CPU cores, the default value is 8 threads. For larger work -stations, this number can be increase. For every doubling in the -number of CPU cores available, rendering times decrease -approximately 75%.
+
Previous versions of DS9 would allow users to load 3-D data into the traditional 2-D frames, and would allow users to step through successive z-dimension pixel slices of the data cube. To visualize the 3-D data in DS9 v. 7.0, a new module, encompassed by the new Frame 3D option, allows users to load and view data cubes in multiple dimensions.
+
The new module implements a simple ray-trace algorithm. For each pixel on the screen, a ray is projected back into the view volume, based on the current viewing parameters, returning a data value if the ray intersects the FITS data cube. To determine the value returned, there are 2 methods available, Maximum Intensity Projection (MIP) and Average Intensity Projection (AIP). MIP returns the maximum value encountered, AIP returns an average of all values encountered. At this point, normal DS9 operations are applied, such as scaling, clipping and applying a color map.
+
Rendering time is independent upon the actual data cube size. Instead, the time it takes to render is based on how many rays are needed to project the data cube upon the screen in the view volume and the current zoom factor. The new module requires no special hardware or graphical processor unit (GPU) and the rendering time is adequate for interactive GUI manipulation on most computers. The rendering engine is developed using the POSIX thread library, allowing multiple light weight processes to be spawned to complete an image in parallel. The number of threads actually generated is a user specified parameter. Since all modern hardware contain multiple CPU cores, the default value is 8 threads. For larger work stations, this number can be increase. For every doubling in the number of CPU cores available, rendering times decrease approximately 75%.

Example:
# create 3d frame, load fits file
# set view angle to az 45 el 30 deg
# set rendering method to Average Intensity Projection

-% ds9 -3d mycube.fits -3d vp 45 30 -3d method -aip
+% ds9 -3d mycube.fits -3d vp 45 30 -3d method aip

% xpaset -p ds9 3d
% xpaset -p ds9 file mycube.fits
% xpaset -p ds9 3d vp 45 30
% xpaset -p ds9 3d method aip
-All 2-D graphics, regions, cross hairs, contours, and coordinate -grids, are applied to the current slice, which is selected by the -user. When the user wishes to match or lock a 2-D image and to a -3-D data cube, the current slice is used to determine the rendering -solution. The user can crop the data cube for all 3 axes via the -command line or the GUI. The new module also supports FITS event -files binned into a data cube.
+All 2-D graphics, regions, cross hairs, contours, and coordinate grids, are applied to the current slice, which is selected by the user. When the user wishes to match or lock a 2-D image and to a 3-D data cube, the current slice is used to determine the rendering solution. The user can crop the data cube for all 3 axes via the command line or the GUI. The new module also supports FITS event files binned into a data cube.

-All printing support has been extended to the new 3-D module. The -user may generate 3-D images in Postscript, JPEG, TIFF, and other -formats, just as in the 2-D case. Furthermore, native printing is -supported for the Windows version.
+All printing support has been extended to the new 3-D module. The user may generate 3-D images in Postscript, JPEG, TIFF, and other formats, just as in the 2-D case. Furthermore, native printing is supported for the Windows version.

-DS9 analysis macros have been enhanced to fully support the new 3-D -module, allowing the user to invoke external analysis tasks based -on the current view parameters and to return results back into DS9 -in the form of text, plot, 2-D image, or 3-D image.

+DS9 analysis macros have been enhanced to fully support the new 3-D module, allowing the user to invoke external analysis tasks based on the current view parameters and to return results back into DS9 in the form of text, plot, 2-D image, or 3-D image. diff --git a/ds9/doc/ref/analysis.html b/ds9/doc/ref/analysis.html index 8b05f8b..bf64138 100644 --- a/ds9/doc/ref/analysis.html +++ b/ds9/doc/ref/analysis.html @@ -1,41 +1,17 @@ - - - + + + Analysis - -

Analysis

+ +

Analysis

-
Each file type known to DS9 can have user-defined analysis -commands associated with it. These analysis commands are defined at -start-up time , or loaded by the user, by means of an ASCII -analysis description file. The analysis commands are available for -execution, either via the Analysis Menu or the XPA point -Analysis. In addition, commands may be bound to -events, such as keystrokes or mouse clicks. This type of command is -called a bind command.
-
DS9 searches for an analysis file named ds9.ans or -ds9.analysis in the current directory and $HOME -to be loaded at startup. In addition, DS9 will search the following -directories for any analysis files to be loaded at startup in the -form of *.ds9: the current directory, $HOME/bin, -/usr/local/bin, /opt/local/bin, and -/soft/saord/bin. Finally, the user may specify analysis -files to be loaded at startup in the preferences analysis panel. -The user may also load or clear current analysis commands via -command line options or the Analysis menu.
-
When activated, either from the menu, XPA, or bound event, an -analysis command first is macro-expanded to fill in user-defined -arguments and then is executed externally. Results may be displayed -in a separate text window, plot window, or in a image frame.
+
Each file type known to DS9 can have user-defined analysis commands associated with it. These analysis commands are defined at start-up time , or loaded by the user, by means of an ASCII analysis description file. The analysis commands are available for execution, either via the Analysis Menu or the XPA point Analysis. In addition, commands may be bound to events, such as keystrokes or mouse clicks. This type of command is called a bind command.
+
DS9 searches for an analysis file named ds9.ans or ds9.analysis in the current directory and $HOME to be loaded at startup. In addition, DS9 will search the following directories for any analysis files to be loaded at startup in the form of *.ds9: the current directory, $HOME/bin, /usr/local/bin, /opt/local/bin, and /soft/saord/bin. Finally, the user may specify analysis files to be loaded at startup in the preferences analysis panel. The user may also load or clear current analysis commands via command line options or the Analysis menu.
+
When activated, either from the menu, XPA, or bound event, an analysis command first is macro-expanded to fill in user-defined arguments and then is executed externally. Results may be displayed in a separate text window, plot window, or in a image frame.
Syntax
Command Type
Macros
@@ -44,28 +20,20 @@ in a separate text window, plot window, or in a image frame.
Hierarchical Menus
Sample
Syntax
-The analysis file that defines the known analysis commands consists -of one or more file descriptors, each of which has the following -format: +The analysis file that defines the known analysis commands consists of one or more file descriptors, each of which has the following format:
Menu label to be used
A space separated list of file templates
Command type [menu | bind <event>]
The command line for the analysis program
-
Task names may contain space characters. All lines may be -indented. Also, the '#' character is a comment character. A -separator can be inserted in the menu by specifying the following -sequence '---'.
+
Task names may contain space characters. All lines may be indented. Also, the '#' character is a comment character. A separator can be inserted in the menu by specifying the following sequence '---'.
Example:
# this will insert a menu separator
---
-
Command -Type
+
Command Type

The third line indicates the type of command.

menu
-
A menu command creates an menu option under the -Analysis menu option, and can be invoked by the user via the -GUI or XPA.
+
A menu command creates an menu option under the Analysis menu option, and can be invoked by the user via the GUI or XPA.
Example:
# Menu command example
My Analysis Task
@@ -73,12 +41,7 @@ GUI or XPA.
menu
$data | doit | $text

bind
-
A bind command is a command that is bound to an event. -When the event occurs, the command is executed. Types of events -available include all TK events, including all keystrokes -and mouse clicks. If a command is bound to an event other -that a keystroke, care must be taken to not to interfere -with other internal DS9 events.
+
A bind command is a command that is bound to an event. When the event occurs, the command is executed. Types of events available include all TK events, including all keystrokes and mouse clicks. If a command is bound to an event other that a keystroke, care must be taken to not to interfere with other internal DS9 events.

To bind to a key stroke, use the following command type:

bind <keystroke>
Example: @@ -88,8 +51,7 @@ with other internal DS9 events.
bind x
echo "$x $y" | $text

web
-
A web command allows the user to invoke the internal -web browser from the analysis menu.
+
A web command allows the user to invoke the internal web browser from the analysis menu.
Example:
# web command example HTTP based @@ -103,208 +65,108 @@ web file:/home/joye/index.html

Macros

The following macros are macro-expanded to fill in user-defined -arguments before the command is executed. Strings that contain -$<macroname> that user does not want to be expanded may be -escaped by using $$<macroname>. All strings that contain -$<string> that are not a macro name will not be -affected.

The following macros are macro-expanded to fill in user-defined arguments before the command is executed. Strings that contain $<macroname> that user does not want to be expanded may be escaped by using $$<macroname>. All strings that contain $<string> that are not a macro name will not be affected.

For example:

echo "$$data $foo" | $text

will display a text dialog that contains "$data $foo"

$width
$height
$depth

Substitute the width, height, or depth of the data file in the -command line.

Substitute the width, height, or depth of the data file in the command line.

Syntax:     $width
    $height

-Example:     echo "$width $height -$depth" | $text
+Example:     echo "$width $height $depth" | $text

$bitpix

Substitute the bitpix of the data file in the command line.

Syntax: $bitpix

-Example: echo "$bitpix" | -$text +Example: echo "$bitpix" | $text

$data

Data from the current frame becomes the input data to the -command string. This data is in the form of a FITS image. This -macro can only used at the beginning of the command string.

Data from the current frame becomes the input data to the command string. This data is in the form of a FITS image. This macro can only used at the beginning of the command string.

Syntax: $data

-Example: $data | dosomething | -$text +Example: $data | dosomething | $text

$entry

Display an entry modal dialog. The returned string is -substituted. If cancel is selected, the command line is -not executed.

-Syntax: -$entry(<message>)
-
-Example: echo "$entry(Enter -something here)" | $text +

Display an entry modal dialog. The returned string is substituted. If cancel is selected, the command line is not executed.

+Syntax: $entry(<message>)
+
+Example: echo "$entry(Enter something here)" | $text

$env

Substitute the value of a shell environment variable.

-Syntax:     $env(<shell -variable>)
+Syntax:     $env(<shell variable>)

-Example:     echo "$env(PATH)" | -$text +Example:     echo "$env(PATH)" | $text

$filedialog

Display the standard file dialog. Substitutes the returned -pathname. Argument specifies if an open file or save file dialog is -invoked.

-Syntax: -$filedialog([open|save])
-
-Example: echo -"$filedialog(open)" | $text
+

Display the standard file dialog. Substitutes the returned pathname. Argument specifies if an open file or save file dialog is invoked.

+Syntax: $filedialog([open|save])
+
+Example: echo "$filedialog(open)" | $text

$filename

Substitute the filename of the data file in the command line. A -full filename includes any absolute or relative path. A root -filename contains no path. A (2D) subsection defines a subimage -from xmin,ymin to xmax,ymax. For Frame3D, a 2D -subsection will also include the current slice (PLANE=) parameter -if not 1. A 3D subsection defines a subimage from -xmin,ymin,zmin to xmax,ymax,zmax and no PLANE -parameter.

-Syntax:     $filename # filename -with extname, (2d) subsections, filters
-    $filename(root|root,base) # root filename -with with extname, no subsections, no -filters)
- $filename(full|full,base) # full filename -with extname, no subsections, no filters)
-
-Example:     dosomething $filename -| $text
-    dosomething $filename(root) | -$text
+

Substitute the filename of the data file in the command line. A full filename includes any absolute or relative path. A root filename contains no path. A (2D) subsection defines a subimage from xmin,ymin to xmax,ymax. For Frame3D, a 2D subsection will also include the current slice (PLANE=) parameter if not 1. A 3D subsection defines a subimage from xmin,ymin,zmin to xmax,ymax,zmax and no PLANE parameter.

+Syntax:     $filename # filename with extname, (2d) subsections, filters
+    $filename(root|root,base) # root filename with with extname, no subsections, no filters)
+ $filename(full|full,base) # full filename with extname, no subsections, no filters)
+
+Example:     dosomething $filename | $text
+    dosomething $filename(root) | $text
$filename[$regions] -

Combination of $filename and $regions macros. -Generates a series of filenames, each with a region.

-Syntax:     -$filename[$regions]
-    -$filename[$regions(<options>)]
-
-Example:     dosomething -$filename[$regions] | $text +

Combination of $filename and $regions macros. Generates a series of filenames, each with a region.

+Syntax:     $filename[$regions]
+    $filename[$regions(<options>)]
+
+Example:     dosomething $filename[$regions] | $text

$geturl

This macro differs from all other macros, including -$url, in that no subprocess pipe is created. Only HTTP is -supported. The contents of the url are retrieved and sent to -$text, $plot, or $image. No other -processing is allowed. The primary purpose of this macro is to -support external analysis for the Windows platform, which has no -subprocess support.

-Syntax: -$geturl(http://<hostname>:<port>/<query>)
- -
-Example: -$geturl(http://foo.bar.edu/foo.html) | $text
+

This macro differs from all other macros, including $url, in that no subprocess pipe is created. Only HTTP is supported. The contents of the url are retrieved and sent to $text, $plot, or $image. No other processing is allowed. The primary purpose of this macro is to support external analysis for the Windows platform, which has no subprocess support.

+Syntax: $geturl(http://<hostname>:<port>/<query>)
+
+Example: $geturl(http://foo.bar.edu/foo.html) | $text

$image

The resulting image data is display in a DS9 frame. This macro -should be the last macro of a command line. Optional parameter -indicates if a new frame and what type of frame is created for the -new data. The macro is removed from the command line before -execution.

The resulting image data is display in a DS9 frame. This macro should be the last macro of a command line. Optional parameter indicates if a new frame and what type of frame is created for the new data. The macro is removed from the command line before execution.

$message

Display a message dialog box, with option buttons. After -displaying the message, the macro is removed from the command line -before execution. If cancel or no is selected, -the command line is not executed.

-Syntax:     -$message(<message>)
-    -$message([ok|okcancel|yesno],<message>)
-
-Example:     $message(okcancel,This -is a Message)| doit | $text +

Display a message dialog box, with option buttons. After displaying the message, the macro is removed from the command line before execution. If cancel or no is selected, the command line is not executed.

+Syntax:     $message(<message>)
+    $message([ok|okcancel|yesno],<message>)
+
+Example:     $message(okcancel,This is a Message)| doit | $text

$null

Expect no output or results from analysis task. Note: no error -message will be returned if the analysis task fails to execute -correctly.

Expect no output or results from analysis task. Note: no error message will be returned if the analysis task fails to execute correctly.

Syntax: $null

-Example: echo "Hello, world" -> foo | $null +Example: echo "Hello, world" > foo | $null

$pan

Substitute current pan location of the particular data file are -returned. The default coordinate system is physical.

-Syntax: $pan - $pan(<coordinate -system>,<format>)
+

Substitute current pan location of the particular data file are returned. The default coordinate system is physical.

+Syntax: $pan $pan(<coordinate system>,<format>)

where:

$plot

Display data in plot window. This macro should be the last macro -of a command line. The data is read via STDIN and consist -of a pair of coordinates, with option error values. (xy, xyex, -xyey, xyexey) Default dimension is xy. The macro is -removed from the command line before execution.

Display data in plot window. This macro should be the last macro of a command line. The data is read via STDIN and consist of a pair of coordinates, with option error values. (xy, xyex, xyey, xyexey) Default dimension is xy. The macro is removed from the command line before execution.

For $plot(stdin) only:

The title, x axis label, and y axis label are assumed to be on -the first line of input, delimited with a new-line. However, if the -data starts with $BEGINTEXT, all text between -$BEGINTEXT and $ENDTEXT will be removed from the -data and displayed in a separate text dialog window, with the -remaining data, including the title, x axis label, and y axis -label, will be displayed in a plot window. Furthermore, if the data -contains the string $ERROR, an error is assumed to have -occurred and a text dialog window is displayed only.

The title, x axis label, and y axis label are assumed to be on the first line of input, delimited with a new-line. However, if the data starts with $BEGINTEXT, all text between $BEGINTEXT and $ENDTEXT will be removed from the data and displayed in a separate text dialog window, with the remaining data, including the title, x axis label, and y axis label, will be displayed in a plot window. Furthermore, if the data contains the string $ERROR, an error is assumed to have occurred and a text dialog window is displayed only.

$regions

Substitute region definition in specified region format, -coordinate system, and coordinate format. The default coordinate -system is physical, default coordinate format -degrees, and default region format DS9. Arguments -may appear in any order, as long as they are separated by ',' and -no spaces. If one or more properties are specified, only -regions with all of the specified properties will be -substituted.

Substitute region definition in specified region format, coordinate system, and coordinate format. The default coordinate system is physical, default coordinate format degrees, and default region format DS9. Arguments may appear in any order, as long as they are separated by ',' and no spaces. If one or more properties are specified, only regions with all of the specified properties will be substituted.

Syntax: $regions
$regions(<options>)

where options are one of the following:

also, the old SAOTNG formats are also supported:

    $regions_pixels
    $regions_degrees
@@ -317,49 +179,30 @@ format        =     $exclude_regions_pixels
    $exclude_regions_degrees
    $exclude_regions_hms
-Example:     dosomething $regions | -$text
+Example:     dosomething $regions | $text
    dosomething $regions(pros) | $text
-    dosomething $regions(source,wcs,fk5) | -$text
-    dosomething -$regions(saotng,background,exclude,ecliptic,sexagesimal) | -$text +    dosomething $regions(source,wcs,fk5) | $text
+    dosomething $regions(saotng,background,exclude,ecliptic,sexagesimal) | $text

$text

Display text in a text dialog window. This macro should be the -last macro of a command line. To display text from only STDOUT use -'|' as the pipe command. To display text from both STDOUT and -STDERR, use '|&' as the pipe command. No parameters are -required. The macro is removed from the command line before -execution.

Display text in a text dialog window. This macro should be the last macro of a command line. To display text from only STDOUT use '|' as the pipe command. To display text from both STDOUT and STDERR, use '|&' as the pipe command. No parameters are required. The macro is removed from the command line before execution.

Syntax: $text

-Example: doit | $text # -stdout +Example: doit | $text # stdout doit |& $text # stdout and stderr $url -URLs are processed and stored in a temporary file. Only HTTP and -anonymous FTP are supported. -Syntax: -$url(http://<hostname>:<port>/<query>) - -$url(ftp://<hostname>/<filename>) - -Example: -$url(http://legacy.gsfc.nasa.gov/rosat/data/p000s26b.img.Z) | -uncompress | $image - -$url(ftp://legacy.gsfc.nasa.gov/rosat/data/hri/images/rh100193_img.fits) -| $image +URLs are processed and stored in a temporary file. Only HTTP and anonymous FTP are supported. +Syntax: $url(http://<hostname>:<port>/<query>) + $url(ftp://<hostname>/<filename>) + +Example: $url(http://legacy.gsfc.nasa.gov/rosat/data/p000s26b.img.Z) | uncompress | $image + $url(ftp://legacy.gsfc.nasa.gov/rosat/data/hri/images/rh100193_img.fits) | $image $vo_method Returns the vo method. Syntax: $vo_method -Example: echo '$vo_method' | -$text +Example: echo '$vo_method' | $text $value -Substitute the value at the location of the cursor of an bind -event. +Substitute the value at the location of the cursor of an bind event. Syntax: $value Example: @@ -367,55 +210,33 @@ Example: $x $y $z -Substitute coordinates of an bind event. When a bind event is -triggered, the x,y coordinates of the mouse of the -particular data file are returned. The default coordinate system is -physical. This macro is only available for bind commands. -For datacubes, the z coordinate is returned based on the current -slice selected. +Substitute coordinates of an bind event. When a bind event is triggered, the x,y coordinates of the mouse of the particular data file are returned. The default coordinate system is physical. This macro is only available for bind commands. For datacubes, the z coordinate is returned based on the current slice selected. Syntax: $x - $x(<coordinate -system>,<format>) + $x(<coordinate system>,<format>) $y - $y(<coordinate -system>,<format>) + $y(<coordinate system>,<format>) $z $z(<coordinate system>) where: - coordinate system = -[image|physical|detector|amplifier|wcs|wcsa...wcsz] - sky -frame = -[fk4|fk5|icrs|galactic|ecliptic] - sky -format = -[hms|sexagesimal|degrees] - -Example: echo "$x $y" | -$text + coordinate system = [image|physical|detector|amplifier|wcs|wcsa...wcsz] + sky frame = [fk4|fk5|icrs|galactic|ecliptic] + sky format = [hms|sexagesimal|degrees] + +Example: echo "$x $y" | $text echo "$x $y $z" | $text - echo "$x(fk5,sexagesimal) $y(fk5,sexagesimal)" | -$text echo "$x(wcs) $y(wcs) -$z(wcs)" | $text + echo "$x(fk5,sexagesimal) $y(fk5,sexagesimal)" | $text echo "$x(wcs) $y(wcs) $z(wcs)" | $text $xpa Returns the xpa access point name. Syntax: $xpa -Example: echo '$xpa' | -$text +Example: echo '$xpa' | $text $xpa_method Returns the xpa method. Syntax: $xpa_method -Example: echo '$xpa_method' | -$text +Example: echo '$xpa_method' | $text Help -The user may define his own HELP message. This message -will be available to the user as a menu item. An optional label -maybe specified. The default label is Help. When invoked, -an text dialog window will appear, containing the message. Multiple -HELP items maybe defined within a menu or across -hierarchical menus. +The user may define his own HELP message. This message will be available to the user as a menu item. An optional label maybe specified. The default label is Help. When invoked, an text dialog window will appear, containing the message. Multiple HELP items maybe defined within a menu or across hierarchical menus. Example: help Main Help A help message may contain @@ -423,22 +244,16 @@ hierarchical menus. in the menu or menus endhelp Parameters -The user may define his own macros or parameters to be evaluated -before the command line is executed. To do this, the user defines a -param segment that is referenced in the command line. The param -definition has the follow format: +The user may define his own macros or parameters to be evaluated before the command line is executed. To do this, the user defines a param segment that is referenced in the command line. The param definition has the follow format: param <name> -<variable> <entry | checkbox | menu> <title> -<default> <{comment}> +<variable> <entry | checkbox | menu> <title> <default> <{comment}> ... endparam or param <name> @<iraf param filename> end -The definition either consisted of a number of variables, one -per row, or the name of a IRAF style parameter file. DS9 will look -for the IRAF parameter file in: +The definition either consisted of a number of variables, one per row, or the name of a IRAF style parameter file. DS9 will look for the IRAF parameter file in: ./<filename> $UPARM/<filename> $HOME/iraf/<filename> @@ -448,23 +263,14 @@ for the IRAF parameter file in: var2 checkbox {Variable 2} 1 {this is a checkbox} var3 menu {Variable 3} AAA|BBB|CCC {this is a menu} endparam -To use parameters, specify the param name at the beginning of -your command line: +To use parameters, specify the param name at the beginning of your command line: Parameter Test * menu -$param(foobar); echo "$var1 $var2 $var3" | -$text -When the menu item is selected, the user will be presented with -a dialog box that contains entry, checkbox, or menu choices -for each variable specified. If the user clicks ok, the values are -substituted in the command line before execution. -Hierarchical Menus -The user may define hierarchical menus. Use this to organized -crowded menus. To do this, frame menu entries with hmenu -<label> and endhmenu. Hierarchical menu labels -may contain spaces. Multiple levels maybe implemented. +$param(foobar); echo "$var1 $var2 $var3" | $text +When the menu item is selected, the user will be presented with a dialog box that contains entry, checkbox, or menu choices for each variable specified. If the user clicks ok, the values are substituted in the command line before execution. +Hierarchical Menus +The user may define hierarchical menus. Use this to organized crowded menus. To do this, frame menu entries with hmenu <label> and endhmenu. Hierarchical menu labels may contain spaces. Multiple levels maybe implemented. Example: hmenu Stuff hello @@ -479,13 +285,11 @@ may contain spaces. Multiple levels maybe implemented. hello world * menu - echo "Hello World" | -$text + echo "Hello World" | $text endhmenu endhmenu -Will create an hierarchical menu with two members, -hello and world. +Will create an hierarchical menu with two members, hello and world. Sample # # Analysis command descriptions: @@ -496,8 +300,7 @@ $text param foo var1 entry entry 40 {this is a entry} - var2 checkbox checkbox 1 {this is a -checkbox} + var2 checkbox checkbox 1 {this is a checkbox} var3 menu menu AAA|BBB|CCC {this is a menu} endparam @@ -510,8 +313,7 @@ param foobar endparam param ltc - bins entry "Enter number of [t1:t2:]bins" 0 -"('0' for default number of bins)" + bins entry "Enter number of [t1:t2:]bins" 0 "('0' for default number of bins)" endparam # Help Main Help @@ -599,24 +401,17 @@ hmenu Test Regions Test $regions *.fits menu - echo "$regions ds9_s:$regions(ds9,source,image) -ciao_b:$regions(ciao,background) -saotng_i:$regions(saotng,include,wcs,fk5) -pros_e:$regions(pros,exclude,wcs,fk5,sexagesimal) -xy_be:$regions(xy,background,exclude,wcs,fk4,hms)" | $text + echo "$regions ds9_s:$regions(ds9,source,image) ciao_b:$regions(ciao,background) saotng_i:$regions(saotng,include,wcs,fk5) pros_e:$regions(pros,exclude,wcs,fk5,sexagesimal) xy_be:$regions(xy,background,exclude,wcs,fk4,hms)" | $text Test $regions wcs *.fits menu - echo "$regions(ds9,wcs) -$regions(ds9,wcs,fk5,sexagesimal) $regions(ds9,wcsa) " | $text + echo "$regions(ds9,wcs) $regions(ds9,wcs,fk5,sexagesimal) $regions(ds9,wcsa) " | $text Test $include_regions_pixels *.fits menu - echo "ds9_s: $source_regions ds9_b: -$background_regions_pixels ds9_i: $include_regions_degrees ds9_e: -$exclude_regions_hms" | $text + echo "ds9_s: $source_regions ds9_b: $background_regions_pixels ds9_i: $include_regions_degrees ds9_e: $exclude_regions_hms" | $text Test $filename $regions *.fits @@ -657,14 +452,12 @@ hmenu Test Output Test $plot(title,x,y,xyey) * menu - cat xye.dat | $plot(Title,X Axis,Y -Axis,xyey) + cat xye.dat | $plot(Title,X Axis,Y Axis,xyey) Test $plot(title,x,y,xyexey) * menu - cat xyee.dat | $plot(Title,X Axis,Y -Axis,xyexey) + cat xyee.dat | $plot(Title,X Axis,Y Axis,xyexey) Test $plot(title,x,y,4) * @@ -710,14 +503,12 @@ hmenu Test Dialogs Test $message(message) * menu - $message(ok,This is a Message) | echo "hello" | -$text + $message(ok,This is a Message) | echo "hello" | $text Test $message(ok,message) * menu - $message(ok,This is a Message) | echo "World" | -$text + $message(ok,This is a Message) | echo "World" | $text Test $entry(message) * @@ -733,14 +524,12 @@ hmenu Test Params Test $param * menu - $param(foo); echo "$var1 $var2 $var3" | -$text + $param(foo); echo "$var1 $var2 $var3" | $text Test $param @file * menu - $param(bar); echo "$var1 $var2 $var3" | -$text + $param(bar); echo "$var1 $var2 $var3" | $text endhmenu hmenu Test Network @@ -751,30 +540,22 @@ hmenu Test Network Test $url(http://) * menu - -$url(http://legacy.gsfc.nasa.gov/FTP/rosat/data/cdrom/vol1/IMAGES/00h/p000s26b.img.Z) -| gunzip | $image + $url(http://legacy.gsfc.nasa.gov/FTP/rosat/data/cdrom/vol1/IMAGES/00h/p000s26b.img.Z) | gunzip | $image Test $url(ftp://) * menu - -$url(ftp://legacy.gsfc.nasa.gov/rosat/data/hri/images/fits/rh100193_img.fits) -| $image + $url(ftp://legacy.gsfc.nasa.gov/rosat/data/hri/images/fits/rh100193_img.fits) | $image Test $geturl $text * menu - -$geturl(http://hea-www.harvard.edu/RD/saord-cgi/funtools?funcnts+$filename+$regions(source,,)+$regions(background,,))|$text - + $geturl(http://hea-www.harvard.edu/RD/saord-cgi/funtools?funcnts+$filename+$regions(source,,)+$regions(background,,))|$text Test $geturl $plotstd * menu - $param(ltc); -$geturl(http://hea-www.harvard.edu/RD/saord-cgi/funtools?funhist_plot+$filename[$regions]+time+$bins)|$plot(stdin) - + $param(ltc); $geturl(http://hea-www.harvard.edu/RD/saord-cgi/funtools?funhist_plot+$filename[$regions]+time+$bins)|$plot(stdin) endhmenu hmenu Test Other @@ -791,8 +572,7 @@ hmenu Test Other test * menu - echo "Hello World" | -$text + echo "Hello World" | $text endhmenu endhmenu @@ -809,7 +589,6 @@ echo "$x(fk5,hms) $y(fk5,hms)" | $text $x(wcs,fk5,hms) $y(wcs,fk5,hms) *.fits bind z -echo "$x(wcs,fk5,hms) $y(wcs,fk5,hms)" | -$text +echo "$x(wcs,fk5,hms) $y(wcs,fk5,hms)" | $text diff --git a/ds9/doc/ref/backup.html b/ds9/doc/ref/backup.html index 5de7bfc..1e6c0b6 100644 --- a/ds9/doc/ref/backup.html +++ b/ds9/doc/ref/backup.html @@ -1,42 +1,22 @@ - - - + + + Backup - - Backup and Restore + + Backup and Restore -DS9 now supports Backup and Restore. When a backup is invoked, -DS9 will save in a backup save set all files needed to restore DS9 -to that state, including geometry, data files, colormaps, catalogs, -contours, and regions. +DS9 now supports Backup and Restore. When a backup is invoked, DS9 will save in a backup save set all files needed to restore DS9 to that state, including geometry, data files, colormaps, catalogs, contours, and regions. Backup Save Set -A backup save set consists of a text file, called a backup -script, and an optional directory, which will contain auxiliary -data files needed to restore DS9 to a previous state. The backup -file and the auxiliary directory maybe moved across file systems, -or even platforms, but must remain together in the same -directory. +A backup save set consists of a text file, called a backup script, and an optional directory, which will contain auxiliary data files needed to restore DS9 to a previous state. The backup file and the auxiliary directory maybe moved across file systems, or even platforms, but must remain together in the same directory. Image data files -By default, all data image files are save within the backup save -set. However, the user has the option, via the Preferences, to only -save only an absolute pathname to the data file, and not the data -file itself. This option will dramatically reduce the size of a -backup save set, but will restrict the usage to a particular file -system and platform. -Image files that have been loaded into DS9 via XPA, SAMP, or -from URL will always be saved into the save set. +By default, all data image files are save within the backup save set. However, the user has the option, via the Preferences, to only save only an absolute pathname to the data file, and not the data file itself. This option will dramatically reduce the size of a backup save set, but will restrict the usage to a particular file system and platform. +Image files that have been loaded into DS9 via XPA, SAMP, or from URL will always be saved into the save set. Caveats -There are several caveats in the usage of Backup and Restore. In -particular: +There are several caveats in the usage of Backup and Restore. In particular: Currently, there is no support for masks. External Analysis menus will not be saved. @@ -44,14 +24,10 @@ Plot Tool windows will not be saved. IIS frames (IRAF) will not be saved. SAMP and XPA sessions will not be saved. -And finally, if the image data had been loaded into DS9 via XPA, -SAMP, or from a URL, the following complex load operations are not -supported: +And finally, if the image data had been loaded into DS9 via XPA, SAMP, or from a URL, the following complex load operations are not supported: Open Mosaic IRAF Image Open Mosaic IRAF Segment Open Mosaic WCS Image -Open Mosaic WCS Segment Open Mosaic WFPC2 Open RGB Fits Image Open -RGB Fits Cube Open RGB Array Open Multi Ext Data Cube Open Multi -Ext Multiple Frames +Open Mosaic WCS Segment Open Mosaic WFPC2 Open RGB Fits Image Open RGB Fits Cube Open RGB Array Open Multi Ext Data Cube Open Multi Ext Multiple Frames diff --git a/ds9/doc/ref/bin.html b/ds9/doc/ref/bin.html index 88670d6..6676879 100644 --- a/ds9/doc/ref/bin.html +++ b/ds9/doc/ref/bin.html @@ -1,44 +1,25 @@ - - - + + + Bin - - Binning + + Binning -To create an image from a FITS Bin Table, the user needs to -specify a binning factor, binning buffer size, and the binning -function. -The Binning (or Block) Factor is defined as the following: A -value greater or equal to zero. This value indicates the number of -pixel values that will fall into a particular bin. -The Bin Buffer Size is overall size of the image generated. This -has no relation to min and max values of the columns used to create -the image. -The Bin Function is defined as the following: Average - all -pixel values that fall into one pixel bin are averaged. Sum - all -pixel values that fall into one pixel bin are summed. -Bin to Fit Frame will calculate a bin block factor as a power of -2 that will allow the entire data space to be displayed in the -current frame. -By default, DS9 will bin about the center of the image. To -determine the center of the image, DS9 will look for the following -keywords in order: +To create an image from a FITS Bin Table, the user needs to specify a binning factor, binning buffer size, and the binning function. +The Binning (or Block) Factor is defined as the following: A value greater or equal to zero. This value indicates the number of pixel values that will fall into a particular bin. +The Bin Buffer Size is overall size of the image generated. This has no relation to min and max values of the columns used to create the image. +The Bin Function is defined as the following: Average - all pixel values that fall into one pixel bin are averaged. Sum - all pixel values that fall into one pixel bin are summed. +Bin to Fit Frame will calculate a bin block factor as a power of 2 that will allow the entire data space to be displayed in the current frame. +By default, DS9 will bin about the center of the image. To determine the center of the image, DS9 will look for the following keywords in order: TDMIN/TDMAX TLMIN/TLMAX TALEN AXLEN -If no valid keywords are found, DS9 will define the center as -the middle of the possible data space based on the coordinate data -type. +If no valid keywords are found, DS9 will define the center as the middle of the possible data space based on the coordinate data type. diff --git a/ds9/doc/ref/catalog.html b/ds9/doc/ref/catalog.html index 7560b84..4529b3f 100644 --- a/ds9/doc/ref/catalog.html +++ b/ds9/doc/ref/catalog.html @@ -1,126 +1,49 @@ - - - + + + Catalogs - - Catalogs + + Catalogs -DS9 provides full support for loading, displaying, filtering, -and saving catalogs. DS9 allows you to overlay symbols from -multiple catalogs on the current image. -Local and on-line catalog access is supported. Most major -catalogs can be retrieved from online servers. Both the CDS and -SDSS catalog servers are now supported. Local catalog files in -starbase (rdb) or CSV (with or without header) are supported. -On-line catalogs are available via services provided by the -VizieR catalog access tool, CDS, Strasbourg, France (VizieR is a -joint effort of the Centre de Donnees Astronomiques de Strasbourg -and ESA-ESRIN Information Systems Division) and by the Sloan -Digital Sky Survey. -A selection of popular catalogs is provided in the Analysis -menu. In addition, you can search for other catalogs based on -title, keywords, mission, wavelength, and object type. -When a catalog is overlayed on an image, each displayed catalog -symbol consists of a shape, color, and text. An advanced symbol -editor is available that allows you to specify the shape, size, -color, and text of each symbol, based on catalog column values. -These symbol expressions can be saved for future use. -Along with the overlay display, a catalog list is provided in a -separate window. It displays the column values for each catalog -object. The catalog list can be sorted and filtered, and the -catalog display will be automatically updated. Advanced filtering -options are available. Catalogs can be loaded and saved as local -files in ASCII Starbase format. Each catalog contains header -information which can be displayed. The list can be printed -separately from the image. -An interactive connection between the displayed catalog symbols -and the catalog list is provided. When you select one or more rows -within the catalog list, the corresponding symbols are highlighted -on the image display. Conversely, selecting multiple symbols on the -image display will highlight the corresponding rows within the -catalog list. Catalog symbols can be converted to regions for use -with analysis tasks. +DS9 provides full support for loading, displaying, filtering, and saving catalogs. DS9 allows you to overlay symbols from multiple catalogs on the current image. +Local and on-line catalog access is supported. Most major catalogs can be retrieved from online servers. Both the CDS and SDSS catalog servers are now supported. Local catalog files in starbase (rdb) or CSV (with or without header) are supported. +On-line catalogs are available via services provided by the VizieR catalog access tool, CDS, Strasbourg, France (VizieR is a joint effort of the Centre de Donnees Astronomiques de Strasbourg and ESA-ESRIN Information Systems Division) and by the Sloan Digital Sky Survey. +A selection of popular catalogs is provided in the Analysis menu. In addition, you can search for other catalogs based on title, keywords, mission, wavelength, and object type. +When a catalog is overlayed on an image, each displayed catalog symbol consists of a shape, color, and text. An advanced symbol editor is available that allows you to specify the shape, size, color, and text of each symbol, based on catalog column values. These symbol expressions can be saved for future use. +Along with the overlay display, a catalog list is provided in a separate window. It displays the column values for each catalog object. The catalog list can be sorted and filtered, and the catalog display will be automatically updated. Advanced filtering options are available. Catalogs can be loaded and saved as local files in ASCII Starbase format. Each catalog contains header information which can be displayed. The list can be printed separately from the image. +An interactive connection between the displayed catalog symbols and the catalog list is provided. When you select one or more rows within the catalog list, the corresponding symbols are highlighted on the image display. Conversely, selecting multiple symbols on the image display will highlight the corresponding rows within the catalog list. Catalog symbols can be converted to regions for use with analysis tasks. Filter Option -The catalog list can be sorted and filtered, and the catalog -display will be automatically updated. A filter is conditional -expression, when evaluated for each row of the catalog, if true, -the row is displayed, and if false, the row is not displayed. The -conditional expression can be any valid TCL expression. The value -of a column may be indicated with $<column -name>. -$_RAJ2000>180. && -$_RAJ2000<270. +The catalog list can be sorted and filtered, and the catalog display will be automatically updated. A filter is conditional expression, when evaluated for each row of the catalog, if true, the row is displayed, and if false, the row is not displayed. The conditional expression can be any valid TCL expression. The value of a column may be indicated with $<column name>. +$_RAJ2000>180. && $_RAJ2000<270. $Jmag>11 -log($Kmag*10)<.3 [string equal $OTYPE_S -SNR] +log($Kmag*10)<.3 [string equal $OTYPE_S SNR] Advanced Symbol Editor -An advanced symbol editor is available that allows you to -specify the shape, size, color, and text of each symbol, based on -catalog column values. For each row of the catalog, one or more -conditional expressions are evaluated. For the first expression to -evaluate true, a given symbol is displayed, with the specified -shape, color, size and text properties. As with the filter, the -value of a particular column can be indicated as $<column -name>. -For the condition entry, the expression you type in is -automatically evaluated via TCL expr after macro -expansion. - -1 # -always -0 # -never -true # -always -false # -never -$Jmag>2 # -conditional -sin($Jmag)>.5 - -# conditional -[string equal $Class -SNR] # -conditional -[regexp {*SNR*} -$Class] # -conditional -For the size, size2, and angle entries, the expression you type -in is also automatically evaluated via TCL expr after -macro expansion. - -2 # -value of '2' is used -$Jmag # -value of column Jmag is used -$Jmag/2. # value -of column Jmag div 2 is used -(4+2)/3 # -value of '2' is used -For the text portion, this is not true. It is assumed to be -text, unless you explicitly use an expr operator. - -foo # -will put 'foo' above the symbol -$Jmag # -will put the value of column Jmag above the symbol -(4+2)/3 # -will put the text '(4+2)/3' above the symbol -[expr (4+2)/3] # will put the text '2' above the -symbol -[expr $Jmag/2.] # will take the value of Jmag and div by -2 -And finally, one special case for shape = text and text = empty. -In this case, the row number is displayed. +An advanced symbol editor is available that allows you to specify the shape, size, color, and text of each symbol, based on catalog column values. For each row of the catalog, one or more conditional expressions are evaluated. For the first expression to evaluate true, a given symbol is displayed, with the specified shape, color, size and text properties. As with the filter, the value of a particular column can be indicated as $<column name>. +For the condition entry, the expression you type in is automatically evaluated via TCL expr after macro expansion. +1 # always +0 # never +true # always +false # never +$Jmag>2 # conditional +sin($Jmag)>.5 # conditional +[string equal $Class SNR] # conditional +[regexp {*SNR*} $Class] # conditional +For the size, size2, and angle entries, the expression you type in is also automatically evaluated via TCL expr after macro expansion. +2 # value of '2' is used +$Jmag # value of column Jmag is used +$Jmag/2. # value of column Jmag div 2 is used +(4+2)/3 # value of '2' is used +For the text portion, this is not true. It is assumed to be text, unless you explicitly use an expr operator. +foo # will put 'foo' above the symbol +$Jmag # will put the value of column Jmag above the symbol +(4+2)/3 # will put the text '(4+2)/3' above the symbol +[expr (4+2)/3] # will put the text '2' above the symbol +[expr $Jmag/2.] # will take the value of Jmag and div by 2 +And finally, one special case for shape = text and text = empty. In this case, the row number is displayed. diff --git a/ds9/doc/ref/colorbar.html b/ds9/doc/ref/colorbar.html index 862c3e2..479081a 100644 --- a/ds9/doc/ref/colorbar.html +++ b/ds9/doc/ref/colorbar.html @@ -1,68 +1,65 @@ - - - - -Color - - - Colorbar - -Color Tags -The purpose of color tags are to highlight (or hide) certain -values of data, regardless of the color map selected. The user -creates, edits, and deletes color tags via the GUI. To create a -color tag, enter the Colorbar Mode, and click once on the colorbar. -This creates a default color tag. Click and drag to change the -values. Click and drag on one side to increase or decrease the -value. Double click to manually edit the values and color. Place -the cursor over the color tag and press the delete key to delete -it. From the color parameters dialog, the user can load, save, and -delete all color tags for that frame. -Visuals -DS9 supports a number of color environments. Not all color -environments, or visuals, are available on most machines. In fact, -you may be restricted to one or two, base on the color graphics -hardware your computer has. A color visual is composed of two -parts, the color model and the bit depth. Pseudo color uses a color -lookup table to derive the correct color, True color uses the value -directly as a RGB triplet, to derive the correct color. The follow -is a list of the color visuals DS9 currently supports: -pseudo color, 8 bit -true color, 8 bit -true color, 15 bit -true color, 16 bit -true color, 24 bit -You can use the xdpyinfo command to see if one of these -visual are available. NOTE: Linux Users-- if your desired visual is -not available, use the Xconfigarator command (Red Hat) or similar -command under other versions of linux, to configure your X window -visuals. -When DS9 is invoked, by default, it will use the default visual. -You can find out what the default visual is by using the -xdpyinfo command. You can also force DS9 to use another -visual by command line option. If you specify a visual, and it is -not available, DS9 will exit with an error message. - -$ds9 -# default visual, default depth -$ds9 -visual pseudo # pseudo -color, default depth -$ds9 -visual pseudocolor # pseudo color, default depth -$ds9 -visual pseudocolor8 # pseudo color 8 -$ds9 -visual true # -true color, default depth -$ds9 -visual truecolor # true color, default -depth -$ds9 -visual truecolor8 # true color 8 -$ds9 -visual truecolor16 # true color 16 -$ds9 -visual truecolor24 # true color 24 - - + + + + + Color + + + Colorbar + + + Color Tags + The purpose of color tags are to highlight (or hide) certain + values of data, regardless of the color map selected. The user + creates, edits, and deletes color tags via the GUI. To create a + color tag, enter the Colorbar Mode, and click once on the + colorbar. This creates a default color tag. Click and drag to + change the values. Click and drag on one side to increase or + decrease the value. Double click to manually edit the values and + color. Place the cursor over the color tag and press the delete + key to delete it. From the color parameters dialog, the user can + load, save, and delete all color tags for that frame. + + Visuals + DS9 supports a number of color environments. Not all color + environments, or visuals, are available on most machines. In + fact, you may be restricted to one or two, base on the color + graphics hardware your computer has. A color visual is composed + of two parts, the color model and the bit depth. True color uses + the value directly as a RGB triplet, to derive the correct + color. The follow is a list of the color visuals DS9 currently + supports: + true color, 8 bit + true color, 15 bit + true color, 16 bit + true color, 24 bit + You can use the xdpyinfo command to see if one of + these visual are available. NOTE: Linux Users-- if your desired + visual is not available, use the Xconfigarator command (Red Hat) + or similar command under other versions of linux, to configure + your X window visuals. + When DS9 is invoked, by default, it will use the default + visual. You can find out what the default visual is by using the + xdpyinfo command. You can also force DS9 to use another + visual by command line option. If you specify a visual, and it + is not available, DS9 will exit with an error message. + $ds9 + # default visual, default depth + $ds9 -visual + true # true + color, default depth + $ds9 -visual truecolor # true color, default + depth + $ds9 -visual truecolor8 # true color 8 + $ds9 -visual truecolor16 # true color 16 + $ds9 -visual truecolor24 # true color 24 + + diff --git a/ds9/doc/ref/contour.html b/ds9/doc/ref/contour.html index 82e0d1c..b18e374 100644 --- a/ds9/doc/ref/contour.html +++ b/ds9/doc/ref/contour.html @@ -1,101 +1,53 @@ - - - + + + Contours - - Contours + + Contours -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. +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. Contour Parameters -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. +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. Contour Levels -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. +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. Contour Smoothness -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. +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. Contour Scale Specifies the distribution of the contour levels. Contour Method -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. -Contour -Files -A contour file is an ASCII file containing a header, global -properties, coordinate system, contour levels, and contour -points. +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. +Contour Files +A contour file is an ASCII file containing a header, global properties, coordinate system, contour levels, and contour points. Header -A DS9 contour file may start with the following optional -header: - # Contour file format: DS9 version -7.5 +A DS9 contour file may start with the following optional header: + # Contour file format: DS9 version 7.5 Global Properties -Global properties affect all contour levels unless a line level -attribute is specified. The global keyword is first, -followed by a list of keyword = value pairs. Multiple global -property lines may be used within a region file. - global color=green width=1 dash=1 dashlist=8 -3 +Global properties affect all contour levels unless a line level attribute is specified. The global keyword is first, followed by a list of keyword = value pairs. Multiple global property lines may be used within a region file. + global color=green width=1 dash=1 dashlist=8 3 Coordinate Systems -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: - PHYSICAL # pixel coords of -original file using LTM/LTV - IMAGE # pixel coords of -current file - FK4,B1950 # sky coordinate -systems - FK5,J2000 # sky coordinate -systems - ICRS # sky coordinate -systems - GALACTIC # sky coordinate -systems - ECLIPTIC # sky coordinate -systems +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: + PHYSICAL # pixel coords of original file using LTM/LTV + IMAGE # pixel coords of current file + FK4,B1950 # sky coordinate systems + FK5,J2000 # sky coordinate systems + ICRS # sky coordinate systems + GALACTIC # sky coordinate systems + ECLIPTIC # sky coordinate systems WCS # primary WCS WCSA # secondary WCS - LINEAR # linear primary -WCS + LINEAR # linear primary WCS Contour Level -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 -. - level=15.78775 color=pink width=2 dash=yes -dashlist=2 2 +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 . + level=15.78775 color=pink width=2 dash=yes dashlist=2 2 Contour -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. +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. (202.4836468 47.22380226 202.4833538 47.2239185 202.4831634 47.22409874 - 202.4829883 -47.22428858) + 202.4829883 47.22428858) diff --git a/ds9/doc/ref/file.html b/ds9/doc/ref/file.html index b3f15dc..92e0d42 100644 --- a/ds9/doc/ref/file.html +++ b/ds9/doc/ref/file.html @@ -1,42 +1,33 @@ - - - + + + File Formats - - File Formats + + File Formats FITS FITS Image FITS Binary Events Table FITS HEALPIX Table FITS Data Cube -FITS Multiple Extension -Data Cube -FITS Multiple -Extension Multiple Frames +FITS Multiple Extension Data Cube +FITS Multiple Extension Multiple Frames FITS Mosaic FITS Mosaic Data Cube FITS RGB Split FITS Array -NRRD +NRRD ENVI GIF TIFF JPEG PNG External Format Support -External Analysis -Support +External Analysis Support Region Files Contour Files Color Lookup Table @@ -45,9 +36,7 @@ Support Startup File TCL FITS -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: Examine primary HDU, if IMAGE, load. @@ -55,26 +44,20 @@ no additional information is provide: If IMAGE, load. -If BINARY TABLE, create IMAGE if the following is -true: +If BINARY TABLE, create IMAGE if the following is true: FITS COMPRESSED: keyword ZIMAGE is T. -FITS EVENTS: keyword EXTNAME is EVENTS,STDEVT, or RAYEVENT, -column names X and Y are present. +FITS EVENTS: keyword EXTNAME is EVENTS,STDEVT, or RAYEVENT, column names X and Y are present. FITS HEALPIX: keyword PIXTYPE is HEALPIX. -If DS9 traverses the entire FITS file without satisfying -one of the above, an error is generated. +If DS9 traverses the entire FITS file without satisfying one of the above, an error is generated. -FITS keyword inheritance is supported. All valid FITS -BITPIX values are supported, along with -16, for -UNSIGNED SHORT. The following FITS keywords are -supported: +FITS keyword inheritance is supported. All valid FITS BITPIX values are supported, along with -16, for UNSIGNED SHORT. The following FITS keywords are supported: OBJECT UNITS @@ -87,16 +70,7 @@ supported: WCS keywords WCS# keywords FITS Image -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 IMAGE, use a 'p' as -the last character to indicate PHYSICAL coordinates. A -'*' indicates use the default for that axis only. Block is -optional and defaults to 1. +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 IMAGE, use a 'p' as the last character to indicate PHYSICAL coordinates. A '*' indicates use the default for that axis only. Block is optional and defaults to 1. Syntax: filename @@ -156,28 +130,15 @@ $ds9 foo.fits[10:200,40:100] # image section $ds9 foo.fits[10:200,40:100,2] # image section, blocked by 2 $ds9 foo.fits[*,40:100] # only section y axis $ds9 foo.fits[256@512@512] # section box at 512,512 -$ds9 foo.fits[2][100:200,100:200] # second extension, image -section -$ds9 foo.fits[2][100:200,100:200,2] # second extension, image -section, blocked by 2 +$ds9 foo.fits[2][100:200,100:200] # second extension, image section +$ds9 foo.fits[2][100:200,100:200,2] # second extension, image section, blocked by 2 $ds9 foo.fits[10:200,40:100,5:20] # cube section $ds9 foo.fits[*,40:100,5:20] # only section y and z axes $ds9 foo.fits[256@512@512] # section cube at 512,512 -$ds9 foo.fits[2][100:200,100:200,5:20] # second extension, cube -section -$ds9 foo.fits[2][100:200,100:200,2,5:20] # second extension, cube -section, blocked by 2 - FITS Binary Events Table - 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. +$ds9 foo.fits[2][100:200,100:200,5:20] # second extension, cube section +$ds9 foo.fits[2][100:200,100:200,2,5:20] # second extension, cube section, blocked by 2 + FITS Binary Events Table
+
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.

Syntax: filename filename[ext] @@ -206,9 +167,7 @@ bin: [bin=colz,filter] # bin cols 'x', 'y', and colz with filter [key=colx,coly] [binkey=colx,coly]
-(see Introduction -to Filtering)
+(see Introduction to Filtering)

Example: $ds9 foo.fits # default load @@ -216,33 +175,18 @@ $ds9 foo.fits[1] # load first extension $ds9 foo.fits[BCKGRD] # load extension named 'BCKGRD' $ds9 foo.fits[bin=detx,dety] # bin on detx,dety $ds9 foo.fits[2][bin=rawx,rawy] # load ext 2, cols rawx,rawy -$ds9 foo.fits[bg_events,bin=rawx,rawy] # load ext bg_events, cols -rawx,rawy +$ds9 foo.fits[bg_events,bin=rawx,rawy] # load ext bg_events, cols rawx,rawy $ds9 foo.fits[bin=x,y,pha] # bin on x,y,pi $ds9 foo.fits[bin=pi] # bin on x,y,pi -$ds9 'foo.fits[ccd_id==3&&energy>4000]' # quoted -filter -$ds9 '"foo.fits[ccd_id==3 && energy>4000]"' # double -quoted filter -$ds9 'foo.fits[events][pha>5,pi<2]' # load extension 'events' -and filter

+$ds9 'foo.fits[ccd_id==3&&energy>4000]' # quoted filter
+$ds9 '"foo.fits[ccd_id==3 && energy>4000]"' # double quoted filter
+$ds9 'foo.fits[events][pha>5,pi<2]' # load extension 'events' and filter

-
The shell environment variable DS9_BINKEY may be used -to specify default bin cols for FITS bin tables. Example:
+
The shell environment variable DS9_BINKEY may be used to specify default bin cols for FITS bin tables. Example:
$ export DS9_BINKEY='[bin=rawx,rawy]' $ ds9 foo.fits # load FITS bin table, bin on rawx, rawy
-
FITS -HEALPIX Table
-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.
+
FITS HEALPIX Table
+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.

Syntax: filename @@ -260,12 +204,8 @@ filename[sect][hpx] filename[ext,hpx] where: -ext: seeFITS -Image -sect: seeFITS -Image +ext: seeFITS Image +sect: seeFITS Image hpx: [order=ring|nested] # default ring @@ -277,123 +217,71 @@ hpx: Example: $ds9 foo.fits # default load $ds9 foo.fits[1] # load first extension -$ds9 -foo.fits[order=ring,layout=equatorial,col=1,quad=1,system=unknown] - -$ds9 foo.fits[1,order=nested] # first extension, nested -order
-
FITS -Cube
-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. -
FITS Multiple Extension -Cube
-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.
+$ds9 foo.fits[order=ring,layout=equatorial,col=1,quad=1,system=unknown]
+$ds9 foo.fits[1,order=nested] # first extension, nested order
+
FITS Cube
+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. +
FITS Multiple Extension Cube
+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.

Example: -$ds9 -mecube foo.fits # load multiple extension fits file as data -cube
-
FITS Multiple Extension -Multiple Frames
-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.
+$ds9 -mecube foo.fits # load multiple extension fits file as data cube
+
FITS Multiple Extension Multiple Frames
+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.

Example: -$ds9 -multiframe foo.fits # load multiple extension fits file as -multiple frames
+$ds9 -multiframe foo.fits # load multiple extension fits file as multiple frames

FITS Mosaic
-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.
+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.

DS9 supports three forms of mosaics: - +
+See NOAO IRAF Mosaic Data Structures
- + - +

IRAF
contains the DETSEC and DETSIZE keywords. -See NOAO -IRAF Mosaic Data Structures

WCS
each FITS image contains a valid -WCS.
each FITS image contains a valid WCS.

HST WFPC2
valid HST WFPC2 data cube, -consisting of 4 planes, along with a fits ascii table containing -wcs information. valid HST WFPC2 data cube, consisting of 4 planes, along with a fits ascii table containing wcs information.

Example: -$ds9 -mosaicimage iraf foo.fits # load mosaic iraf from one fits -file with multiple exts -$ds9 -mosaic iraf foo.fits bar.fits wow.fits # load mosaic iraf -from 3 files -$ds9 -mosaicimage wcs foo.fits # load mosaic wcs from one fits file -with multiple exts -$ds9 -mosaic wcs foo.fits bar.fits wow.fits # load mosaic wcs from -3 files +$ds9 -mosaicimage iraf foo.fits # load mosaic iraf from one fits file with multiple exts +$ds9 -mosaic iraf foo.fits bar.fits wow.fits # load mosaic iraf from 3 files +$ds9 -mosaicimage wcs foo.fits # load mosaic wcs from one fits file with multiple exts +$ds9 -mosaic wcs foo.fits bar.fits wow.fits # load mosaic wcs from 3 files $ds9 -mosaicimage wfpc2 bar.fits # load wfpc2 mosaic -$ds9 -mosaic foo.fits bar.fits wow.fits # load mosaic (wcs) from 3 -files
-
FITS -Mosaic Data Cube
-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. +$ds9 -mosaic foo.fits bar.fits wow.fits # load mosaic (wcs) from 3 files
+
FITS Mosaic Data Cube
+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.
FITS RGB
-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.
+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.

Example: -$ds9 -rgbimage rgb.fits # load rgb image consisting of one fits -file with 3 image exts -$ds9 -rgbcube cube.fits # load rgb image consisting of one fits -data cube -$ds9 -rgb -red foo.fits -green bar.fits -blue wow.fits # rgb image -from 3 fits images
+$ds9 -rgbimage rgb.fits # load rgb image consisting of one fits file with 3 image exts
+$ds9 -rgbcube cube.fits # load rgb image consisting of one fits data cube
+$ds9 -rgb -red foo.fits -green bar.fits -blue wow.fits # rgb image from 3 fits images

Split FITS
-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.
Array
-Raw data arrays are supported. To load an array, the user must -provide the dimensions, pixel depth, and optional header size and -architecture type. +Raw data arrays are supported. To load an array, the user must provide the dimensions, pixel depth, and optional header size and architecture type.
Syntax: filename[arr] filename[arr][sect] filename[sect][arr]
where
-sect: see FITS -Image +sect: see FITS Image arr:
xdim=value ydim=value @@ -404,15 +292,11 @@ arr: skip=value # must be even, most must be factor of 4
arch|endian=[big|bigendian|little|littleendian]
Example: -$ds9 -array bar.arr[xdim=512,ydim=512,zdim=1,bitpix=16] # load -512x512 short -$ds9 -array bar.arr[dim=256,bitpix=-32,skip=4] # load 256x256 float -with 4 byte head -$ds9 -array bar.arr[dim=512,bitpix=32,arch=little] # load 512x512 -long, intel +$ds9 -array bar.arr[xdim=512,ydim=512,zdim=1,bitpix=16] # load 512x512 short
+$ds9 -array bar.arr[dim=256,bitpix=-32,skip=4] # load 256x256 float with 4 byte head
+$ds9 -array bar.arr[dim=512,bitpix=32,arch=little] # load 512x512 long, intel

or alternate format:
filename[array(<type><dim><:skip><endian>)] - where: type: @@ -429,56 +313,42 @@ type: int.int # x,y dim
int.int.int # x,y,z dim
skip: -
int     # number of bytes to -skip
+
int     # number of bytes to skip
endian:
'l' little endian 'b' big endian
Example: -$ds9 -array bar.arr[array(s512)]   # load 512x512 -short -$ds9 -array bar.arr[array(r256:4)] # load 256x256 float with 4 byte -head -$ds9 -array bar.arr[array(i512l)] # load 512x512 long, -intel -
The shell environment variable DS9_ARRAY may be used to -specify default array parameters.
+$ds9 -array bar.arr[array(s512)]   # load 512x512 short
+$ds9 -array bar.arr[array(r256:4)] # load 256x256 float with 4 byte head
+$ds9 -array bar.arr[array(i512l)] # load 512x512 long, intel +
The shell environment variable DS9_ARRAY may be used to specify default array parameters.
Example: $export DS9_ARRAY='[dim=256,bitpix=-32]' $ds9 -array foo.arr # load 256x256 float

NRRD (Nearly Raw Raster -Data)

-Images in NRRD are supported directly. Encodings supported: -raw, gzip
+

NRRD (Nearly Raw Raster Data)

+Images in NRRD are supported directly. Encodings supported: raw, gzip
Syntax: filename
filename[sect]

where:
-sect: see FITS -Image
+sect: see FITS Image
Example:
$ds9 -nrrd foo.nrrd
$ds9 -nrrd foo.nrrd[100:200,100:200] # cropped

ENVI

-Images in ENVI are supported directly. Encodings supported: BIL, -BIP, BSQ.
+Images in ENVI are supported directly. Encodings supported: BIL, BIP, BSQ.
Syntax:
filename
filename[sect]

where:
-sect: see FITS -Image
+sect: see FITS Image

Example:
$ds9 -envi foo.hdr foo.bsq
$ds9 -envi foo.hdr foo.bsq[100:200,100:200] # cropped

GIF

-Images in GIF are supported directly. For a Frame, the -average of the luminosity is used. For Frame RGB, each -channel is loaded directly.
+Images in GIF are supported directly. For a Frame, the average of the luminosity is used. For Frame RGB, each channel is loaded directly.
Syntax: filename @@ -486,9 +356,7 @@ filename Example: $ ds9 -gif foo.gif

TIFF

-Images in TIFF are supported directly. For a Frame, the -average of the luminosity is used. For Frame RGB, each -channel is loaded directly.
+Images in TIFF are supported directly. For a Frame, the average of the luminosity is used. For Frame RGB, each channel is loaded directly.

Syntax: filename @@ -496,9 +364,7 @@ filename Example: $ ds9 -tiff foo.tiff

JPEG

-Images in JPEG are supported directly. For a Frame, the -average of the luminosity is used. For Frame RGB, each -channel is loaded directly.
+Images in JPEG are supported directly. For a Frame, the average of the luminosity is used. For Frame RGB, each channel is loaded directly.
Syntax: filename @@ -506,40 +372,25 @@ filename Example: $ ds9 -jpeg foo.jpeg

PNG

-Images in PNG are supported directly. For a Frame, the -average of the luminosity is used. For Frame RGB, each -channel is loaded directly.
+Images in PNG are supported directly. For a Frame, the average of the luminosity is used. For Frame RGB, each channel is loaded directly.

Syntax: filename Example: $ ds9 -png foo.png
-

External File Support

-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.
-At start-up, DS9 first searches for the ASCII file, named -.ds9.filin the local directory, then in the users home -directory.
-The file command first is macro-expanded to fill in user-defined -arguments and then is executed externally.
-The ASCII file that defines the known image files consists of one -or more file descriptors, each of which has the following -format:
+

External File Support

+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.
+At start-up, DS9 first searches for the ASCII file, named .ds9.filin the local directory, then in the users home directory.
+The file command first is macro-expanded to fill in user-defined arguments and then is executed externally.
+The ASCII file that defines the known image files consists of one or more file descriptors, each of which has the following format:

Help description
A space-separated list of templates
-A space-separated list of file types (not currently -used)
+A space-separated list of file types (not currently used)
The command line for the loading this file type

-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.
+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.

The following macros are supported: $filename

@@ -553,70 +404,43 @@ The following macros are supported: $filename
*.imh
IMH
i2f -s $filename
-

External Analysis Support

-For more information about external analysis support files, see -Analysis. -

Region -Files

-DS9 can read and write a number of region file formats. See -Regions documentation for more -information.
+

External Analysis Support

+For more information about external analysis support files, see Analysis. +

Region Files

+DS9 can read and write a number of region file formats. See Regions documentation for more information.

DS9
FUNTools
Ciao
SAOimage
IRAF PROS
-FITS REGION Binary -Table
+FITS REGION Binary Table
X Y
-

Contour -Files

-See Contours documentation for more -information.
-

Color -Lookup Table

-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:
+

Contour Files

+See Contours documentation for more information.
+

Color Lookup Table

+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:

SAOimage
SAOtng
XImtool

-DS9 uses the file extension to determine the color table -format:
+DS9 uses the file extension to determine the color table format:

.lut # XImtool, SAOtng .sao # DS9, SAOImage

WCS

-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.
-
-CRPIX1 -=               -257.75
-CRPIX2 -=               -258.93
-CRVAL1 =      --201.94541667302
-CRVAL2 -=             --47.45444
-CDELT1 =        --2.1277777E-4
-CDELT2 =         -2.1277777E-4
+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.
+
+CRPIX1 =               257.75
+CRPIX2 =               258.93
+CRVAL1 =      -201.94541667302
+CRVAL2 =             -47.45444
+CDELT1 =        -2.1277777E-4
+CDELT2 =         2.1277777E-4
CTYPE2 = 'DEC--TAN'

-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:
+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:

CRPIX1    257.75
CRPIX2    258.93
@@ -627,26 +451,12 @@ pairs without the intervening "=" sign:
CTYPE1   'RA---TAN'
CTYPE2   'DEC--TAN'

-
Preference -File
-A preference file is a valid tcl script generated by DS9 to save -the current preference items. See Preferences for more information. -
Startup -File
-If a startup file $HOME/ds9.ini is available, it is -sourced as the last step in initialization. The file permissions -must be group/world readonly.
-Users may have several different startup files. DS9 looks for a -startup file with its own name. By default, if the application is -named ds9, it will look for .ds9.ini. However, if -the DS9 application is named foo, then DS9 will look for -.foo.ini. In this manner, the user can have several -predefined startup files that are activated by invoking DS9 with a -different application names.
+
Preference File
+A preference file is a valid tcl script generated by DS9 to save the current preference items. See Preferences for more information. +
Startup File
+If a startup file $HOME/ds9.ini is available, it is sourced as the last step in initialization. The file permissions must be group/world readonly.
+Users may have several different startup files. DS9 looks for a startup file with its own name. By default, if the application is named ds9, it will look for .ds9.ini. However, if the DS9 application is named foo, then DS9 will look for .foo.ini. In this manner, the user can have several predefined startup files that are activated by invoking DS9 with a different application names.

TCL
-TCL/TK script file. Users may customize the appearance and enhance -the capabilities of DS9 by sourcing their own TCL -scripts.

+TCL/TK script file. Users may customize the appearance and enhance the capabilities of DS9 by sourcing their own TCL scripts. diff --git a/ds9/doc/ref/grid.html b/ds9/doc/ref/grid.html index 9ca2f17..e660006 100644 --- a/ds9/doc/ref/grid.html +++ b/ds9/doc/ref/grid.html @@ -1,89 +1,39 @@ - - - + + + Coordinate Grids - -

Coordinate Grids

+ +

Coordinate Grids

-
DS9 can create and display coordinate grids as an overlay on an -image. The Display Coordinate Grid Menu is used to display grids. A -coordinate grid is composed of Grid Lines, Axes, Border, and Title. -Axes include tick marks, title, and numbers. The appearance of the -coordinate grid is specified by parameters. These parameters may be -configured via the Coordinate Grid Parameters dialog box. In -addition to the axes titles and the grid title, the following menus -are available.
+
DS9 can create and display coordinate grids as an overlay on an image. The Display Coordinate Grid Menu is used to display grids. A coordinate grid is composed of Grid Lines, Axes, Border, and Title. Axes include tick marks, title, and numbers. The appearance of the coordinate grid is specified by parameters. These parameters may be configured via the Coordinate Grid Parameters dialog box. In addition to the axes titles and the grid title, the following menus are available.

Numeric Formats
-
The user may specify custom numeric formats for either axes. The -format specification can be empty (default) or a print function, -based on the selected coordinate system:
+
The user may specify custom numeric formats for either axes. The format specification can be empty (default) or a print function, based on the selected coordinate system:

image
physical
detector
amplifier
wcs linear
wcs equatorial
-
The format specification string to be passed to the C "printf" -function (e.g. "%%1.7G") in order to format a single coordinate -value.
-
The Format string supplied should contain one or more of the -following characters. These may occur in any order, but the -following is recommended for clarity:
-
"": Indicates that a plus sign should be prefixed to -positive values. By default, no plus sign is used.
-"z": Indicates that leading zeros should be prefixed to the value -so that the first field is of constant width, as would be required -in a fixed-width table (leading zeros are always prefixed to any -fields that follow). By default, no leading zeros are added.
-"i": Use the standard ISO field separator (a colon) between fields. -This is the default behaviour.
+
The format specification string to be passed to the C "printf" function (e.g. "%%1.7G") in order to format a single coordinate value.
+
The Format string supplied should contain one or more of the following characters. These may occur in any order, but the following is recommended for clarity:
+
"": Indicates that a plus sign should be prefixed to positive values. By default, no plus sign is used.
+"z": Indicates that leading zeros should be prefixed to the value so that the first field is of constant width, as would be required in a fixed-width table (leading zeros are always prefixed to any fields that follow). By default, no leading zeros are added.
+"i": Use the standard ISO field separator (a colon) between fields. This is the default behaviour.
"b": Use a blank to separate fields.
-"l": Use a letter ("h"/"d", "m" or "s" as appropriate) to separate -fields.
-"g": Use a letter and symbols to separate fields ("h"/"d", "m" or -"s", etc, as appropriate), but include escape sequences in the -formatted value so that the Plot class will draw the separators as -small super-scripts.
-"d": Include a degrees field. Expressing the angle purely in -degrees is also the default if none of "h", "m", "s" or "t" are -given.
-"h": Express the angle as a time and include an hours field (where -24 hours correspond to 360 degrees). Expressing the angle purely in -hours is also the default if "t" is given without either "m" or -"s".
+"l": Use a letter ("h"/"d", "m" or "s" as appropriate) to separate fields.
+"g": Use a letter and symbols to separate fields ("h"/"d", "m" or "s", etc, as appropriate), but include escape sequences in the formatted value so that the Plot class will draw the separators as small super-scripts.
+"d": Include a degrees field. Expressing the angle purely in degrees is also the default if none of "h", "m", "s" or "t" are given.
+"h": Express the angle as a time and include an hours field (where 24 hours correspond to 360 degrees). Expressing the angle purely in hours is also the default if "t" is given without either "m" or "s".
"m": Include a minutes field. By default this is not included.
-"s": Include a seconds field. By default this is not included. This -request is ignored if "d" or "h" is given, unless a minutes field -is also included.
-"t": Express the angle as a time (where 24 hours correspond to 360 -degrees). This option is ignored if either "d" or "h" is given and -is intended for use where the value is to be expressed purely in -minutes and/or seconds of time (with no hours field). If "t" is -given without "d", "h", "m" or "s" being present, then it is -equivalent to "h".
-".": Indicates that decimal places are to be given for the final -field in the formatted string (whichever field this is). The "." -should be followed immediately by an unsigned integer which gives -the number of decimal places required, or by an asterisk. If an -asterisk is supplied, a default number of decimal places is used -which is based on the value of the Digits -attribute.
-
All of the above format specifiers are case-insensitive. If -several characters make conflicting requests (e.g. if both "i" and -"b" appear), then the character occurring last takes precedence, -except that "d" and "h" always override "t".
-
The default formats are d.3 for degrees and -hms.1 / dms.1 / ldms.1 for -sexagesimal.
+"s": Include a seconds field. By default this is not included. This request is ignored if "d" or "h" is given, unless a minutes field is also included.
+"t": Express the angle as a time (where 24 hours correspond to 360 degrees). This option is ignored if either "d" or "h" is given and is intended for use where the value is to be expressed purely in minutes and/or seconds of time (with no hours field). If "t" is given without "d", "h", "m" or "s" being present, then it is equivalent to "h".
+".": Indicates that decimal places are to be given for the final field in the formatted string (whichever field this is). The "." should be followed immediately by an unsigned integer which gives the number of decimal places required, or by an asterisk. If an asterisk is supplied, a default number of decimal places is used which is based on the value of the Digits attribute.
+
All of the above format specifiers are case-insensitive. If several characters make conflicting requests (e.g. if both "i" and "b" appear), then the character occurring last takes precedence, except that "d" and "h" always override "t".
+
The default formats are d.3 for degrees and hms.1 / dms.1 / ldms.1 for sexagesimal.

diff --git a/ds9/doc/ref/how.html b/ds9/doc/ref/how.html index eb8f966..8786176 100644 --- a/ds9/doc/ref/how.html +++ b/ds9/doc/ref/how.html @@ -1,18 +1,13 @@ - - - + + + How - -

How it Works

+ +

How it Works

Table of Contents
How DS9 Renders an Image
@@ -21,136 +16,66 @@ Contours
Large Files

How DS9 renders an image
-
Here is a short description on how DS9 decides to paint a pixel -a color on the the screen, give an data value... you need a color -scale, a contrast/bias pair for the colorscale, clip values for the -data, a scale distribution, and finally, the value of the pixel in -question.
+
Here is a short description on how DS9 decides to paint a pixel a color on the the screen, give an data value... you need a color scale, a contrast/bias pair for the colorscale, clip values for the data, a scale distribution, and finally, the value of the pixel in question.

-
Step 1. Select a color scale. A color scale is defined as a -number of colors (RGB triplets). The number of RGB triplets can -vary from just a few to over 200. DS9 contains a number of -predefined color scales (Gray, A, B, I8, ...) or the user may load -his own color scale.
-
Step 2. Apply a contrast/bias pair. This step takes the result -of step 1 and creates a new array with the contrast/bias applied. -The length of the new array will between 200 (for pseudocolor) and -4096 (for truecolor).
-
Step 3. Calculate the data clip values (low/high data values). -The min/max data values may be used or an algorithm may be used to -determine the clip data values.
-
Step 4. Apply the scale distribution. This involves taking the -result of step 2, and creating yet another array, this time of size -16384, redistributing the colors, based on the scale algorithm -selected (see Scales).
-
Step 5. Based on your data clip values, and the value of the -pixel you have, index into the result of step 4, and you have an -index into lookup table (for pseudocolor) and an RGB pair (for -truecolor and postscript).
+
Step 1. Select a color scale. A color scale is defined as a number of colors (RGB triplets). The number of RGB triplets can vary from just a few to over 200. DS9 contains a number of predefined color scales (Gray, A, B, I8, ...) or the user may load his own color scale.
+
Step 2. Apply a contrast/bias pair. This step takes the result of step 1 and creates a new array with the contrast/bias applied. The length of the new array will between 200 (for pseudocolor) and 4096 (for truecolor).
+
Step 3. Calculate the data clip values (low/high data values). The min/max data values may be used or an algorithm may be used to determine the clip data values.
+
Step 4. Apply the scale distribution. This involves taking the result of step 2, and creating yet another array, this time of size 16384, redistributing the colors, based on the scale algorithm selected (see Scales).
+
Step 5. Based on your data clip values, and the value of the pixel you have, index into the result of step 4, and you have an index into lookup table (for pseudocolor) and an RGB pair (for truecolor and postscript).

Scales

The log function is defined as the following:

-
+

-
as x goes from 0 to 1. The user may specify an exponent -a to change the distribution of colors within the colorbar. -The default value of a is 1000. Typically, optical images -respond well at 1000, IR images as low as 100, and high energy bin -tables up to 10000. A value of 10000 closely matches the -log function of SAOImage as defined as the -following:
+
as x goes from 0 to 1. The user may specify an exponent a to change the distribution of colors within the colorbar. The default value of a is 1000. Typically, optical images respond well at 1000, IR images as low as 100, and high energy bin tables up to 10000. A value of 10000 closely matches the log function of SAOImage as defined as the following:

-
+

The pow function is defined as the following:

-
+

-
as x goes from 0 to 1. The user may specify an exponent -a to change the distribution of colors within the colorbar. -The default value of a is 1000.
-
The sqrt scale function is defined as the -following:
-

+
as x goes from 0 to 1. The user may specify an exponent a to change the distribution of colors within the colorbar. The default value of a is 1000.
+
The sqrt scale function is defined as the following:
+

as x goes from 0 to 1.
-
The square scale function is defined as the -following:
-

+
The square scale function is defined as the following:
+

as x goes from 0 to 1.
-
The asinh scale function is defined as the -following:
-

+
The asinh scale function is defined as the following:
+

as x goes from 0 to 1.
-
The sinh scale function is defined as the -following:
-

+
The sinh scale function is defined as the following:
+

as x goes from 0 to 1.
-
The histogram equalization scale function distributes -colors based on the frequency of each data value.
+
The histogram equalization scale function distributes colors based on the frequency of each data value.

Smoothing
-
The user may select one of three types of smoothing kernels. Two -parameters, r (radius) and k -(kernel size), are defined as the following:
-
Kernel width/height = 2k+1 with r -<= k
+
The user may select one of three types of smoothing kernels. Two parameters, r (radius) and k (kernel size), are defined as the following:
+
Kernel width/height = 2k+1 with r <= k
Boxcar function, width = 2r+1
Tophat function, where the diameter = 2r+1
Gaussian function, defined as: -

+

where the mean = 0 and sigma = r/2

Contours
-
The contour algorithm is from an unknown author and originally -came from FV. The difference between the two modes -are:
-
block : the image is blocked down before the -contour is generated
-smooth : the image is smoothed via a Gaussian kernel -before the contour is generated.
-
block mode is faster as the smoothing parameter -increases. Inversely, smooth mode is much slower as the -smoothing parameter increases.
+
The contour algorithm is from an unknown author and originally came from FV. The difference between the two modes are:
+
block : the image is blocked down before the contour is generated
+smooth : the image is smoothed via a Gaussian kernel before the contour is generated.
+
block mode is faster as the smoothing parameter increases. Inversely, smooth mode is much slower as the smoothing parameter increases.

Large Files
-There are several factors that determine if DS9 will be able to -load a large file.
-
32 bit OS vs 64 bit OS : to address very large files, you may -need to use an 64 bit OS with a 64bit version of DS9. 32bit apps -can address up to 4Gb of address space. However, depending on the -OS, this limit may be less. Linux for example, the limit appears to -be ~3GB (the OS and shared libs eat up a lot of address space). -Under 64bit Solaris, 32bit ds9 has a full 4Gb of space. MacOSX -appears to have a limit ~3Gb. Under windows, ~2Gb.
-
Large File Support: is the ability to sequence thru files larger -than 4Gb. DS9 is compiled with LFS.
-
File system: the OS file system must be able to support files -larger than 4Gb. Most recent file systems fully support -4GB>.
-
Memory Management: There are a number of memory management -techniques supported in DS9 that will greatly affect the ability -and speed of loading large files:
+There are several factors that determine if DS9 will be able to load a large file.
+
32 bit OS vs 64 bit OS : to address very large files, you may need to use an 64 bit OS with a 64bit version of DS9. 32bit apps can address up to 4Gb of address space. However, depending on the OS, this limit may be less. Linux for example, the limit appears to be ~3GB (the OS and shared libs eat up a lot of address space). Under 64bit Solaris, 32bit ds9 has a full 4Gb of space. MacOSX appears to have a limit ~3Gb. Under windows, ~2Gb.
+
Large File Support: is the ability to sequence thru files larger than 4Gb. DS9 is compiled with LFS.
+
File system: the OS file system must be able to support files larger than 4Gb. Most recent file systems fully support 4GB>.
+
Memory Management: There are a number of memory management techniques supported in DS9 that will greatly affect the ability and speed of loading large files:

$ ds9 foo.fits # uses mmap
$ cat foo.fits | ds9 - # allocates memory
$ xpaset -p ds9 file foo.fits # uses mmap
-$ xpaset -p ds9 fits foo.fits # allocates -memory
-
Memory Map (mmap) is very fast, limit is memory address -space (see above). Allocate is very slow, limit is amount of -physical memory + swap partition.
-
Scanning Data: DS9 needs to determine the min and max data -values to correctly display your image. For large files, such as -Mosaics and Data Cubes, this can take time. You have the -option of using using the FITS keywords DATAMIN/MAX or IRAFMIN/MAX -- great if present, bad because they are always wrong. Another -option is to specify the low and high clip values via the command -line or Scale dialogbox.
+$ xpaset -p ds9 fits foo.fits # allocates memory
+
Memory Map (mmap) is very fast, limit is memory address space (see above). Allocate is very slow, limit is amount of physical memory + swap partition.
+
Scanning Data: DS9 needs to determine the min and max data values to correctly display your image. For large files, such as Mosaics and Data Cubes, this can take time. You have the option of using using the FITS keywords DATAMIN/MAX or IRAFMIN/MAX - great if present, bad because they are always wrong. Another option is to specify the low and high clip values via the command line or Scale dialogbox.

diff --git a/ds9/doc/ref/index.html b/ds9/doc/ref/index.html index db6d624..ec89c37 100644 --- a/ds9/doc/ref/index.html +++ b/ds9/doc/ref/index.html @@ -1,87 +1,47 @@ - - - + + + Reference Manual - -

SAOImageDS9 Reference Manual

+ +

SAOImageDS9 Reference Manual

-
DS9 is the next version of the popular SAOtng display program. -It is a Tk/Tcl application which utilizes the TkSAO widget set. It -also incorporates the new X Public Access (XPA) mechanism to allow -external processes to access and control its data, GUI functions, -and algorithms. DS9 supports the direct display of FITS -images and binary tables, multiple frame buffers, region cursor -manipulation, many scale algorithms and colormaps, and easy -communication with external analysis tasks. It is highly -configurable and extensible to meet the evolving needs of the -astronomical community.
-
DS9 supports advanced features such as multiple frame buffers, -mosaic images, tiling, blinking, geometric markers, colormap -manipulation, scaling, arbitrary zoom, rotation, pan, and a variety -of coordinate systems (including Image, Physical, Detector, and -WCS). DS9 also supports FTP and HTTP access. The GUI for DS9 is -user configurable.
- +
DS9 is the next version of the popular SAOtng display program. It is a Tk/Tcl application which utilizes the TkSAO widget set. It also incorporates the new X Public Access (XPA) mechanism to allow external processes to access and control its data, GUI functions, and algorithms. DS9 supports the direct display of FITS images and binary tables, multiple frame buffers, region cursor manipulation, many scale algorithms and colormaps, and easy communication with external analysis tasks. It is highly configurable and extensible to meet the evolving needs of the astronomical community.
+
DS9 supports advanced features such as multiple frame buffers, mosaic images, tiling, blinking, geometric markers, colormap manipulation, scaling, arbitrary zoom, rotation, pan, and a variety of coordinate systems (including Image, Physical, Detector, and WCS). DS9 also supports FTP and HTTP access. The GUI for DS9 is user configurable.
+
- - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +

How It -Works Backup and -Restore File -Formats How It Works Backup and Restore File Formats

Mouse -and Keyboard Coordinate -Grids Preferences Mouse and Keyboard Coordinate Grids Preferences

Command -Line Options Catalogs 3-D -Frames Command Line Options Catalogs 3-D Frames

XPA Access -Points Colorbar
Contours XPA Access Points Colorbar
Contours

SAMP
Printing IRAF -Support SAMP
Printing IRAF Support

Regions Analysis Binning
Regions Analysis Binning

diff --git a/ds9/doc/ref/iraf.html b/ds9/doc/ref/iraf.html index a789f29..b516a22 100644 --- a/ds9/doc/ref/iraf.html +++ b/ds9/doc/ref/iraf.html @@ -1,36 +1,18 @@ - - - + + + IRAF Support - -
IRAF Support
+ +
IRAF Support

-
DS9 is a fully functional IRAF image display server. IRAF uses -the IIS protocol to communicate with a valid image display server, -such as DS9, ximtool, saoimage, and saotng. With DS9, no special -scripts are needed. If you have one of the above currently working, -DS9 works right out of the box. And DS9 now supports -IRAF's new IIS image display protocol that supports up to 16 -display frames.
-
All native DS9 functions may be used with images load with IRAF -display except for the Scale menu items. Values displayed -may the the true values, if a linear scale is specified with the -display command. Otherwise, the value is a scaled value. -DS9 supports IRAF in all display visuals including -Truecolor. Support full postscript printing of images -loaded from IRAF is provided.
+
DS9 is a fully functional IRAF image display server. IRAF uses the IIS protocol to communicate with a valid image display server, such as DS9, ximtool, saoimage, and saotng. With DS9, no special scripts are needed. If you have one of the above currently working, DS9 works right out of the box. And DS9 now supports IRAF's new IIS image display protocol that supports up to 16 display frames.
+
All native DS9 functions may be used with images load with IRAF display except for the Scale menu items. Values displayed may the the true values, if a linear scale is specified with the display command. Otherwise, the value is a scaled value. DS9 supports IRAF in all display visuals including Truecolor. Support full postscript printing of images loaded from IRAF is provided.

Command Line Arguments
-
As with ximtool, the follow command line arguments may be -used to specify the communication parameters:
+
As with ximtool, the follow command line arguments may be used to specify the communication parameters:

fifo fifo_only inet_only @@ -43,18 +25,9 @@ used to specify the communication parameters: port 5137 unix /tmp/.IMT%d

Configuration
-
An IRAF image server uses a configuration file to specify -the number of available buffers and their sizes. What actually -passes from IRAF is not the buffer size, but an index number into -this file.
-
So when an image server starts (DS9), it will attempt to locate -this file as $HOME/.imtoolrc and -/usr/local/lib/imtoolrc. If not found, it will look for -shell environment variables IMTOOLRC and -imtoolrc, that contains the name of the configuration -file.
-
If no configuration file is found, DS9 will assume the following -default configuration:
+
An IRAF image server uses a configuration file to specify the number of available buffers and their sizes. What actually passes from IRAF is not the buffer size, but an index number into this file.
+
So when an image server starts (DS9), it will attempt to locate this file as $HOME/.imtoolrc and /usr/local/lib/imtoolrc. If not found, it will look for shell environment variables IMTOOLRC and imtoolrc, that contains the name of the configuration file.
+
If no configuration file is found, DS9 will assume the following default configuration:

1 2 512 512 # imt1|imt512 2 2 800 800 # imt2|imt800 3 2 1024 1024 # imt3|imt1024 @@ -64,8 +37,7 @@ default configuration: 7 1 8192 8192 # imt7|imt8192 8 1 1024 4096 # imt8|imt1x4 9 2 1144 880 # imt9|imtfs full screen (1152x900 minus frame) -10 2 1144 764 # imt10|imtfs35 full screen at 35mm film aspect -ratio +10 2 1144 764 # imt10|imtfs35 full screen at 35mm film aspect ratio 11 2 128 128 # imt11|imt128 12 2 256 256 # imt12|imt256 13 2 128 1056 # imt13|imttall128 tall & narrow for spectro. @@ -75,69 +47,30 @@ ratio 17 2 1008 648 # imt17|imtssy Solitaire fmt w/ imtool border 18 2 1024 680 # imt18|imtssn Solitaire fmt w/out imtool border 19 1 4096 1024 # imt19|imt4x1
-
If on the other hand, IRAF assumes a different buffer size, the -image will appear corrupted and DS9 may issue a number of error -messages.
-
Another problem is that this file must be in sync with -dev$graphcap. If your system administrator has made -changes to graphcap, they must also be implemented in -imtoolrc.
+
If on the other hand, IRAF assumes a different buffer size, the image will appear corrupted and DS9 may issue a number of error messages.
+
Another problem is that this file must be in sync with dev$graphcap. If your system administrator has made changes to graphcap, they must also be implemented in imtoolrc.

Here is a note from NOAO:

-
The messages means that there is no /usr/local/lib/imtoolrc -file on the machine. This is created as a symlink to dev$imtoolrc -by the iraf install script but only if the /usr/local/lib dir -already exists on the machine. The fix is the create the dir and -rerun the install script or else make the link by hand. Users can -also just copy dev$imtoolrc to $HOME/.imtoolrc and restart the -server to also workaround it. Note that an existing .imtoolrc might -define old frame buffer configs which might confuse things, so if -the system file exists check for a private copy screwing things -up.
+
The messages means that there is no /usr/local/lib/imtoolrc file on the machine. This is created as a symlink to dev$imtoolrc by the iraf install script but only if the /usr/local/lib dir already exists on the machine. The fix is the create the dir and rerun the install script or else make the link by hand. Users can also just copy dev$imtoolrc to $HOME/.imtoolrc and restart the server to also workaround it. Note that an existing .imtoolrc might define old frame buffer configs which might confuse things, so if the system file exists check for a private copy screwing things up.

Windows DS9 and IRAF
-
To direct image output from IRAF to DS9 running under windows, -use the IMTDEV environment variable. For example, if the -windows machine is named 'foo.bar.edu', define IMTDEV to -the follow value before entering IRAF.
+
To direct image output from IRAF to DS9 running under windows, use the IMTDEV environment variable. For example, if the windows machine is named 'foo.bar.edu', define IMTDEV to the follow value before entering IRAF.

$ setenv IMTDEV inet:5137:foo.bar.edu $ cl cl> display dev$pix

Scale Menu Disabled
-
When you display an image from IRAF into DS9, IRAF -actually does the color scale distribution. In Display, -use the ztrans and z1,z2zscale -parameter to auto determine z1,z2. Here are the -DISPLAY parameters in question: parameters to set the -upper/lower bounds and distribution. You can also use the
+
When you display an image from IRAF into DS9, IRAF actually does the color scale distribution. In Display, use the ztrans and z1,z2zscale parameter to auto determine z1,z2. Here are the DISPLAY parameters in question: parameters to set the upper/lower bounds and distribution. You can also use the

ztrans=[linear|log|none|user] z1=min z2=max zscale=[yes|no]
-
What actually is sent from IRAF to DS9 is one byte per -pixel, values 0-200, which already has applied both the upper and -lower clipping bounds and the distribution. So this is why, the -SCALE menu is disabled in DS9 when it receives a image -from IRAF.
+
What actually is sent from IRAF to DS9 is one byte per pixel, values 0-200, which already has applied both the upper and lower clipping bounds and the distribution. So this is why, the SCALE menu is disabled in DS9 when it receives a image from IRAF.

MSCRED/MSCZERO
-
DS9 now supports IRAF's new IIS image display protocol. However, -there is one minor problem with the mscred task -msczero. Before using msczero, issue the following -command in the cl:
+
DS9 now supports IRAF's new IIS image display protocol. However, there is one minor problem with the mscred task msczero. Before using msczero, issue the following command in the cl:

cl> set disable_wcs_maps="" cl> flpr

IMEXAMINE
-
Due to the unique relationship between DS9 and IRAF, if you use -the imexamine task, you can take advantage of a special -feature of DS9. Instead of loading the image from IRAF with the -display task, load the image directly into DS9. Then, from -the cl prompt, invoke imexamine without a filename. -IRAF will ask DS9 for the current filename and use it for analysis. -This approach provides several advantages over previous methods. -First, it will work with compound fits images such as mosaics, data -cubes, and rgb images. Second, the image displays includes true -image data and WCS information, not the approximated data from -IRAF.
+
Due to the unique relationship between DS9 and IRAF, if you use the imexamine task, you can take advantage of a special feature of DS9. Instead of loading the image from IRAF with the display task, load the image directly into DS9. Then, from the cl prompt, invoke imexamine without a filename. IRAF will ask DS9 for the current filename and use it for analysis. This approach provides several advantages over previous methods. First, it will work with compound fits images such as mosaics, data cubes, and rgb images. Second, the image displays includes true image data and WCS information, not the approximated data from IRAF.

diff --git a/ds9/doc/ref/keyboard.html b/ds9/doc/ref/keyboard.html index 594ca03..bcb79c4 100644 --- a/ds9/doc/ref/keyboard.html +++ b/ds9/doc/ref/keyboard.html @@ -1,24 +1,18 @@ - - - + + + Mouse and Keyboard - -
Mouse and Keyboard
+ +
Mouse and Keyboard

Mouse Buttons
-
The following table contains the event bindings for the mouse -buttons.
+
The following table contains the event bindings for the mouse buttons.
- +
- - + - +

@@ -30,57 +24,38 @@ buttons.

Button 1 Depends on current MODE, which may be selected by the EDIT menu -option.
+ Depends on current MODE, which may be selected by the EDIT menu option.
In Region mode, create/edit/delete regions.
In Crosshair mode, will move current crosshair.
In Colorbar mode, will change contrast and bias of colormap.
In Pan mode, will move or pan to clicked location.
In Zoom mode, will zoom about clicked location.
In Rotate mode, will rotate image about center.
-In Crop mode, will select 2-D crop region. For 3-D -Shift-click will edit front clip plane, Control-click -will edit back clip plane.
+In Crop mode, will select 2-D crop region. For 3-D Shift-click will edit front clip plane, Control-click will edit back clip plane.
In Catalog mode, will select catalog regions.
In examine mode, will follow IRAF examine protocol.

Button 2 Pan mode: will move or pan to clicked location. Behavior -depends on the PAN preference settings. Pan mode: will move or pan to clicked location. Behavior depends on the PAN preference settings.

Button 3 Colorbar mode: will change the contrast and bias of the -colormap. Colorbar mode: will change the contrast and bias of the colormap.

Greek and other special characters.
-
The concept of a separate SYMBOL font is no longer -implemented with the latest OS font and scripting support, -especially with scalable anti-alias fonts such as Xft for Linux. -Most newer fonts (if not all) now have greek characters as part of -the font. The greek characters start at unicode \u0391 for 'A' and -\u03b1 for 'a'. Each OS has a tool used to build and copy a string -of characters. Then use the Edit:Paste menu of DS9 to insert the -character string.
+
The concept of a separate SYMBOL font is no longer implemented with the latest OS font and scripting support, especially with scalable anti-alias fonts such as Xft for Linux. Most newer fonts (if not all) now have greek characters as part of the font. The greek characters start at unicode \u0391 for 'A' and \u03b1 for 'a'. Each OS has a tool used to build and copy a string of characters. Then use the Edit:Paste menu of DS9 to insert the character string.

-
Linux- Gnome: gucharmap
Linux- KDE: -kcharselect
MacOSX: Character Viewer (Select -Edit:Special Characters) Now click and drag the characters -to a terminal window. Then select the string and select -Edit:Copy.
-Windows: Character Map (from Start button, select -All Programs, Accessories, System Tools -and then Character Map)
+
Linux- Gnome: gucharmap
Linux- KDE: kcharselect
MacOSX: Character Viewer (Select Edit:Special Characters) Now click and drag the characters to a terminal window. Then select the string and select Edit:Copy.
+Windows: Character Map (from Start button, select All Programs, Accessories, System Tools and then Character Map)

Keyboard Shortcuts
-
The following table contains the list of keyboard shortcuts and -the resulting action taken.
+
The following table contains the list of keyboard shortcuts and the resulting action taken.
- +
@@ -148,14 +123,12 @@ In Pointer mode, will move the cursor up one pixel.
In Crosshair mode, will move the crosshair up one pixel.
In Pan mode, will pan the image up one pixel. - + - @@ -163,8 +136,7 @@ In Pan mode, will pan the image to the right one pixel. h
@@ -176,19 +148,14 @@ In Crosshair mode, will also move the crosshair down one pixel.
In Pan mode, will pan the image down one pixel. - - + + - + diff --git a/ds9/doc/ref/prefs.html b/ds9/doc/ref/prefs.html index df89038..00ff4cb 100644 --- a/ds9/doc/ref/prefs.html +++ b/ds9/doc/ref/prefs.html @@ -1,34 +1,17 @@ - - - + + +Preferences - -
Preferences
+ +
Preferences
-
Allows the user to customize the appearance and behavior of the -GUI . Please note: some preferences take effect immediately, while -others require DS9 to be restarted. Changes to the preferences can -be saved by selecting the Save button. Use the -Clear Preferences button to restore default settings.
-
User preferences are stored in $HOME/.ds9.prf. DO NOT -EDIT this file, since it will be deleted or overwritten by DS9. The -file permissions must be group/world readonly.
-
Users may have several different preference files. DS9 looks for -a preference file with its own name. By default, if the application -is named ds9, it will look for .ds9.prf. However, -if the DS9 application is named foo, then DS9 will look -for .foo.prf. In this manner, the user can have several -predefined preference files that are activated by invoking DS9 with -a different application names.
+
Allows the user to customize the appearance and behavior of the GUI . Please note: some preferences take effect immediately, while others require DS9 to be restarted. Changes to the preferences can be saved by selecting the Save button. Use the Clear Preferences button to restore default settings.
+
User preferences are stored in $HOME/.ds9.prf. DO NOT EDIT this file, since it will be deleted or overwritten by DS9. The file permissions must be group/world readonly.
+
Users may have several different preference files. DS9 looks for a preference file with its own name. By default, if the application is named ds9, it will look for .ds9.prf. However, if the DS9 application is named foo, then DS9 will look for .foo.prf. In this manner, the user can have several predefined preference files that are activated by invoking DS9 with a different application names.

diff --git a/ds9/doc/ref/print.html b/ds9/doc/ref/print.html index bd5dd19..5f5c08a 100644 --- a/ds9/doc/ref/print.html +++ b/ds9/doc/ref/print.html @@ -1,55 +1,30 @@ - - - + + +Printing - -
Printing
+ +
Printing
-
DS9 provides strong Postscript printing support. This is not a -screen capture method, but a full level 1/2/3 postscript driver. -The postscript images generated are detailed and accurate as -possible, given the resolution of the data, and the printing -resolution.
+
DS9 provides strong Postscript printing support. This is not a screen capture method, but a full level 1/2/3 postscript driver. The postscript images generated are detailed and accurate as possible, given the resolution of the data, and the printing resolution.

Postscript Level

-
Level 1-- The postscript generated consist of a color lookup -table and image data, encoded in ASCIIHEX. All line -graphics and text are postscript elements.
-
Level 2-- The postscript generated consist of a color lookup -table and image data, compressed with RLE, and encoded in -ASCIIHEX85. All line graphics and text are postscript -elements.
+
Level 1-- The postscript generated consist of a color lookup table and image data, encoded in ASCIIHEX. All line graphics and text are postscript elements.
+
Level 2-- The postscript generated consist of a color lookup table and image data, compressed with RLE, and encoded in ASCIIHEX85. All line graphics and text are postscript elements.

-
Level 3-- The postscript generated consist of a color lookup -table and image data, compressed with GZIP. All line -graphics and text are postscript elements.
+
Level 3-- The postscript generated consist of a color lookup table and image data, compressed with GZIP. All line graphics and text are postscript elements.

Postscript Color Model
-
DS9 supports three color models for level 2/3 postscript. All -three color models generate approximately the same size files.
+
DS9 supports three color models for level 2/3 postscript. All three color models generate approximately the same size files.

RGB CMYK Grayscale

Resolution
-
Unlike graphic elements, image data must be sampled when encoded -into postscript. The specified resolution parameter is in "pixels -per inch" and is independent of the current screen resolution. A -value of 96 maps to the current screen resolution. Any value over -96 will over sample the image, while any value under 96 will under -sample. For high resolution printers and posters, the higher -resolution sampling, the better. However, keep in mind the size of -the postscript file grows with the square of the increase in -resolution.
+
Unlike graphic elements, image data must be sampled when encoded into postscript. The specified resolution parameter is in "pixels per inch" and is independent of the current screen resolution. A value of 96 maps to the current screen resolution. Any value over 96 will over sample the image, while any value under 96 will under sample. For high resolution printers and posters, the higher resolution sampling, the better. However, keep in mind the size of the postscript file grows with the square of the increase in resolution.

diff --git a/ds9/doc/ref/region.html b/ds9/doc/ref/region.html index 9a70e95..41c3063 100644 --- a/ds9/doc/ref/region.html +++ b/ds9/doc/ref/region.html @@ -1,36 +1,24 @@ - - - + + +Regions - - + + - -
Regions
+ +
Regions
-
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.
+
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.
Region Descriptions
Region Properties
Region File Format
Composite Region
Template Region
External Region Files
-
Region Descriptions
+
Region Descriptions

Circle Usage: circle x y radius # fill=[0|1]

Ellipse @@ -40,154 +28,101 @@ Usage: box x y width height angle# fill=[0|1]

Polygon Usage: polygon x1 y1 x2 y2 x3 y3 ...# fill=[0|1]

Point -Usage: point x y # -point=[circle|box|diamond|cross|x|arrow|boxcircle] [size] -       circle point x -y
+Usage: point x y # point=[circle|box|diamond|cross|x|arrow|boxcircle] [size]
+       circle point x y

Line Usage: line x1 y1 x2 y2 # line=[0|1] [0|1]

Vector Usage: vector x1 y1 length angle # vector=[0|1]

Text Usage: text x y # text={Your Text Here} -       text x y {Your Text -Here}
+       text x y {Your Text Here}

Ruler -Usage: ruler x1 y1 x2 y2 # ruler=[pixels|degrees|arcmin|arcsec] -[format=<spec>]
+Usage: ruler x1 y1 x2 y2 # ruler=[pixels|degrees|arcmin|arcsec] [format=<spec>]

Compass -Usage: compass x1 y1 length # compass=<coordinate system> -<north label> <east label> [0|1] [0|1]
+Usage: compass x1 y1 length # compass=<coordinate system> <north label> <east label> [0|1] [0|1]

Projection Usage: projection x1 y1 x2 y2 width

Annulus Usage: annulus x y inner outer n=# -       annulus x y r1 r2 -r3...
+       annulus x y r1 r2 r3...

Ellipse Annulus -Usage: ellipse x y r11 r12 r21 r22 n=# [angle] -       ellipse x y r11 r12 r21 -r22 r31 r32 ... [angle]
+Usage: ellipse x y r11 r12 r21 r22 n=# [angle]
       ellipse x y r11 r12 r21 r22 r31 r32 ... [angle]

Box Annulus Usage: box x y w1 h1 w2 h2 [angle] -       box x y w1 h1 w2 h2 w3 h3 ... -[angle]
+       box x y w1 h1 w2 h2 w3 h3 ... [angle]

Panda -Usage: panda x y startangle stopangle nangle inner outer -nradius
+Usage: panda x y startangle stopangle nangle inner outer nradius

Epanda -Usage: epanda x y startangle stopangle nangle inner outer nradius -[angle]
+Usage: epanda x y startangle stopangle nangle inner outer nradius [angle]

Bpanda -Usage: bpanda x y startangle stopangle nangle inner outer nradius -[angle]
+Usage: bpanda x y startangle stopangle nangle inner outer nradius [angle]

Composite Usage: # composite x y angle
-
Region -Properties
-
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.
+
Region Properties
+
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.

Text
-
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 textangle to specify angle -in degress based on current coordinate system axes.
-Example: circle(100,100,20) # text={This message has both a " -and ' in it} textangle=30 +
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 textangle to specify angle in degress based on current coordinate system axes.
+Example: circle(100,100,20) # text={This message has both a " and ' in it} textangle=30
Color
-
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)
+
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)
Example:
circle(100,100,20) # color=green
circle(100,100,20) # color=#48f
Dash List
-
Sets dashed line parameters. This does not render the region in -dashed lines.
+
Sets dashed line parameters. This does not render the region in dashed lines.
Example: circle(100,100,20) # dashlist=8 3

Width

Sets the line width used to render the region.
Example: circle(100,100,20) # width=2

Font
-
The font property specifies the font family, size, weight, and -slant of any text to be displayed along with the region.
+
The font property specifies the font family, size, weight, and slant of any text to be displayed along with the region.
Example: circle(100,100,20) # font="times 12 bold italic"
Can Select
-
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.
+
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.
Example: circle(100,100,20) # select=1

Can Highlite
-The Highlite property specifies if the edit handles become visible -when the region is selected.
+The Highlite property specifies if the edit handles become visible when the region is selected.
Example: circle(100,100,20) # hightlite=1

Dash
-
Render region using dashed lines using current dashlist -value.
+
Render region using dashed lines using current dashlist value.
Example: circle(100,100,20) # dash=1

Fixed in Size
-
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.
+
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.
Example: circle(100,100,20) # fixed=1
Can Edit
-
The Edit property specifies if the user is allowed to edit the -region via the GUI.
+
The Edit property specifies if the user is allowed to edit the region via the GUI.
Example: circle(100,100,20) # edit=1
Can Move
-
The Move property specifies if the user is allowed to move the -region via the GUI.
+
The Move property specifies if the user is allowed to move the region via the GUI.
Example: circle(100,100,20) # move=1
Can Rotate
-
The Rotate property specifies if the user is allowed to rotate -the region via the GUI.
+
The Rotate property specifies if the user is allowed to rotate the region via the GUI.
Example: circle(100,100,20) # rotate=1
Can Delete
-
The Delete property specifies if the user is allowed to delete -the region via the GUI.
+
The Delete property specifies if the user is allowed to delete the region via the GUI.
Example: circle(100,100,20) # delete=1
Include/Exclude
-
The Include/Exclude properties flags the region with a boolean -NOT for later analysis. Use '+' for include (default), '-' -for exclude.
+
The Include/Exclude properties flags the region with a boolean NOT for later analysis. Use '+' for include (default), '-' for exclude.
Example: -circle(100,100,20)

Source/Background
-
The Source/Background properties flag the region for use with -other analysis applications. The default is source
+
The Source/Background properties flag the region for use with other analysis applications. The default is source
Example: circle(100,100,20) # source
-        circle(200,200,10) -# background
+        circle(200,200,10) # background

Tag
-
All regions may have zero or more tags associated with it, which -may be used for grouping and searching.
-Example: circle(100,100,20) # tag={Group 1} tag={Group -2} +
All regions may have zero or more tags associated with it, which may be used for grouping and searching.
+Example: circle(100,100,20) # tag={Group 1} tag={Group 2}
Circle | Ellipse | Box | Polygon
-
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.
+
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.
Example: circle(100,100,20) # fill=1
Line
-
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.
+
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.
Example: line(100,100,200,200) # line=1 1
Ruler
-
The ruler region may display information in 'pixels', 'degrees', -'arcmin', or 'arcsec'. Use the ruler property to indicate which -format to display distances in.
+
The ruler region may display information in 'pixels', 'degrees', 'arcmin', or 'arcsec'. Use the ruler property to indicate which format to display distances in.
Example: ruler(100,100,200,200) # ruler=arcmin
Point
-
Point regions have an associated type and size. Use the point -property to set the point type.
+
Point regions have an associated type and size. Use the point property to set the point type.
Example: point(100,100) # point=diamond 31
Default Properties

The default properties are:
@@ -201,45 +136,30 @@ property to set the point type.
highlite=1
include=1
fixed=0
-
Region -File Format
+
Region File Format

Syntax
-
Region arguments may be separated with either a comma or space. -Optional parentheses may be used a the beginning and end of a -description.
+
Region arguments may be separated with either a comma or space. Optional parentheses may be used a the beginning and end of a description.
circle 100 100 10
circle(100 100 10)
circle(100,100,10)

Comments
-
All lines that begin with # are comments and will be -ignored.
+
All lines that begin with # are comments and will be ignored.
# This is a comment

Delimiter
-
All lines may be delimited with either a new-line or -semi-colon.
+
All lines may be delimited with either a new-line or semi-colon.
circle 100 100 10
ellipse 200 200 20 40 ; box 300 300 20 40

Header
-
A DS9 region file may start with the following optional -header:
+
A DS9 region file may start with the following optional header:
# Region file format: DS9 version 4.0

Global Properties
-
Global properties affect all regions unless a local property is -specified. The global keyword is first, followed by a list -of keyword = value pairs. Multiple global property lines may be -used within a region file.
-global color=green font="helvetica 10 normal roman" edit=1 -move=1 delete=1 highlite=1 include=1 wcs=wcs
+
Global properties affect all regions unless a local property is specified. The global keyword is first, followed by a list of keyword = value pairs. Multiple global property lines may be used within a region file.
+global color=green font="helvetica 10 normal roman" edit=1 move=1 delete=1 highlite=1 include=1 wcs=wcs

Local Properties
-
Local properties start with a # after a region description and -only affect the region it is specified with.
-physical;circle(504,513,20) # color=red text={This is a -Circle}
+
Local properties start with a # after a region description and only affect the region it is specified with.
+physical;circle(504,513,20) # color=red text={This is a Circle}

Coordinate Systems
-
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:
+
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:
PHYSICAL IMAGE FK4,B1950 @@ -251,71 +171,35 @@ WCS WCSA LINEAR

Mosaic Images
-
While some coordinate systems are unique across mosaic images, -others coordinate systems, such as image, or -physical , are valid on a per segment basis. In this case, -use tile to specify which header to use in all coordinate -conversions. The default is the first header, or tile -1.
+
While some coordinate systems are unique across mosaic images, others coordinate systems, such as image, or physical , are valid on a per segment basis. In this case, use tile to specify which header to use in all coordinate conversions. The default is the first header, or tile 1.
Example: tile 2;fk5;point(100,100)
Multiple WCS
-
If an image has multiple wcs's defined, use wcs# to -specify which wcs to use for all wcs references. Valid values are -wcs, wcsa, wcsb, wcsc... wcsz. +
If an image has multiple wcs's defined, use wcs# to specify which wcs to use for all wcs references. Valid values are wcs, wcsa, wcsb, wcsc... wcsz. Example: wcsa;linear;point(100,100) # point=diamond
Specifying Positions and Sizes -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: +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: position arguments -[num]                   -# context-dependent (see below) -[num]d                  -# degrees -[num]r                  -# radians -[num]p                  -# physical pixels -[num]i                  -# image pixels -[num]:[num]:[num]       # hms for -'odd' position arguments -[num]:[num]:[num]       # dms for -'even' position arguments -[num]h[num]m[num]s      # explicit -hms -[num]d[num]m[num]s      # explicit -dms +[num]                   # context-dependent (see below) +[num]d                  # degrees +[num]r                  # radians +[num]p                  # physical pixels +[num]i                  # image pixels +[num]:[num]:[num]       # hms for 'odd' position arguments +[num]:[num]:[num]       # dms for 'even' position arguments +[num]h[num]m[num]s      # explicit hms +[num]d[num]m[num]s      # explicit dms size arguments -[num]                   -# context-dependent (see below) -[num]"                  -# arc sec -[num]'                  -# arc min -[num]d                  -# degrees -[num]r                  -# radians -[num]p                  -# physical pixels -[num]i                  -# image pixels -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: -All pure numbers have implied units corresponding to the -current coordinate system. -If no such system is explicitly specified, the default system is -implicitly assumed to be PHYSICAL. In practice this means -that for IMAGE and PHYSICAL systems, pure numbers -are pixels. Otherwise, for all systems other than linear, pure -numbers are degrees. For LINEAR 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: +[num]                   # context-dependent (see below) +[num]"                  # arc sec +[num]'                  # arc min +[num]d                  # degrees +[num]r                  # radians +[num]p                  # physical pixels +[num]i                  # image pixels +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: +All pure numbers have implied units corresponding to the current coordinate system. +If no such system is explicitly specified, the default system is implicitly assumed to be PHYSICAL. In practice this means that for IMAGE and PHYSICAL systems, pure numbers are pixels. Otherwise, for all systems other than linear, pure numbers are degrees. For LINEAR 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: IMAGE LINEAR FK4, B1950 @@ -327,81 +211,33 @@ PHYSICAL AMPLIFIER DETECTOR WCS,WCSA-WCSZ -If no coordinate system is specified, PHYSICAL is -assumed. PHYSICAL or a World Coordinate System such as -J2000 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., +If no coordinate system is specified, PHYSICAL is assumed. PHYSICAL or a World Coordinate System such as J2000 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., image; circle 100 100 10 physical; ellipse 200 200 10 20 fk5; point 30 50 wcsa; fk4; point 202 47 wcsp; linear; point 100 100 -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 J2000, then +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 J2000, then circle 10:10:0 20:22:0 3' is equivalent to: j2000; circle 10:10:0 20:22:0 3' -Note that by using units as described above, you may mix -coordinate systems within a region specifier; e.g., +Note that by using units as described above, you may mix coordinate systems within a region specifier; e.g., physical; circle 6500 9320 3' -Note that, for regions which accept a rotation angle such -as: +Note that, for regions which accept a rotation angle such as: ellipse (x, y, r1, r2, angle) box(x, y, w, h, angle) -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: +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: fk4;ellipse(22:59:43.985, +58:45:26.92,320", 160", 30) will not, in general, be the same region specified as: physical;ellipse(465, 578, 40, 20, 30) -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. -Composite -Region -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. -Template -Region -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. -External Region Files -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 XPA -regions point is used specify the output coordinate system and -format. On input, the menu or xpa point is used only for the X -Y format. For all other formats, the input coordinate system -is specified in the regions file itself. -Funtools - +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. +Composite Region +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. +Template Region +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. +External Region Files +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 XPA regions point is used specify the output coordinate system and format. On input, the menu or xpa point is used only for the X Y format. For all other formats, the input coordinate system is specified in the regions file itself. +Funtools When using DS9 regions file in FUNTOOLS: LINE is ignored VECTOR is ignored @@ -434,9 +270,7 @@ ELLIPSE ANNULUS is ignored BOX ANNULUS is ignored EPANDA is ignored BPANDA is ignored - SAOimage - + SAOimage

When importing from SAOIMAGE into DS9: POINT is translated into BOX CIRCLE POINT @@ -474,8 +308,7 @@ BOX ANNULUS is ignored PANDA is ignored EPANDA is ignored BPANDA is ignored
-FITS -REGION Binary Table
+FITS REGION Binary Table

When importing from FITS REGION into DS9: POINT is translated into BOX CIRCLE POINT @@ -493,14 +326,7 @@ ROTRHOMBUSis ignored DS9 currently can not export into this format. X Y
-
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 XPA 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.
+
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 XPA 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.
Example:# this is a comment physical # this overrides the specified coordinate system 300 300 diff --git a/ds9/doc/ref/vo.html b/ds9/doc/ref/vo.html index bf929a7..6118aea 100644 --- a/ds9/doc/ref/vo.html +++ b/ds9/doc/ref/vo.html @@ -1,65 +1,29 @@ - - - + + + Virtual Observatory - - Virtual Observatory Reference + + Virtual Observatory Reference Summary -Use the Web proxy connection if your firewall does not allow -your computer to connect directly to external computers. In this -case, you also must use DS9's internal browser. +Use the Web proxy connection if your firewall does not allow your computer to connect directly to external computers. In this case, you also must use DS9's internal browser. Details -When you click on one of the Virtual Observatory servers in the -VO list, DS9 will attempt to connect to that server and (if the -internal Web display is enabled) display its Web page. The square -box to the left of the server name turns yellow while the -connection is being established and then green to signal -success. -A direct connection is fast and flexible. Among other things, it -allows you to perform analysis on your own local data (the VO -server will retrieve the image from DS9) and also allows you to use -an external browser to load images. -Some system managers configure their firewall explicitly to -prevent computers in their care from making a direct connection to -an external host. Instead, they only allow external access through -a Web proxy -server (such as SOCKS). If you are using a computer behind a -restricted firewall of this sort, then DS9 will not be able to -connect directly to a VO server. The yellow box will not turn green -and eventually DS9 will display an error message. -In this case, you can choose to have DS9 communicate with the VO -servers through your Web proxy server. DS9 will use your proxy to -send its commands and retrieve its data and analysis results, -rather than doing this directly. Note that the following -restrictions apply: +When you click on one of the Virtual Observatory servers in the VO list, DS9 will attempt to connect to that server and (if the internal Web display is enabled) display its Web page. The square box to the left of the server name turns yellow while the connection is being established and then green to signal success. +A direct connection is fast and flexible. Among other things, it allows you to perform analysis on your own local data (the VO server will retrieve the image from DS9) and also allows you to use an external browser to load images. +Some system managers configure their firewall explicitly to prevent computers in their care from making a direct connection to an external host. Instead, they only allow external access through a Web proxy +server (such as SOCKS). If you are using a computer behind a restricted firewall of this sort, then DS9 will not be able to connect directly to a VO server. The yellow box will not turn green and eventually DS9 will display an error message. +In this case, you can choose to have DS9 communicate with the VO servers through your Web proxy server. DS9 will use your proxy to send its commands and retrieve its data and analysis results, rather than doing this directly. Note that the following restrictions apply: The transfer of data is slower. You must use the internal Web browser for loading images, etc. You cannot perform analysis on local data. -There is a (large but finite) restriction on the number of annuli, -and number of polygon points you can specify in a region, as well -as the total number of regions allowed. -If your computer and firewall have been configured to require -use of a Web proxy server, you will have to tell DS9 about this -server. Click the Configure Web Proxy button and type the -relevant information into the boxes. (Your systems administrator -will be able to tell you the details.) At this point, you should be -able to connect to a VO server successfully. Please let us know if -you have problems! +There is a (large but finite) restriction on the number of annuli, and number of polygon points you can specify in a region, as well as the total number of regions allowed. +If your computer and firewall have been configured to require use of a Web proxy server, you will have to tell DS9 about this server. Click the Configure Web Proxy button and type the relevant information into the boxes. (Your systems administrator will be able to tell you the details.) At this point, you should be able to connect to a VO server successfully. Please let us know if you have problems! -A final note: you may, of course, choose to use the Web proxy -even if your computer and firewall are configured to allow direct -connections. In this case, there is no need to configure the proxy -server. +A final note: you may, of course, choose to use the Web proxy even if your computer and firewall are configured to allow direct connections. In this case, there is no need to configure the proxy server.
-- cgit v0.12

Key Stroke
Right Arrow l Will move selected regions to the right one -pixel.
+ Will move selected regions to the right one pixel.
In Pointer mode, will move the cursor to the right one pixel.
-In Crosshair mode, will move the crosshair to the right one -pixel.
+In Crosshair mode, will move the crosshair to the right one pixel.
In Pan mode, will pan the image to the right one pixel.

Will move selected regions to the left one pixel.
In Pointer mode, will move the cursor to the left one pixel.
-In Crosshair mode, will move the crosshair to the left one -pixel.
+In Crosshair mode, will move the crosshair to the left one pixel.
In Pan mode, will pan the image to the left one pixel.

Shift-Drag In Pointer mode, will select all regions within the indicated -region.
-In Crop mode, for 3D frame, will move front crop plane -forward.
Shift-Drag In Pointer mode, will select all regions within the indicated region.
+In Crop mode, for 3D frame, will move front crop plane forward.

Control-Drag In Poiner mode, on selected ANNULUS Regions, will -create new radii.
-In Crop mode, for 3D frame, will move back crop plane -backward.
In Poiner mode, on selected ANNULUS Regions, will create new radii.
+In Crop mode, for 3D frame, will move back crop plane backward.

Command-`

Key Stroke
`Right` `Arrow l`	Will move selected regions to the right one -pixel. +	Will move selected regions to the right one pixel. In Pointer mode, will move the cursor to the right one pixel. -In Crosshair mode, will move the crosshair to the right one -pixel. +In Crosshair mode, will move the crosshair to the right one pixel. In Pan mode, will pan the image to the right one pixel.
Will move selected regions to the left one pixel. In Pointer mode, will move the cursor to the left one pixel. -In Crosshair mode, will move the crosshair to the left one -pixel. +In Crosshair mode, will move the crosshair to the left one pixel. In Pan mode, will pan the image to the left one pixel.
`Shift`-`Drag`	In Pointer mode, will select all regions within the indicated -region. -In Crop mode, for 3D frame, will move front crop plane -forward.	`Shift`-`Drag`	In Pointer mode, will select all regions within the indicated region. +In Crop mode, for 3D frame, will move front crop plane forward.
`Control-Drag`	In Poiner mode, on selected `ANNULUS` Regions, will -create new radii. -In Crop mode, for 3D frame, will move back crop plane -backward.	In Poiner mode, on selected `ANNULUS` Regions, will create new radii. +In Crop mode, for 3D frame, will move back crop plane backward.
Command-`

`IRAF`	`contains the DETSEC and DETSIZE keywords. -See NOAO -IRAF Mosaic Data Structures`
`WCS`	`each FITS image contains a valid -WCS.`	`each FITS image contains a valid WCS.`
`HST WFPC2`	`valid HST WFPC2 data cube, -consisting of 4 planes, along with a fits ascii table containing -wcs information.`	`valid HST WFPC2 data cube, consisting of 4 planes, along with a fits ascii table containing wcs information.`

How It -Works	Backup and -Restore	File -Formats	How It Works	Backup and Restore	File Formats
Mouse -and Keyboard	Coordinate -Grids	Preferences	Mouse and Keyboard	Coordinate Grids	Preferences
Command -Line Options	Catalogs	3-D -Frames	Command Line Options	Catalogs	3-D Frames
XPA Access -Points	Colorbar	Contours	XPA Access Points	Colorbar	Contours
SAMP	Printing	IRAF -Support	SAMP	Printing	IRAF Support
Regions	Analysis	Binning	Regions	Analysis	Binning

@@ -30,57 +24,38 @@ buttons.
Button 1	Depends on current MODE, which may be selected by the EDIT menu -option. +	Depends on current MODE, which may be selected by the EDIT menu option. In Region mode, create/edit/delete regions. In Crosshair mode, will move current crosshair. In Colorbar mode, will change contrast and bias of colormap. In Pan mode, will move or pan to clicked location. In Zoom mode, will zoom about clicked location. In Rotate mode, will rotate image about center. -In Crop mode, will select 2-D crop region. For 3-D -Shift-click will edit front clip plane, Control-click -will edit back clip plane. +In Crop mode, will select 2-D crop region. For 3-D Shift-click will edit front clip plane, Control-click will edit back clip plane. In Catalog mode, will select catalog regions. In examine mode, will follow IRAF examine protocol.
Button 2	Pan mode: will move or pan to clicked location. Behavior -depends on the PAN preference settings.	Pan mode: will move or pan to clicked location. Behavior depends on the PAN preference settings.
Button 3	Colorbar mode: will change the contrast and bias of the -colormap.	Colorbar mode: will change the contrast and bias of the colormap.