"Fossies" - the Fresh Open Source Software Archive

Member "SAOImageDS9/funtools/doc/funtools.ds9" (13 Nov 2019, 3220 Bytes) of package /linux/misc/ds9.8.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 #
    2 # Analysis command descriptions:
    3 #   menu label/description
    4 #   file templates for this command (* for all files)
    5 #   "menu" (add to menu) |"bind" (bind to key)
    6 #   analysis command line
    7 #
    8 
    9 hmenu Funtools
   10 
   11 # 1D histogram params for a table
   12 param thist
   13 column entry    "Enter column name to histogram" pi "(histo)"
   14 bins   entry    "Enter [min:max:]bins" 0 "('0' for default number of bins)"
   15 norm   checkbox "Normalize by binsize?"                          0
   16 end
   17 
   18 # 1D histogram params for an image
   19 param ihist
   20 bins entry "Enter [min:max:]bins" 0 "('0' for default number of bins)"
   21 end
   22 
   23 # Light Curve params
   24 param ltc
   25 bins   entry    "Enter [min:max:]bins" 0 "('0' for default number of bins)"
   26 norm   checkbox "Normalize by time?"                          0
   27 end
   28 
   29 Funtools Overview
   30 *
   31 menu
   32 echo "Funtools Tasks in DS9\r\rThe tasks in this section of the Analysis menu utilize the Funtools programs\r'funcnts' and 'funhist'. With the exceptions noted below, they all work off the \roriginal disk-based FITS file. The funcnts-based tasks (radial profile, counts\rin regions) present their results using WCS units, if the appropriate info is\rpresent in the FITS header. \r\rFor situations where a disk file is not available (e.g., image data generated\rby a program and sent to DS9's 'fits' XPA access point), alternate versions of\rthe radial profile and counts in regions tasks are offered that work from DS9's\rinternal image data. In these two cases, results are presented in pixels. Aside\rfrom the units, the results should be identical to the file-based results.\r\rFor more sophisticated analysis, please consider using the underlying Funtools\rtasks directly. These are documented at:\r\r        http://hea-www.harvard.edu/RD/funtools/programs.html\r\r" | $text
   33 
   34 Radial Profile Plot (annulus regions; options: none)
   35 *
   36 menu
   37 funds9 funcnts_plot "$xpa" "$filename" "$regions(source,,)" "$regions(background,,)" | $plot(stdin)
   38 
   39 Histogram Plot (any column; options: column name, number of bins)
   40 *
   41 menu
   42 $param(thist); funds9 funhist_plot "$xpa" "$filename[$regions]" "$norm" "$column" "$bins" | $plot(stdin)
   43 
   44 Light Curve Plot ("time" column; options: number of bins)
   45 *
   46 menu
   47 $param(ltc); funds9 funhist_plot "$xpa" "$filename[$regions]" "$norm" time "$bins" | $plot(stdin)
   48 
   49 Energy Spectrum Plot ("pi" column; options: none)
   50 *
   51 menu
   52 funds9 funhist_plot "$xpa" "$filename[$regions]" "0" "pi" "$bins" | $plot(stdin)
   53 
   54 Counts in Regions (any regions; options: none)
   55 *
   56 menu
   57 funds9 funcnts "$xpa" "$filename" "$regions(source,,)" "$regions(background,,)" | $text
   58 
   59 Column Histogram (any column; options: colname, <min:max:>bins)
   60 *
   61 menu
   62 $param(thist); funds9 funhist "$xpa"  "$filename[$regions]" "$norm" "$column" "$bins" | $text
   63 
   64 Image Histogram (options: <min:max:>bins)
   65 *
   66 menu
   67 $param(ihist); $data | funhist "stdin[$regions]" xy "$bins" | $text
   68 
   69 ---
   70 
   71 Radial Profile Plot in Pixels using DS9's Internal Image Data (annulus regions)
   72 *
   73 menu
   74 $data | funcnts -rpG stdin $regions(source,,) $regions(background,,) |  funcnts.plot -file "$filename" ds9 | $plot(stdin)
   75 
   76 Counts in Regions in Pixels using DS9's Internal Image Data (any regions)
   77 *
   78 menu
   79 $data | funcnts -rp stdin $regions(source,,) $regions(background,,) | $text
   80 
   81 ---
   82 
   83 end