funds9(7)

💖 funds9(7) — FunDS9, aka the Funtools × DS9 collab we've all been waiting for 💖

SAORD Documentation · bestie edition · no cap 🌸

---

✨ NAME ✨

FunDS9 — Funtools and DS9 Image Display 🦋

---

✨ SYNOPSIS ✨

okay so this page is literally just here to explain how funtools can be integrated into the ds9 Analysis menu. that's it. that's the whole vibe. 💅

---

✨ DESCRIPTION ✨

SAOImage/DS9 is an astronomical imaging and data visualization application that astronomers all over the planet use — like, worldwide, fr fr 🌍✨. DS9 can display standard astronomical FITS images and binary tables, but it ALSO eats raw array files, shared memory files, and data files it auto-retrieves via FTP and HTTP. no big deal.

Standard functional capabilities, the basics it serves every day:

• multiple frame buffers 🖼️
• colormap and region manipulation 🎨
• many data scaling algorithms 📈

And DS9's advanced features? obsessed:

• TrueColor visuals 🌈
• deep frame buffers 🕳️
• true PostScript printing 🖨️
• display of image mosaics 🧩

The program's support of image tiling, "blinking", arbitrary zoom, rotation, and pan is unparalleled in astronomy. periodt. 👑

It also has innovative support for automatic retrieval and display of standard image data such as the Digital Sky Survey (using servers at SAO, StScI, or ESO). iconic behavior honestly.

DS9 can communicate with external programs such as Funtools using the XPA messaging system. 💬 And on top of that, programs can be integrated directly into the DS9 GUI by means of a configurable Analysis menu. By default, the DS9 Analysis menu contains algorithms deemed essential to the core functions of DS9, e.g., display cross-cuts of data, iso-intensity contours, and WCS grids. But — and this is the fun part — new programs can be added to DS9 by creating a set-up file which can be loaded into DS9 to reconfigure the Analysis menu. main character energy for your own custom tools 💅

The basic format of the analysis set-up file is:

#
# Analysis command descriptions:
#   menu label/description
#   file templates for this command
#   "menu" (add to menu) ⎪"bind" (bind to key)
#   analysis command line

For example, the funcnts program can be specified in this way:

Funcnts (counts in source/bkgd regions; options: none)
*
menu
funcnts $filename $regions(source,,) $regions(background,,) ⎪ $text

As shown above, DS9 supports a macro facility to provide information as well as task support to command lines. For example, the $regions macro is expanded by DS9 to provide the current source and/or background region to the analysis command. The $text macro is expanded to generate a text window display. It also is possible to query for parameters using a $param macro, plot data using a $plot macro, etc. See the DS9 documentation for further details. iykyk 🫶

A set-up file called funtools.ds9 will load some useful Funtools applications into the DS9 Analysis menu (version 2.1 and above) — and here's the lineup bestie:

• counts in regions
• radial profile
• X-ray light curve and energy spectrum
• 1D histogram

The file resides in the bin directory where Funtools programs are installed. It can be manually loaded into DS9 from the Load Analysis Commands ... option of the Analysis menu. Alternatively, you can tell DS9 to load this file automatically at start-up time by adding the pathname to the Edit->Preferences->Analysis Menu->Analysis File menu option.

NB: make sure you select Edit->Preferences->Save Preferences after setting the pathname. don't skip this step bestie, or your settings are giving... nothing 😭

---

🌸 a lil note on the tasks 🌸

The tasks in this setup file generally process the original disk-based FITS file. Funcnts-based results (radial profile, counts in regions) are presented in WCS units, if present in the FITS header. ✨

For situations where a disk file is not available (e.g., image data generated and sent to DS9's 'fits' XPA access point), versions of the radial profile and counts in regions tasks also are offered utilizing DS9's internal image data. Results are presented in pixels. Aside from the units, the results should be identical to the file-based results. no cap, same results, different drip 💅

---

✨ SEE ALSO ✨

See funtools(7) for a list of Funtools help pages 📚

---

okay that's the whole page bestie, you ate 💖 this was version 1.4.5, dated April 14, 2011 — yes she's a vintage queen and she still slays 👑✨ mwah, go run some analysis tasks, love u 🫶🌸