next up previous FTOOLS Home
Next: Notices of FTOOLS Releases Up: Developer's Guide to FTOOLS Previous: Appendix

FTOOLS library

The FTOOLS distribution includes a library libftools.a found in the IRAF bin/ directory and in the host/ directory. This library contains several useful routines that are commonly employed by FTOOLS tasks. Here is a simple summary type list of these routines. Anyone interested in using these routines should study the comments in the source code of misc.for found in the ~ftools/ftools/library/ subdirectory.

  • fcpars - parses filename[extension] strings
  • fcecho - prints a string to the stdio device
  • fcerr - prints a string to the stderror device
  • fcerrm - prints FITSIO error number as an error message
  • fitsdstk - dumps the FITSIO error stack
  • fccmpl - compares two list of strings for a subset list
  • fcgcls - gets the list and number of columns names or filenames
  • fcstln - finds length of string, not counting trailing spaces
  • fcgrgs - gets number of row ranges and their limits
  • fcb2s - gets value from bintable and converts it to a string
  • fcclwd - get column width for column's name, unit and data
  • fcafml - find length of ASCII column's data field
  • fcbfml - find length of binary column's data field
  • fcasfm - determine the data type for ascii table formats
  • fccmpr - compares rows list with a list of allowable characters
  • gtoken - finds starting position and width of NFIELD tokens
  • fctofs - gets the time offset for the observation
  • fccmtd - converts a month to the number of days in the year
  • figtyp - get column number and data type from column name
  • figkwd - determine data type and value for header keyword name
  • figbit - get bit field column data one column at a time
  • figint - fills an integer array from column number
  • figlog - fills a logical array from column number
  • figdbl - fills a double array from column number
  • figstr - fills a string from a column number
  • fegtyp - get column no. and data type for array column name
  • fegint - fills an integer array from array column element values
  • feglog - fills an logical array from array column element values
  • fegdbl - fills an double array from array column element values
  • fegstr - fills an string array from array column element values
  • figpvt - gets HK parameter name, value and time from a row
  • fickpn - check that parameter name is valid
  • fimcol - moves values from each column a column at a time with no NULL checking
  • fnmcol - moves values from each column a column at a time, checking for NULLS
  • fidate - parse date in the form dd/mm/yy and return as integers
  • fiptim - parse time hh:mm:ss.ssss and return as integers
  • fprint - send a message either to a file or to the terminal
  • pgfout - send a message either to a file or to the terminal with more ? prompting
  • pgfini - initializes count variable of PGFOUT common block
  • frmblk - remove blanks from a string
  • datatopix - converts a value from data to pixel coordinates
  • pixtodata - converts a value from pixel to data coordinates
  • initrealarray - initialize a real array to 0 (for dynamic memory)
  • initdoublearray - initialize a double array to 0 (for dynamic memory)
  • initintarray - initialize an integer array to 0 (for dynamic memory)
  • gimgkey - gets the coordinate transformation keywords from file
  • fcopyr - copies a row from one fits file to another
  • xcopynoscale - moves the extra keywords not related to scale
  • xcopyscale - moves the extra keywords including scale keywords
  • copyhead - copies keywords from iunit to ounit under certain conditions
  • copyfirst - copy all FITS HDU prior to specified extension
  • copylast - copy all FITS HDU after the specified extension
  • colsubset - parse subset of array column from array specification
  • fdmpsl - check for scaled B, I, and J columns
  • int2mjd - convert integer times to MJD
  • int2sec - convert integer date (yr, day, mon, hr, etc) to seconds from midnight January 1 of a reference year
  • jnt2str - convert integer times to strings
  • leapsec - determine number of leap seconds between two input times
  • sec2int - determine yr,day, hr, etc based on the seconds from a reference
  • elemparse - parses multidimensional element specification
  • idxfmt - formats a vector of array indices into a string
  • colparse - parses input array specifications and row ranges with return status
  • rmsubset - returns the subset specification from the end of a column name
  • doloops - used to loop through a column array appropriately to the dimension
  • fgetdval - read one row of a column and returns a single value
  • fcgrgd - gets the number of real*8 ranges and their limits
  • fcgrgf - gets the number of real*4 ranges and their limits
  • convolve - convolve an arbitrary kernel with an image(array)
  • putimage - put the image into the extension with correct datatype
  • clobber - allow overwriting of a filename
  • xfvv - extract a tdim(1) length vector along the fastest varying index
  • kigint - get integer array from column nrow elements at a time
  • kiglog - get logical array from column nrow elements at a time
  • kigdbl - get double array from column nrow elements at a time
  • kegint - get integer array from column
  • keglog - get logical array from column
  • kegdbl - get double array from column


next up previous FTOOLS Home
Next: Notices of FTOOLS Releases Up: Developer's Guide to FTOOLS Previous: Appendix

Web Page Maintained by: Dr. Lawrence E. Brown elwin@redshift.gsfc.nasa.gov

FTOOLS HELP DESK

If FTOOLS has been useful in your research, please reference this site (http://heasarc.gsfc.nasa.gov/ftools) and use the ASCL reference for HEASoft [ascl:1408.004] or the ASCL reference for the original FTOOLs paper [ascl:9912.002]:

Blackburn, J. K. 1995, in ASP Conf. Ser., Vol. 77, Astronomical Data Analysis Software and Systems IV, ed. R. A. Shaw, H. E. Payne, and J. J. E. Hayes (San Francisco: ASP), 367.

Web page maintained by: Bryan K. Irby