next up previous 264
Next: AST_FLUXFRAME - Create a FluxFrame
Up: AST Routine Descriptions
Previous: AST_FITSCHAN - Create a FitsChan


AST_FITSTABLE - Create a FitsTable

Description:
This function creates a new FitsTable and optionally initialises its attributes.

The FitsTable class is a representation of a FITS binary table. It inherits from the Table class. The parent Table is used to hold the binary data of the main table, and a FitsChan is used to hold the FITS header. Note, there is no provision for binary data following the main table (such data is referred to as a "heap" in the FITS standard).

Note - it is not recommended to use the FitsTable class to store very large tables.

Invocation:
RESULT = AST_FITSTABLE( HEADER, OPTIONS, STATUS )
Arguments:
HEADER = INTEGER (Given)
Pointer to an optional FitsChan containing headers to be stored in the FitsTable. AST__NULL may be supplied if the new FitsTable is to be left empty. If supplied, and if the headers describe columns of a FITS binary table, then equivalent (empty) columns are added to the FitsTable. Each column has the same index in the FitsTable that it has in the supplied header.
OPTIONS = CHARACTER $*$ ( $*$ ) (Given)
A character string containing an optional comma-separated list of attribute assignments to be used for initialising the new FitsTable. The syntax used is identical to that for the AST_SET routine.
STATUS = INTEGER (Given and Returned)
The global status.
Returned Value:
AST_FITSTABLE = INTEGER
A pointer to the new FitsTable.
Notes:
  • A null Object pointer (AST__NULL) will be returned if this function is invoked with STATUS set to an error value, or if it should fail for any reason.
Status Handling
The protected interface to this function includes an extra parameter at the end of the parameter list described above. This parameter is a pointer to the integer inherited status variable: "int $*$status".


next up previous 264
Next: AST_FLUXFRAME - Create a FluxFrame
Up: AST Routine Descriptions
Previous: AST_FITSCHAN - Create a FitsChan

AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 210
R.F. Warren-Smith & D.S. Berry
24th May 2011
E-mail:ussc@star.rl.ac.uk

Copyright (C) 2009 Science \& Technology Facilities Council