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


  >  Docs Center  >  Libraries  >  ASTROLIB  >  FXBTFORM

FXBTFORM

FXBTFORM

Name


FXBTFORM

Purpose


Returns information about FITS binary table columns.

Explanation


Procedure to return information about the format of the various columns
in a FITS binary table.

Use


FXBTFORM,HEADER,TBCOL,IDLTYPE,FORMAT,NUMVAL,MAXVAL

Inputs


HEADER = Fits binary table header.
  Opt. Inputs :
None.

Outputs


TBCOL = Array of starting column positions in bytes.
IDLTYPE = IDL data types of columns.
FORMAT = Character code defining the data types of the columns.
NUMVAL = Number of elements of the data arrays in the columns.
MAXVAL = Maximum number of elements for columns containing variable
length arrays, or zero otherwise.
  Opt. Outputs:
None.

Keywords


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 = ''
FXBTFORM, ERRMSG=ERRMSG, ...
IF ERRMSG NE '' THEN ...

Calls


FXPAR
  Common :
None.

Restrictions


None.

Side Effects


None.

Category


Data Handling, I/O, FITS, Generic.
  Prev. Hist. :
W. Thompson, Feb. 1992, from TBINFO by D. Lindler.
W. Thompson, Jan. 1993, renamed to be compatible with DOS limitations.
  Written :
William Thompson, GSFC, February 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 4, William Thompson, GSFC, 9 April 1997
Modified so that variable length arrays can be read, even if
the maximum array size is not in the header.
Version 5 Wayne Landsman, GSFC, August 1997
Recognize double complex array type if since IDL version 4.0
      Version 6 Optimized FXPAR call, CM 1999 Nov 18
      Version 7: Wayne Landsman, GSFC Feb 2006
              Added support for 64bit integer K format

Version


      Version 8: Wayne Landsman GSFC Apr 2010
              Remove use of obsolete !ERR variable



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