1funds9(n) SAORD Documentation funds9(n)
2
6 FunDS9: Funtools and DS9 Image Display
7
9 Describes how funtools can be integrated into the ds9 Analysis menu.
10
12 SAOImage/DS9 is an astronomical imaging and data visualization applica‐
13 tion used by astronomers around the world. DS9 can display standard
14 astronomical FITS images and binary tables, but also has support for
15 displaying raw array files, shared memory files, and data files auto‐
16 matically retrieved via FTP and HTTP. Standard functional capabilities
17 include multiple frame buffers, colormap and region manipulation, and
18 many data scaling algorithms. DS9's advanced features include TrueColor
19 visuals, deep frame buffers, true PostScript printing, and display of
20 image mosaics. The program's support of image tiling, "blinking", arbi‐
21 trary zoom, rotation, and pan is unparalleled in astronomy. It also has
22 innovative support for automatic retrieval and display of standard
23 image data such as the Digital Sky Survey (using servers at SAO, StScI,
24 or ESO).
25 DS9 can communicate with external programs such as Funtools using the
27 XPA messaging system. In addition, programs can be integrated directly
28 into the DS9 GUI by means of a configurable Analysis menu. By default,
29 the DS9 Analysis menu contains algorithms deemed essential to the core
30 functions of DS9, e.g., display cross-cuts of data, iso-intensity con‐
31 tours, and WCS grids. However, new programs can be added to DS9 by cre‐
32 ating a set-up file which can be loaded into DS9 to reconfigure the
33 Analysis menu.
34 The basic format of the analysis set-up file is:
36 #
38 # Analysis command descriptions:
39 # menu label/description
40 # file templates for this command
41 # "menu" (add to menu) ⎪"bind" (bind to key)
42 # analysis command line
43 For example, the funcnts program can be specified in this way:
45 Funcnts (counts in source/bkgd regions; options: none)
47 *
48 menu
49 funcnts $filename $regions(source,,) $regions(background,,) ⎪ $text
50 As shown above, DS9 supports a macro facility to provide information as
52 well as task support to command lines. For example, the $regions macro
53 is expanded by DS9 to provide the current source and/or background
54 region to the analysis command. The $text macro is expanded to generate
55 a text window display. It also is possible to query for parameters
56 using a $param macro, plot data using a $plot macro, etc. See the DS9
57 documentation for further details.
58 A set-up file called funtools.ds9 will load some useful Funtools appli‐
60 cations (counts in regions, radial profile, X-ray light curve and
61 energy spectrum, 1D histogram) into the DS9 Analysis menu (version 2.1
62 and above). The file resides in the bin directory where Funtools pro‐
63 grams are installed. It can be manually loaded into DS9 from the Load
64 Analysis Commands ... option of the Analysis menu. Alternatively, you
65 can tell DS9 to load this file automatically at start-up time by adding
66 the pathname to the Edit->Preferences->Analysis Menu->Analysis File
67 menu option. (NB: make sure you select Edit->Preferences->Save Prefer‐
68 ences after setting the pathname.)
69 The tasks in this setup file generally process the original disk-based
71 FITS file. Funcnts-based results (radial profile, counts in regions)
72 are presented in WCS units, if present in the FITS header. For situa‐
73 tions where a disk file is not available (e.g., image data generated
74 and sent to DS9's 'fits' XPA access point), versions of the radial pro‐
75 file and counts in regions tasks also are also offered utilizing DS9's
76 internal image data. Results are presented in pixels. Aside from the
77 units, the results should be identical to the file-based results.
78
80 See funtools(n) for a list of Funtools help pages
81version 1.4.0 August 15, 2007 funds9(n)