[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

Sand 1, D-72076 Tübingen, Germany
[Uni logo]


FXBFIND Source code in fxbfind.pro

FXBFIND

Name
       FXBFIND
Purpose
       Find column keywords in a FITS binary table header.
Explanation
       Finds the value of a column keyword for all the columns in the binary
       table for which it is set.  For example,
               FXBFIND, UNIT, 'TTYPE', COLUMNS, VALUES, N_FOUND
       Would find all instances of the keywords TTYPE1, TTYPE2, etc.  The
       array COLUMNS would contain the column numbers for which a TTYPEn
       keyword was found, and VALUES would contain the values.  N_FOUND would
       contain the total number of instances found.
Calling Sequence
       FXBFIND, [UNIT or HEADER], KEYWORD, COLUMNS, VALUES, N_FOUND
               [, DEFAULT ]
Input Parameters
       Either UNIT or HEADER must be passed.
       UNIT    = Logical unit number of file opened by FXBOPEN.
       HEADER  = FITS binary table header.
       KEYWORD = Prefix to a series of FITS binary table column keywords.  The
                 keywords to be searched for are formed by combining this
                 prefix with the numbers 1 through the value of TFIELDS in the
                 header.
Optional Input Parameters
       DEFAULT = Default value to use for any column keywords that aren't
                 found.  If passed, then COLUMNS and VALUES will contain
                 entries for every column.  Otherwise, COLUMNS and VALUES only
                 contain entries for columns where values were found.
Output Parameters
       COLUMNS = Array containing the column numbers for which values of the
                 requested keyword series were found.
       VALUES  = Array containing the found values.
       N_FOUND = Number of values found.  The value of this parameter is
                 unaffected by whether or not DEFAULT is passed.
Optional Output
       None.
Optional Keyword Output
      COMMENTS = Comments associated with each keyword, if any
Procedures Used
       FXBFINDLUN, FXPAR
Common Blocks
       Uses common block FXBINTABLE--see "fxbintable.pro" for more
       information.
Restrictions
       If UNIT is passed, then the file must have been opened with FXBOPEN.
       If HEADER is passed, then it must be a legal FITS binary table header.
       The type of DEFAULT must be consistent with the values of the requested
       keywords, i.e. both most be either of string or numerical type.
       The KEYWORD prefix must not have more than five characters to leave
       room for the three digits allowed for the column numbers.
Side Effects
       None.
Category
       Data Handling, I/O, FITS, Generic.
History
       William Thompson, Feb. 1992.
Author
       William Thompson, GSFC, February 1992.
Revision History
       Version 1, William Thompson, GSFC, 12 April 1993.
               Incorporated into CDS library.
Version
       Version 1, 12 April 1993.
       Vectorized implementation improves performance, CM 18 Nov 1999
       Added COMMENTS keyword CM Nov 2003

Last modified by pro2html on 2003 December 02 at 04:44 UTC

[Home Page] [Software, Documentation] [IDL Documentation] [Quick Reference] [Feedback]

Jörn Wilms (wilms@astro.uni-tuebingen.de)
Updated automatically