[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

Waldhäuser Str. 64, D-72076 Tübingen, Germany
[Uni logo]


FXBTFORM Source code in fxbtform.pro

FXBTFORM

Name
       FXBTFORM
Purpose
       Returns information about FITS binary table columns.
Explanation
       Procedure to return information about the format of the various columns
       in a FITS binary table.
Calling Sequence
       FXBTFORM,HEADER,TBCOL,IDLTYPE,FORMAT,NUMVAL,MAXVAL
Input Parameters
       HEADER  = Fits binary table header.
Optional Input Parameters
       None.
Output Parameters
       TBCOL   = Array of starting column positions in bytes.
       IDLTYPE = IDL data types of columns.
       FORMAT  = Character code defining the data types of the columns.
       NUMVAL  = Number of elements of the data arrays in the columns.
       MAXVAL  = Maximum number of elements for columns containing variable
                 length arrays, or zero otherwise.
Optional Output
       None.
Keyword Parameters
       ERRMSG    = If defined and passed, then any error messages will be
                   returned to the user in this parameter rather than
                   depending on the MESSAGE routine in IDL.  If no errors are
                   encountered, then a null string is returned.  In order to
                   use this feature, ERRMSG must be defined first, e.g.
                       ERRMSG = ''
                       FXBTFORM, ERRMSG=ERRMSG, ...
                       IF ERRMSG NE '' THEN ...
Procedures Used
       FXPAR
Common Blocks
       None.
Restrictions
       None.
Side Effects
       None.
Category
       Data Handling, I/O, FITS, Generic.
History
       W. Thompson, Feb. 1992, from TBINFO by D. Lindler.
       W. Thompson, Jan. 1993, renamed to be compatible with DOS limitations.
Author
       William Thompson, GSFC, February 1992.
Revision History
       Version 1, William Thompson, GSFC, 12 April 1993.
               Incorporated into CDS library.
       Version 2, William Thompson, GSFC, 21 June 1994
               Added ERRMSG keyword.
       Version 3, William Thompson, GSFC, 23 June 1994
               Modified so that ERRMSG is not touched if not defined.
       Version 4, William Thompson, GSFC, 9 April 1997
               Modified so that variable length arrays can be read, even if
               the maximum array size is not in the header.
       Version 5  Wayne Landsman, GSFC, August 1997
               Recognize double complex array type if since IDL version 4.0
Version
       Version 6
       Optimized FXPAR call, CM 1999 Nov 18

Last modified by pro2html on 2001 April 26 at 03:12 UTC

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

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