[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

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


FXBCREATE Source code in fxbcreate.pro

FXBCREATE

Name
       FXBCREATE
Purpose
       Open a new binary table at the end of a FITS file.
Explanation
       Write a binary table extension header to the end of a disk FITS file,
       and leave it open to receive the data.
       The FITS file is opened, and the pointer is positioned just after the
       last 2880 byte record.  Then the binary header is appended.  Calls to
       FXBWRITE will append the binary data to this file, and then FXBFINISH
       will close the file.
Calling Sequence
       FXBCREATE, UNIT, FILENAME, HEADER
Input Parameters
       FILENAME = Name of FITS file to be opened.
       HEADER   = String array containing the FITS binary table extension
                  header.
Optional Input Parameters
       None.
Output Parameters
       UNIT     = Logical unit number of the opened file.
       EXTENSION= Extension number of newly created extension.
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 = ''
                       FXBCREATE, ERRMSG=ERRMSG, ...
                       IF ERRMSG NE '' THEN ...
Procedures Used
       FXADDPAR, FXBFINDLUN, FXBPARSE, FXFINDEND
Common Blocks
       Uses common block FXBINTABLE--see "fxbintable.pro" for more
       information.
Restrictions
       The primary FITS data unit must already be written to a file.  The
       binary table extension header must already be defined (FXBHMAKE), and
       must match the data that will be written to the file.
Side Effects
       None.
Category
       Data Handling, I/O, FITS, Generic.
History
       W. Thompson, Jan 1992, based on WRITEFITS by J. Woffard and W. Landsman.
       W. Thompson, Feb 1992, changed from function to procedure.
       W. Thompson, Feb 1992, removed all references to temporary files.
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 July 1993.
               Fixed bug with variable length arrays.
       Version 3, William Thompson, GSFC, 21 June 1994
               Added ERRMSG keyword.
       Version 4, William Thompson, GSFC, 23 June 1994
               Modified so that ERRMSG is not touched if not defined.
       Version 5, Antony Bird, Southampton, 25 June 1997
               Modified to allow very long tables
Version
       Version 5, 25 June 1997
       Converted to IDL V5.0   W. Landsman   September 1997
       Added EXTENSION parameter, C. Markwardt 1999 Jul 15
       More efficient zeroing of file, C. Markwardt, 26 Feb 2001

Last modified by pro2html on 2002 December 14 at 05:17 UTC

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

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