IsrProvenance

class lsst.ip.isr.IsrProvenance(calibType='unknown', **kwargs)

Bases: IsrCalib

Class for the provenance of data used to construct calibration.

Provenance is not really a calibration, but we would like to record this when constructing the calibration, and it provides an example of the base calibration class.

Parameters

instrumentstr, optional

Name of the instrument the data was taken with.

calibTypestr, optional

Type of calibration this provenance was generated for.

detectorNamestr, optional

Name of the detector this calibration is for.

detectorSerialstr, optional

Identifier for the detector.

Methods Summary

fromDataIds(dataIdList)	Update provenance from dataId List.
fromDict(dictionary)	Construct provenance from a dictionary.
fromTable(tableList)	Construct provenance from table list.
toDict()	Return a dictionary containing the provenance information.
toTable()	Return a list of tables containing the provenance.
updateMetadata([setDate])	Update calibration metadata.

Methods Documentation

fromDataIds(dataIdList)

Update provenance from dataId List.

Parameters

dataIdListlist [lsst.daf.butler.DataId]

List of dataIds used in generating this calibration.

classmethod fromDict(dictionary)

Construct provenance from a dictionary.

Parameters

dictionarydict

Dictionary of provenance parameters.

Returns

provenancelsst.ip.isr.IsrProvenance

The provenance defined in the tables.

classmethod fromTable(tableList)

Construct provenance from table list.

Parameters

tableListlist [lsst.afw.table.Table]

List of tables to construct the provenance from.

Returns

provenancelsst.ip.isr.IsrProvenance

The provenance defined in the tables.

toDict()

Return a dictionary containing the provenance information.

Returns

dictionarydict

Dictionary of provenance.

toTable()

Return a list of tables containing the provenance.

This seems inefficient and slow, so this may not be the best way to store the data.

Returns

tableListlist [lsst.afw.table.Table]

List of tables containing the provenance information

updateMetadata(setDate=False, **kwargs)

Update calibration metadata.

Parameters

setDatebool, optional

Update the CALIBDATE fields in the metadata to the current time. Defaults to False.

kwargsdict or collections.abc.Mapping, optional

Other keyword parameters to set in the metadata.