funtools(7)

funtools(7) 🦋

okay bestie, this is the funtools(7) page from SAORD Documentation. It's the Table of Contents for Funtools, and we're gonna make it slay while keeping every fact, no cap. 💖

✨ NAME ✨

Funtools — FITS Users Need Tools. That's the name, that's the vibe. 🎀

🦋 SYNOPSIS 🦋

This document is the Table of Contents for Funtools. Literally just the TOC. Periodt. ✨

💅 DESCRIPTION 💅

okay so Funtools is a "minimal buy-in" FITS library and utility package developed at the High Energy Astrophysics Division of SAO. The Funtools library gives you simplified access to a whole array of file types: standard astronomical FITS images and binary tables, raw arrays and binary event lists, and even tables of ASCII column data. There's also a sophisticated region filtering library (compatible with ds9) that filters images and tables using boolean operations between geometric shapes, supports world coordinates, etc. And Funtools supports advanced capabilities like 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". They tried to achieve this goal by emphasizing two essential capabilities. First: 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. Second: support for using 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. 🫶

Choose from the following topics:

• Funtools User Programs — the command-line besties you run to do stuff.
  • funcalc — the Funtools calculator, but specifically for binary tables. [funcalc(1)]
  • funcen — finds the centroid, for binary tables. [funcen(1)]
  • funcnts — counts photons in the regions you specify. [funcnts(1)]
  • funcone — does a cone search on RA, Dec columns. [funcone(1)]
  • fundisp — displays data in a Funtools data file. [fundisp(1)]
  • funhead — displays a header in a Funtools file. [funhead(1)]
  • funhist — creates a 1D histogram of a column. [funhist(1)]
  • funimage — creates a FITS image from a Funtools data file. [funimage(1)]
  • funindex — creates an index on a column in a binary table. [funindex(1)]
  • funjoin — joins two or more FITS binary tables on specified columns. [funjoin(1)]
  • funmerge — merges one or more Funtools table files. [funmerge(1)]
  • funsky — converts between image and sky coordinates, using WCS info from a FITS header. [funsky(1)]
  • funtable — copies selected rows from a Funtools file to a FITS binary table. [funtable(1)]
  • funtbl — extracts a table from Funtools ASCII output. [funtbl(1)]
  • funtools and ds9 image display [funds9(7)]
• Funtools Programming — the dev side, where you write code and feel like a main character.
  • Funtools Programming Summary [funlib(3)]
  • Funtools Programming Tutorial [funlib(3)]
  • A Short Digression on Subroutine Order [funlib(3)]
  • Compiling and Linking [funlib(3)]
  • The Funtools Reference Handle [funlib(3)]
  • The Funtools Programming Reference Manual
    • FunOpen — opens a Funtools file. [funopen(3)]
    • FunImageGet — retrieves image data. [funimageget(3)]
    • FunImagePut — outputs image data. [funimageput(3)]
    • FunImageRowGet — retrieves image data by row. [funimagerowget(3)]
    • FunImageRowPut — outputs image data by row. [funimagerowput(3)]
    • FunTableRowGet — retrieves rows from a table. [funtablerowget(3)]
    • FunTableRowPut — outputs rows to a table. [funtablerowput(3)]
    • FunColumnSelect — selects columns in a table for access. [funcolumnselect(3)]
    • FunColumnActivate — activates columns in a table for read/write. [funcolumnactivate(3)]
    • FunColumnLookup — looks up info about the columns in a table. [funcolumnlookup(3)]
    • FunInfoGet — gets info about an image or table. [funinfoget(3)]
    • FunInfoPut — puts info about an image or table. [funinfoput(3)]
    • FunParamGet — gets a header param. [funparamget(3)]
    • FunParamPut — puts a header param. [funparamput(3)]
    • FunFlush — flushes I/O in a Funtools file. [funflush(3)]
    • FunClose — closes a Funtools file. [funclose(3)]
  • Funtools Programming Examples [funlib(3)]
    • evmerge — merges new columns with existing columns.
    • evcols — adds column and rows to binary tables.
    • imblank — blanks out image values below a threshold.
• Funtools Data Files [funfiles(7)]
  • Supported Data Formats
    • FITS File and Extensions
    • Non-FITS Raw Event Files
    • Non-FITS Array Files
    • Column-based Text (ASCII) Files
    • Database Views of Tables
  • Image Sections and Blocking
  • Binning FITS Binary Tables and Non-FITS Event Files
  • Disk Files and Other Supported File Types
• Funtools Data Filtering
  • Table Filtering [funfilters(7)]
  • Fast Table Filtering using Indexes [funidx(7)]
  • Spatial Region Filtering [funregions(7)]
    • Region Geometry [reggeometry(7)]
    • Region Algebra [regalgebra(7)]
    • Region Coordinates [regcoords(7)]
    • Region Boundaries [regbounds(7)]
    • Differences Between Funtools and IRAF Regions [regdiff(7)]
  • Combining Table and Region Filters [funcombine(7)]
• Miscellaneous
  • Funtools Environment Variables [funenv(7)]
  • Funtools ChangeLog

okay bestie, that's the whole funtools(7) page! It came from SAORD Documentation, version 1.4.5, dated April 14, 2011. Stay slay, keep coding, and remember: FITS Users Need Tools. 💖✨🦋