add_provenance_to_fits_header

lsst.obs.base.add_provenance_to_fits_header(hdr: PropertyList | MutableMapping | None, ref: DatasetRef, provenance: DatasetProvenance | None = None, allow_long_headers: bool = True) → None

Modify the given header to include provenance headers.

Parameters:

hdrlsst.daf.base.PropertyList or collections.abc.MutableMapping

The FITS header to modify. Assumes HIERARCH will be handled implicitly by the writer.

reflsst.daf.butler.DatasetRef

The butler dataset associated with this FITS file.

provenancelsst.daf.butler.DatasetProvenance or None, optional

Provenance for this dataset.

allow_long_headersbool, optional

If True it is assumed that there is no limit to the length of the values being stored. If False, assumes that FITS header cards must be kept within 80 characters including quoting, HIERARCH, and =.