fitsmgmt.header.update_process

fitsmgmt.header.update_process(
    header,
    process=None,
    key='PROCESS',
    delimiter='',
    add_comment=True,
    additional_comment=None,
)

Update the process history keyword in the header.

Parameters

header : ~astropy.io.fits.Header

The header to update the PROCESS (tunable by key parameter) keyword.

process : str or list-like of str, optional. = None

The additional process keys to add to the header. Default: None.

key : str, optional. = 'PROCESS'

The key for the process-related header keyword. Default: 'PROCESS'.

delimiter : str, optional. = ''

The delimiter for each process. It can be null string (''). The best is to match it with the pre-existing delimiter of the header[key]. Default: ''.

add_comment : bool, optional. = True

Whether to add a comment to the header if there was no key ("PROCESS" by default) in the header. Default: True.

additional_comment : dict, optional. = None

The additional comment to add. For instance, dict(v="vertical pattern", f="fourier pattern") will add a new line of comment which reads “User added items for key: v=vertical pattern, f=fourier pattern.” Default: None.