next up previous 530
Next: FITSWRITE - Writes a new keyword to the FITS extension
Up: Specifications of KAPPA applications
Previous: FITSURFACE - Fits a polynomial surface to two-dimensional data array


FITSVAL - Reports the value of a keyword in the FITS extension.

Description:
This application reports the value of a keyword in the FITS extension (`airlock') of an NDF  file. The keyword's value and comment are also stored in output parameters.

Usage:
fitsval ndf keyword

Parameters:
KEYWORD = LITERAL (Read)
The name of an existing keyword in the FITS extension whose value is to be reported. A name may be compound to handle hierarchical keywords, and it has the form keyword1.keyword2.keyword3 etc. The maximum number of keywords per FITS card is 20. Each keyword must be no longer than 8 characters, and be a valid FITS keyword comprising only alphanumeric characters, hyphen, and underscore. Any lowercase letters are converted to uppercase and blanks are removed before comparison with the existing keywords.

KEYWORD may have an occurrence specified in brackets [] following the name. This enables the values to be obtained for keywords that appear more than once. Note that it is not normal to have multiple occurrences of a keyword in a FITS header, unless it is blank, COMMENT or HISTORY. Any text between the brackets other than a positive integer is interpreted as the first occurrence.

The suggested value is the current value.

NDF = NDF (Read)
The NDF containing the FITS keyword.

Results Parameters:
COMMENT = LITERAL (Write)
The comment of the keyword.
VALUE = LITERAL (Write)
The value of the keyword.

Examples:
fitsval abc bscale
This reports the value of the FITS keyword BSCALE, which is located within the FITS extension of the NDF called abc.
fitsval ndf=abc keyword=date[2]
This reports the value of the second occurrence FITS keyword DATE, which is located within the FITS extension of the NDF called abc.

Related Applications :
KAPPA: FITSEDIT, FITSEXIST, FITSHEAD, FITSLIST, FITSMOD.



next up previous 530
Next: FITSWRITE - Writes a new keyword to the FITS extension
Up: Specifications of KAPPA applications
Previous: FITSURFACE - Fits a polynomial surface to two-dimensional data array

KAPPA --- Kernel Application Package
Starlink User Note 95
Malcolm J. Currie & David S. Berry
2013 February 14
E-mail:starlink@jiscmail.ac.uk

Copyright © 2013 Science and Technology Facilities Council