[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

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


FXBHMAKE Source code in fxbhmake.pro

FXBHMAKE

Name
       FXBHMAKE
Purpose
       Create basic FITS binary table extension (BINTABLE) header.
Explanation
       Creates a basic header array with all the required keywords, but with
       none of the table columns defined.  This defines a basic structure
       which can then be added to or modified by other routines.
Calling Sequence
       FXBHMAKE, HEADER, NROWS  [, EXTNAME  [, COMMENT ]]
Input Parameters
       NROWS   = Number of rows in the binary table.
Optional Input Parameters
       EXTNAME = If passed, then the EXTNAME record is added with this value.
       COMMENT = Comment to go along with EXTNAME.
Output Parameters
       HEADER = String array containing FITS extension header.
Optional Output
       None.
Keyword Parameters
       INITIALIZE = If set, then the header is completely initialized, and any
                    previous entries are lost.
       DATE       = If set, then the DATE keyword is added to the header.
       EXTVER     = Extension version number (integer).
       EXTLEVEL   = Extension level number (integer).
       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 = ''
                       FXBHMAKE, ERRMSG=ERRMSG, ...
                       IF ERRMSG NE '' THEN ...
Procedures Used
       GET_DATE, FXADDPAR, FXHCLEAN
Common Blocks
       None.
Restrictions
       Warning:  No checking is done of any of the parameters.
Side Effects
       None.
Category
       Data Handling, I/O, FITS, Generic.
History
       William Thompson, Jan 1992.
       William Thompson, Sep 1992, added EXTVER and EXTLEVEL keywords.
Author
       William Thompson, GSFC, January 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
       Version 3, 23 June 1994
       Converted to IDL V5.0   W. Landsman   September 1997

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