1funtools(n) SAORD Documentation funtools(n)
2
6 Funtools: FITS Users Need Tools
7
9 This document is the Table of Contents for Funtools.
10
12 Funtools, is a "minimal buy-in" FITS library and utility package devel‐
13 oped at the the High Energy Astrophysics Division of SAO. The Funtools
14 library provides simplified access to a wide array of file types: stan‐
15 dard astronomical FITS images and binary tables, raw arrays and binary
16 event lists, and even tables of ASCII column data. A sophisticated
17 region filtering library (compatible with ds9) filters images and
18 tables using boolean operations between geometric shapes, support world
19 coordinates, etc. Funtools also supports advanced capabilities such as
20 optimized data searching using index files.
21 The main goal of the Funtools project has been to develop a minimal
23 buy-in FITS library for researchers who are occasional (but serious)
24 coders. In this case, "minimal buy-in" means "easy to learn, easy to
25 use, and easy to re-learn next month". We have tried to achieve this
26 goal by emphasizing two essential capabilities. The first is the abil‐
27 ity to develop FITS programs without knowing much about FITS, i.e.,
28 without having to deal with the arcane rules for generating a properly
29 formatted FITS file. The second is to support the use of already-
30 familiar C/Unix facilities, especially C structs and Unix stdio. Taken
31 together, these two capabilities should allow researchers to leverage
32 their existing programming expertise while minimizing the need to learn
33 new and complex coding rules.
34 Choose from the following topics:
36 · Funtools User Programs
38 · funcalc: Funtools calculator (for binary tables) [funcalc(1)]
40 · funcen: find centroid (for binary tables) [funcen(1)]
42 · funcnts: count photons in specified regions [funcnts(1)]
44 · funcone: cone search on RA, Dec columns [funcone(1)]
46 · fundisp: display data in a Funtools data file [fundisp(1)]
48 · funhead: display a header in a Funtools file [funhead(1)]
50 · funhist: create a 1D histogram of a column [funhist(1)]
52 · funimage: create a FITS image from a Funtools data file [funim‐
54 age(1)]
55 · funindex: create an index on a column in a binary table [funin‐
57 dex(1)]
58 · funjoin: join two or more FITS binary tables on specified col‐
60 umns [funjoin(1)]
61 · funmerge: merge one or more Funtools table files [funmerge(1)]
63 · funsky: convert between image and sky coordinates, using WCS
65 info from a FITS header [funsky(1)]
66 · funtable: copy selected rows from a Funtools file to a FITS
68 binary table [funtable(1)]
69 · funtbl: extract a table from Funtools ASCII output [funtbl(1)]
71 · funtools and ds9 image display [funds9(n)]
73 · Funtools Programming
75 · Funtools Programming Summary [funlib(3)]
77 · Funtools Programming Tutorial [funlib(3)]
79 · A Short Digression on Subroutine Order [funlib(3)]
81 · Compiling and Linking [funlib(3)]
83 · The Funtools Reference Handle [funlib(3)]
85 · The Funtools Programming Reference Manual
87 · FunOpen: open a Funtools file [funopen(3)]
89 · FunImageGet: retrieve image data [funimageget(3)]
91 · FunImagePut: output image data [funimageput(3)]
93 · FunImageRowGet: retrieve image data by row [funim‐
95 agerowget(3)]
96 · FunImageRowPut: output image data by row [funimagerow‐
98 put(3)]
99 · FunTableRowGet: retrieve rows from a table [funt‐
101 ablerowget(3)]
102 · FunTableRowPut: output rows to a table [funtablerowput(3)]
104 · FunColumnSelect: select columns in a table for access [fun‐
106 columnselect(3)]
107 · FunColumnActivate: activate columns in a table for
109 read/write [funcolumnactivate(3)]
110 · FunColumnLookup: lookup info about the columns in a table
112 [funcolumnlookup(3)]
113 · FunInfoGet: get info about an image or table [funinfo‐
115 get(3)]
116 · FunInfoPut: put info about an image or table [funin‐
118 foput(3)]
119 · FunParamGet: get header param [funparamget(3)]
121 · FunParamPut: put header param [funparamput(3)]
123 · FunFlush: flush I/O in a Funtools file [funflush(3)]
125 · FunClose: close a Funtools file [funclose(3)]
127 · Funtools Programming Examples [funlib(3)]
129 · evmerge: merge new columns with existing columns
131 · evcols: add column and rows to binary tables
133 · imblank: blank out image values below a threshold
135 · Funtools Data Files [funfiles(n)]
137 · Supported Data Formats
139 · FITS File and Extensions
141 · Non-FITS Raw Event Files
143 · Non-FITS Array Files
145 · Column-based Text (ASCII) Files
147 · Database Views of Tables
149 · Image Sections and Blocking
151 · Binning FITS Binary Tables and Non-FITS Event Files
153 · Disk Files and Other Supported File Types
155 · Funtools Data Filtering
157 · Table Filtering [funfilters(n)]
159 · Fast Table Filtering using Indexes [funidx(n)]
161 · Spatial Region Filtering [funregions(n)]
163 · Region Geometry [reggeometry(n)]
165 · Region Algebra [regalgebra(n)]
167 · Region Coordinates [regcoords(n)]
169 · Region Boundaries [regbounds(n)]
171 · Differences Between Funtools and IRAF Regions [regdiff(n)]
173 · Combining Table and Region Filters [funcombine(n)]
175 · Miscellaneous
177 · Funtools Environment Variables [funenv(n)]
179 · Funtools ChangeLog
181version 1.4.2 January 2, 2008 funtools(n)