Merge commit '23c7930d27fe11c4655e1291a07a821dbbaba78d' as 'funtools'

author: William Joye <wjoye@cfa.harvard.edu> 2016-10-27 17:38:41 (GMT)
committer: William Joye <wjoye@cfa.harvard.edu> 2016-10-27 17:38:41 (GMT)
commit: 5b44fb0d6530c4ff66a446afb69933aa8ffd014f (patch)
tree: e059f66d1f612e21fe9d83f9620c8715530353ec /funtools/doc/help.html
parent: da2e3d212171bbe64c1af39114fd067308656990 (diff)
parent: 23c7930d27fe11c4655e1291a07a821dbbaba78d (diff)
download: blt-5b44fb0d6530c4ff66a446afb69933aa8ffd014f.zip
blt-5b44fb0d6530c4ff66a446afb69933aa8ffd014f.tar.gz
blt-5b44fb0d6530c4ff66a446afb69933aa8ffd014f.tar.bz2
1 files changed, 192 insertions, 0 deletions
diff --git a/funtools/doc/help.html b/funtools/doc/help.html
new file mode 100644
index 0000000..e32f9bf
--- /dev/null
+++ b/funtools/doc/help.html
@@ -0,0 +1,192 @@
+<!-- =defdoc funtools funtools n -->
+<HTML>
+<HEAD>
+<TITLE>The Funtools Help Facility</TITLE>
+</HEAD>
+<BODY>
+
+<!-- =section funtools NAME -->
+<H2><A NAME="funtools">Funtools: FITS Users Need Tools</A></H2>
+
+<!-- =section funtools SYNOPSIS -->
+<H2>Summary</H2>
+This document is the Table of Contents for Funtools.
+
+<!-- =section funtools DESCRIPTION -->
+<H2>Description</H2>
+Funtools, is a "minimal buy-in" FITS library and utility package developed
+at the the High Energy Astrophysics Division of SAO.  The Funtools
+library provides simplified access to a wide array of file types:
+standard astronomical FITS images and binary tables, raw arrays and
+binary event lists, and even tables of ASCII column data.  A
+sophisticated region filtering library (compatible with ds9) filters
+images and tables using boolean operations between geometric shapes,
+support world coordinates, etc.  Funtools also supports advanced
+capabilities such as optimized data searching using index files.
+
+The main goal of the Funtools project has been to develop a minimal buy-in
+FITS library for researchers who are occasional (but serious) coders.  In
+this case, "minimal buy-in" means "easy to learn, easy to use, and easy to
+re-learn next month". We have tried to achieve this goal by emphasizing two
+essential capabilities.  The first is the ability to develop FITS programs
+without knowing much about FITS, i.e., without having to deal with the
+arcane rules for generating a properly formatted FITS file.  The second is
+to support the use of already-familiar C/Unix facilities, especially C
+structs and Unix stdio. Taken together, these two capabilities should allow
+researchers to leverage their existing programming expertise while
+minimizing the need to learn new and complex coding rules.
+
+<!-- =section funtools DESCRIPTION -->
+<P>
+Choose from the following topics:
+
+<P>
+<UL>
+<LI><A HREF="./programs.html">Funtools User Programs</A>
+<UL>
+<LI><A HREF="./programs.html#funcalc">funcalc: Funtools calculator (for binary tables)</A>
+<!-- =text [funcalc(1)] -->
+<LI><A HREF="./programs.html#funcen">funcen: find centroid (for binary tables)</A>
+<!-- =text [funcen(1)] -->
+<LI><A HREF="./programs.html#funcnts">funcnts: count photons in specified regions</A>
+<!-- =text [funcnts(1)] -->
+<LI><A HREF="./programs.html#funcone">funcone: cone search on RA, Dec columns</A>
+<!-- =text [funcone(1)] -->
+<LI><A HREF="./programs.html#fundisp">fundisp: display data in a Funtools data file</A>
+<!-- =text [fundisp(1)] -->
+<LI><A HREF="./programs.html#funhead">funhead: display a header in a Funtools file</A>
+<!-- =text [funhead(1)] -->
+<LI><A HREF="./programs.html#funhist">funhist: create a 1D histogram of a column</A>
+<!-- =text [funhist(1)] -->
+<LI><A HREF="./programs.html#funimage">funimage: create a FITS image from a Funtools data file</A>
+<!-- =text [funimage(1)] -->
+<LI><A HREF="./programs.html#funindex">funindex: create an index on a column in a binary table</A>
+<!-- =text [funindex(1)] -->
+<LI><A HREF="./programs.html#funjoin">funjoin: join two or more FITS binary tables on specified columns</A>
+<!-- =text [funjoin(1)] -->
+<LI><A HREF="./programs.html#funmerge">funmerge: merge one or more Funtools table files</A>
+<!-- =text [funmerge(1)] -->
+<LI><A HREF="./programs.html#funsky">funsky: convert between image and sky coordinates, using WCS info from a FITS header</A>
+<!-- =text [funsky(1)] -->
+<LI><A HREF="./programs.html#funtable">funtable: copy selected rows from a Funtools file to a FITS binary table</A>
+<!-- =text [funtable(1)] -->
+<LI><A HREF="./programs.html#funtbl">funtbl: extract a table from
+Funtools ASCII output</A>
+<!-- =text [funtbl(1)] -->
+<LI><A HREF="./ds9.html">funtools and ds9 image display</A>
+<!-- =text [funds9(n)] -->
+</UL>
+
+<LI><A HREF="./library.html">Funtools Programming</A>
+<UL>
+<LI><A HREF="./library.html#summary">Funtools Programming Summary</A>
+<!-- =text [funlib(3)] -->
+<LI><A HREF="./library.html#tutorial">Funtools Programming Tutorial</A>
+<!-- =text [funlib(3)] -->
+<LI><A HREF="./library.html#order">A Short Digression on Subroutine Order</A>
+<!-- =text [funlib(3)] -->
+<LI><A HREF="./library.html#compiling">Compiling and Linking</A>
+<!-- =text [funlib(3)] -->
+<LI><A HREF="./library.html#refhandle">The Funtools Reference Handle</A>
+<!-- =text [funlib(3)] -->
+<LI><A HREF="./library.html#reference">The Funtools Programming Reference Manual</A>
+<UL>
+<LI> <A HREF="./library.html#funopen">FunOpen: open a Funtools file</A>
+<!-- =text [funopen(3)] -->
+<LI><A HREF="./library.html#funimageget">FunImageGet: retrieve image data</A>
+<!-- =text [funimageget(3)] -->
+<LI><A HREF="./library.html#funimageput">FunImagePut: output image data</A>
+<!-- =text [funimageput(3)] -->
+<LI><A HREF="./library.html#funimagerowget">FunImageRowGet: retrieve image data by row</A>
+<!-- =text [funimagerowget(3)] -->
+<LI><A HREF="./library.html#funimagerowput">FunImageRowPut: output image data by row</A>
+<!-- =text [funimagerowput(3)] -->
+<LI><A HREF="./library.html#funtablerowget">FunTableRowGet: retrieve rows from a table</A>
+<!-- =text [funtablerowget(3)] -->
+<LI><A HREF="./library.html#funtablerowput">FunTableRowPut: output rows to a table</A>
+<!-- =text [funtablerowput(3)] -->
+<LI><A HREF="./library.html#funcolumnselect">FunColumnSelect: select columns in a table for access</A>
+<!-- =text [funcolumnselect(3)] -->
+<LI><A HREF="./library.html#funcolumnactivate">FunColumnActivate: activate columns in a table for read/write</A>
+<!-- =text [funcolumnactivate(3)] -->
+<LI><A HREF="./library.html#funcolumnlookup">FunColumnLookup: lookup info about  the columns in a table</A>
+<!-- =text [funcolumnlookup(3)] -->
+<LI><A HREF="./library.html#funinfoget">FunInfoGet: get info about an image or table</A>
+<!-- =text [funinfoget(3)] -->
+<LI><A HREF="./library.html#funinfoput">FunInfoPut: put info about an image or table</A>
+<!-- =text [funinfoput(3)] -->
+<LI><A HREF="./library.html#funparamget">FunParamGet: get header param</A>
+<!-- =text [funparamget(3)] -->
+<LI><A HREF="./library.html#funparamput">FunParamPut: put header param</A>
+<!-- =text [funparamput(3)] -->
+<LI><A HREF="./library.html#funflush">FunFlush: flush I/O in a Funtools file</A>
+<!-- =text [funflush(3)] -->
+<LI><A HREF="./library.html#funclose">FunClose: close a Funtools file</A>
+<!-- =text [funclose(3)] -->
+</UL>
+
+<LI><A HREF="./library.html#examples">Funtools Programming Examples</A>
+<!-- =text [funlib(3)] -->
+<UL> 
+<LI><A HREF="./evmerge.c">evmerge: merge new columns with existing columns</A>
+<LI><A HREF="./evcol.c">evcols: add column and rows to binary tables</A>
+<LI><A HREF="./imblank.c">imblank: blank out image values below a threshold</A>
+</UL>
+</UL>
+
+<LI><A HREF="./files.html">Funtools Data Files</A>
+<!-- =text [funfiles(n)] -->
+<UL> 
+<LI><A HREF="./files.html#formats">Supported Data Formats</A>
+<UL>
+<LI><A HREF="./files.html#fits">FITS File and Extensions</A>
+<LI><A HREF="./files.html#events">Non-FITS Raw Event Files</A>
+<LI><A HREF="./files.html#arrays">Non-FITS Array Files</A>
+<LI><A HREF="./text.html">Column-based Text (ASCII) Files</A>
+<LI><A HREF="./view.html">Database Views of Tables</A>
+</UL>
+<LI><A HREF="./files.html#sections">Image Sections and Blocking</A>
+<LI><A HREF="./files.html#binning">Binning FITS Binary Tables and Non-FITS Event Files</H2>
+<LI><A HREF="./files.html#types">Disk Files and Other Supported File Types</A>
+</UL>
+
+<LI>Funtools Data Filtering
+<UL>
+<LI><A HREF="./filters.html">Table Filtering</A>
+<!-- =text [funfilters(n)] -->
+<LI><A HREF="./idx.html">Fast Table Filtering using Indexes</A>
+<!-- =text [funidx(n)] -->
+<LI><A HREF="./regions.html">Spatial Region Filtering</A>
+<!-- =text [funregions(n)] -->
+<UL>
+<LI><A HREF="./reggeometry.html">Region Geometry</A>
+<!-- =text [reggeometry(n)] -->
+<LI><A HREF="./regalgebra.html">Region Algebra</A>
+<!-- =text [regalgebra(n)] -->
+<LI><A HREF="./regcoords.html">Region Coordinates</A>
+<!-- =text [regcoords(n)] -->
+<LI><A HREF="./regbounds.html">Region Boundaries</A>
+<!-- =text [regbounds(n)] -->
+<LI><A HREF="./regdiff.html">Differences Between Funtools and IRAF Regions</A>
+<!-- =text [regdiff(n)] -->
+</UL>
+<LI><A HREF="./combo.html">Combining Table and Region Filters</A>
+<!-- =text [funcombine(n)] -->
+</UL>
+
+<LI> Miscellaneous
+<UL>
+<LI><A HREF="./env.html">Funtools Environment Variables</A>
+<!-- =text [funenv(n)] -->
+<LI><A HREF="./changelog.html">Funtools ChangeLog</A>
+</UL>
+
+</UL> 
+
+<!-- =stop -->
+
+<H5>Last updated: January 6, 2006</H5>
+
+</BODY>
+</HTML>
+
author	William Joye <wjoye@cfa.harvard.edu>	2016-10-27 17:38:41 (GMT)
committer	William Joye <wjoye@cfa.harvard.edu>	2016-10-27 17:38:41 (GMT)
commit	5b44fb0d6530c4ff66a446afb69933aa8ffd014f (patch)
tree	e059f66d1f612e21fe9d83f9620c8715530353ec /funtools/doc/help.html
parent	da2e3d212171bbe64c1af39114fd067308656990 (diff)
parent	23c7930d27fe11c4655e1291a07a821dbbaba78d (diff)
download	blt-5b44fb0d6530c4ff66a446afb69933aa8ffd014f.zip blt-5b44fb0d6530c4ff66a446afb69933aa8ffd014f.tar.gz blt-5b44fb0d6530c4ff66a446afb69933aa8ffd014f.tar.bz2