[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

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


FXBOPEN Source code in fxbopen.pro

FXBOPEN

Name
       FXBOPEN
Purpose
       Open binary table extension in a disk FITS file for reading or updating
Explanation
       Opens a binary table extension in a disk FITS file for reading.  The
       columns are then read using FXBREAD, and the file is closed when done
       with FXBCLOSE.
Calling Sequence
       FXBOPEN, UNIT, FILENAME, EXTENSION  [, HEADER ]
Input Parameters
       FILENAME  = Name of FITS file to be opened.  Optional
                   extension *number* may be specified, in either of
                   the following formats (using the FTOOLS
                   convention): FILENAME[EXT] or FILENAME+EXT, where
                   EXT is 1 or higher.  Such an extension
                   specification takes priority over EXTENSION.
       EXTENSION = Either the number of the FITS extension, starting with the
                   first extension after the primary data unit being one; or a
                   character string containing the value of EXTNAME to search
                   for.
Optional Input Parameters
       None.
Output Parameters
       UNIT      = Logical unit number of the opened file.
Optional Output
       HEADER    = String array containing the FITS binary table extension
                   header.
Keyword Parameters
       NO_TDIM   = If set, then any TDIMn keywords found in the header are
                   ignored.
       ACCESS    = A scalar string describing access privileges as
                   one of READ ('R') or UPDATE ('RW').
                   DEFAULT: 'R'
       REOPEN    = If set, UNIT must be an already-opened file unit.
                   FXBOPEN will treat the file as a FITS file.
       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 = ''
                       FXBOPEN, ERRMSG=ERRMSG, ...
                       IF ERRMSG NE '' THEN ...
Procedures Used
       FXBFINDLUN, FXBPARSE, FXHREAD, FXPAR
Common Blocks
       Uses common block FXBINTABLE--see "fxbintable.pro" for more
       information.
Restrictions
       The file must be a valid FITS file.
Side Effects
       None.
Category
       Data Handling, I/O, FITS, Generic.
History
       W. Thompson, Feb 1992, based on READFITS by J. Woffard and W. Landsman.
       W. Thompson, Feb 1992, changed from function to procedure.
       W. Thompson, June 1992, fixed up error handling.
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, 27 May 1994
               Added ERRMSG keyword.
       Version 3, William Thompson, GSFC, 21 June 1994
               Extended ERRMSG to call to FXBPARSE
       Version 4, William Thompson, GSFC, 23 June 1994
               Modified so that ERRMSG is not touched if not defined.
       Version 4, 23 June 1994
               Converted to IDL V5.0   W. Landsman   September 1997
 Added ACCESS, REOPEN keywords, and FXFILTER package, CM 1999 Feb 03
 Added FILENAME[EXT] and FILENAME+EXT extension parsing, CM 1999 Jun 28
 Some general tidying, CM 1999 Nov 18

Last modified by pro2html on 2003 November 05 at 04:48 UTC

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

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