Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


  >  Docs Center  >  Libraries  >  ASTROLIB  >  FXBHMAKE

FXBHMAKE

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.

Use


FXBHMAKE, HEADER, NROWS [, EXTNAME [, COMMENT ]]

Inputs


NROWS = Number of rows in the binary table.
  Opt. Inputs :
EXTNAME = If passed, then the EXTNAME record is added with this value.
COMMENT = Comment to go along with EXTNAME.

Outputs


HEADER = String array containing FITS extension header.
  Opt. Outputs:
None.

Keywords


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 ...

Calls


GET_DATE, FXADDPAR, FXHCLEAN
  Common :
None.

Restrictions


Warning: No checking is done of any of the parameters.

Side Effects


None.

Category


Data Handling, I/O, FITS, Generic.
  Prev. Hist. :
William Thompson, Jan 1992.
William Thompson, Sep 1992, added EXTVER and EXTLEVEL keywords.
  Written :
William Thompson, GSFC, January 1992.
  Modified :
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



© 2018 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us