Source code: SPICE_DATA::get_header_keyword

Class: SPICE_DATA

Description

This method returns the specified keyword from the given window, if the keyword does not exist 'missing_value' is returned if it is provided, !NULL otherwise. This method can also return the variable values of a keyword, if it is available in the binary table extension. See keyword VARIABLE_VALUES.

Syntax

keyword_value = spice_object->get_header_keyword( keyword, extension [, missing_value] [, exists=exists] [, variable_values=variable_values] [, /values_only] )

Return Value

Returns either the scalar keyword value, the MISSING_VALUE if provided or !NULL otherwise.

Arguments

keyword

The header keyword for which the value should be returned.

extension

The index or name of the extension this keyword belongs to.

Keywords

values_only

If set then only the values in the binary table extension are returned to VARIABLE_VALUES as an array, instead of the default output structure with metadata.

Optional Outputs

exists

Set this to a named variable. This variable will be set to 1, if the keyword exists, 0 otherwise.

variable_values

Set this to a named variable. This variable will contain the variable values for this keyword, if this keyword is present in the binary table extension 'VARIABLE-KEYWORDS', otherwise !NULL. Calls the method SPICE_DATA::get_bintable_data with the VALUES_ONLY keyword set.