lsst.ip.isr g785b24af70+3078510171
Public Member Functions | Public 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

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
 

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

Constructor & Destructor Documentation

◆ __init__()

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

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

Definition at line 662 of file calibType.py.

Member Function Documentation

◆ __eq__()

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

◆ __str__()

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

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

Definition at line 672 of file calibType.py.

◆ fromDataIds()

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

◆ fromDict()

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

◆ fromTable()

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

◆ toDict()

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

◆ toTable()

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

◆ updateMetadata()

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

Member Data Documentation

◆ calibType

lsst.ip.isr.calibType.IsrProvenance.calibType

Definition at line 664 of file calibType.py.

◆ dataIdList

lsst.ip.isr.calibType.IsrProvenance.dataIdList

Definition at line 666 of file calibType.py.

◆ dimensions

lsst.ip.isr.calibType.IsrProvenance.dimensions

Definition at line 665 of file calibType.py.


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