lsst.ip.isr gdc0c513512+9ee1ab4172
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Protected Attributes | List of all members
lsst.ip.isr.calibType.IsrProvenance Class Reference
Inheritance diagram for lsst.ip.isr.calibType.IsrProvenance:
lsst.ip.isr.calibType.IsrCalib

Public Member Functions

 __init__ (self, calibType="unknown", **kwargs)
 
 __str__ (self)
 
 __eq__ (self, other)
 
 updateMetadata (self, setDate=False, **kwargs)
 
 fromDataIds (self, dataIdList)
 
 fromTable (cls, tableList)
 
 fromDict (cls, dictionary)
 
 toDict (self)
 
 toTable (self)
 

Public Attributes

 calibType
 
 dimensions
 
 dataIdList
 

Static Protected Attributes

str _OBSTYPE = "IsrProvenance"
 

Detailed Description

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 686 of file calibType.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.ip.isr.calibType.IsrProvenance.__init__ ( self,
calibType = "unknown",
** kwargs )

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 707 of file calibType.py.

Member Function Documentation

◆ __eq__()

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 720 of file calibType.py.

◆ __str__()

lsst.ip.isr.calibType.IsrProvenance.__str__ ( self)

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 717 of file calibType.py.

◆ fromDataIds()

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 737 of file calibType.py.

◆ fromDict()

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 788 of file calibType.py.

◆ fromTable()

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 752 of file calibType.py.

◆ toDict()

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 817 of file calibType.py.

◆ toTable()

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 841 of file calibType.py.

◆ updateMetadata()

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 723 of file calibType.py.

Member Data Documentation

◆ _OBSTYPE

str lsst.ip.isr.calibType.IsrProvenance._OBSTYPE = "IsrProvenance"
staticprotected

Definition at line 705 of file calibType.py.

◆ calibType

lsst.ip.isr.calibType.IsrProvenance.calibType

Definition at line 709 of file calibType.py.

◆ dataIdList

lsst.ip.isr.calibType.IsrProvenance.dataIdList

Definition at line 711 of file calibType.py.

◆ dimensions

lsst.ip.isr.calibType.IsrProvenance.dimensions

Definition at line 710 of file calibType.py.


The documentation for this class was generated from the following file: