|
lsst.ip.isr g9cb75138f3+bac7c66737
|
Public Member Functions | |
| def | __init__ (self, calibType="unknown", **kwargs) |
| def | __str__ (self) |
| def | __eq__ (self, other) |
| def | updateMetadata (self, setDate=False, **kwargs) |
| def | fromDataIds (self, dataIdList) |
| def | fromTable (cls, tableList) |
| def | fromDict (cls, dictionary) |
| def | toDict (self) |
| def | toTable (self) |
Public Attributes | |
| calibType | |
| dimensions | |
| dataIdList | |
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
----------
instrument : `str`, optional
Name of the instrument the data was taken with.
calibType : `str`, optional
Type of calibration this provenance was generated for.
detectorName : `str`, optional
Name of the detector this calibration is for.
detectorSerial : `str`, optional
Identifier for the detector.
Definition at line 634 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.__init__ | ( | self, | |
calibType = "unknown", |
|||
| ** | kwargs | ||
| ) |
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 655 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.__eq__ | ( | self, | |
| other | |||
| ) |
Calibration equivalence. Running ``calib.log.setLevel(0)`` enables debug statements to identify problematic fields.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 668 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.__str__ | ( | self | ) |
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 665 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.fromDataIds | ( | self, | |
| dataIdList | |||
| ) |
Update provenance from dataId List.
Parameters
----------
dataIdList : `list` [`lsst.daf.butler.DataId`]
List of dataIds used in generating this calibration.
Definition at line 685 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.fromDict | ( | cls, | |
| dictionary | |||
| ) |
Construct provenance from a dictionary.
Parameters
----------
dictionary : `dict`
Dictionary of provenance parameters.
Returns
-------
provenance : `lsst.ip.isr.IsrProvenance`
The provenance defined in the tables.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 736 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.fromTable | ( | cls, | |
| tableList | |||
| ) |
Construct provenance from table list.
Parameters
----------
tableList : `list` [`lsst.afw.table.Table`]
List of tables to construct the provenance from.
Returns
-------
provenance : `lsst.ip.isr.IsrProvenance`
The provenance defined in the tables.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 700 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.toDict | ( | self | ) |
Return a dictionary containing the provenance information.
Returns
-------
dictionary : `dict`
Dictionary of provenance.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 765 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.toTable | ( | self | ) |
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
-------
tableList : `list` [`lsst.afw.table.Table`]
List of tables containing the provenance information
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 789 of file calibType.py.
| def lsst.ip.isr.calibType.IsrProvenance.updateMetadata | ( | self, | |
setDate = False, |
|||
| ** | kwargs | ||
| ) |
Update calibration metadata.
Parameters
----------
setDate : `bool, optional
Update the CALIBDATE fields in the metadata to the current
time. Defaults to False.
kwargs : `dict` or `collections.abc.Mapping`, optional
Other keyword parameters to set in the metadata.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 671 of file calibType.py.
| lsst.ip.isr.calibType.IsrProvenance.calibType |
Definition at line 657 of file calibType.py.
| lsst.ip.isr.calibType.IsrProvenance.dataIdList |
Definition at line 659 of file calibType.py.
| lsst.ip.isr.calibType.IsrProvenance.dimensions |
Definition at line 658 of file calibType.py.