[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

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


FXBWRITE Source code in fxbwrite.pro

FXBWRITE

Name
       FXBWRITE
Purpose
       Write a binary data array to a disk FITS binary table file.
Explanation
       Each call to FXBWRITE will write to the data file, which should already
       have been created and opened by FXBCREATE.  One needs to call this
       routine for every column and every row in the binary table.  FXBFINISH
       will then close the file.
Calling Sequence
       FXBWRITE, UNIT, DATA, COL, ROW
Input Parameters
       UNIT    = Logical unit number corresponding to the file containing the
                 binary table.
       DATA    = IDL data array to be written to the file.
       COL     = Column in the binary table to place data in, starting from
                 column one.
       ROW     = Row in the binary table to place data in, starting from row
                 one.
Optional Input Parameters
       None.
Output Parameters
       None.
Optional Output
       None.
Keyword Parameters
       BIT     = Number of bits in bit mask arrays (type "X").  Only used if
                 the column is of variable size.
       NANVALUE= Value signalling data dropout.  All points corresponding to
                 this value are set to be IEEE NaN (not-a-number).  Ignored
                 unless DATA is of type float, double-precision or complex.
       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 = ''
                       FXBWRITE, ERRMSG=ERRMSG, ...
                       IF ERRMSG NE '' THEN ...
Procedures Used
       HOST_TO_IEEE
Common Blocks
       Uses common block FXBINTABLE--see "fxbintable.pro" for more
       information.
Restrictions
       The binary table file must have been opened with FXBCREATE.
       The data must be consistent with the column definition in the binary
       table header.
       The row number must be consistent with the number of rows stored in the
       binary table header.
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, modified to support variable length arrays.
       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, 31 May 1994
               Added ERRMSG keyword.
       Version 4, William Thompson, GSFC, 23 June 1994
               Modified so that ERRMSG is not touched if not defined.
       Version 5, Wayne Landsman, GSFC, 12 Aug 1997
               Recognize IDL double complex data type
Version
       Version 5, 12 August 1997
       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