Bases: object
Represents a FITS keyword, which may have several synonyms.
Parameters: | name : str, optional
value : str or numeric type, optional
comment : str, optional
synonyms : str or list of str, optional
|
---|
Attributes Summary
name | Primary name of the keyword. |
names | All names, including synonyms, for this keyword, as a list. |
synonyms | List of synonyms for the keyword. |
Methods Summary
add_to_header(hdu_or_header[, ...]) | Add keyword to FITS header. |
history_comment([with_name]) | Produce a string describing changes to the keyword value. |
set_value_from_header(hdu_or_header) | Set value of keyword from FITS header. |
Attributes Documentation
Methods Documentation
Add keyword to FITS header.
Parameters: | hdu_or_header : astropy.io.fits.Header or astropy.io.fits.PrimaryHDU
with_synonyms : bool, optional
history : bool, optional
|
---|
Produce a string describing changes to the keyword value.
Parameters: | with_name : str, optional
|
---|
Set value of keyword from FITS header.
Values are obtained from the header by looking for the keyword by its primary name and any synonyms. If multiple values are found they are checked for consistency.
Parameters: | hdu_or_header: astropy.io.fits.Header or astrop.io.fits.PrimaryHDU
|
---|---|
Raises: | ValueError
|