SetFITSKey

Syntax

Document.SetFITSKey ( Key, Value )

Parameters

String Key - the FITS keyword whose value is to be changed

VARIANT Value - value to write for the FITS keyword

Returns

Nothing

Remarks

Assigns a value to a new or existing keyword in the document's FITS header. A FITS keyword consists of up to eight uppercase letters and digits, and begins with a letter. SetFITSKey will convert lower case letters a-z in the name specified by the parameter Key to their corresponding uppercase equivalents A-Z. This affects only the keyword; Value (assuming it is a String) is not changed.

Parameter Value is Variant because FITS keywords are associated with data of different types. For example, OBJECT (the name of the object in an image) is a String, but EXPOSURE (the duration of the exposure) is Double. If the Key specifies a keyword not currently present in the image header, SetFITSKey creates it.

This method provides part of the functionality of MaxIm DL's FITS Header command and can also be used to replace the FITS Header tab of the Settings command. See also GetFITSKey.