lsst.ip.isr.calibType.IsrProvenance Class Reference

Inheritance diagram for lsst.ip.isr.calibType.IsrProvenance:

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.

                 **kwargs):
        self.calibType = calibType
        self.dimensions = set()
        self.dataIdList = list()
 
        super().__init__(**kwargs)
 
        self.requiredAttributes.update(["calibType", "dimensions", "dataIdList"])
 

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.

    def __eq__(self, other):
        return super().__eq__(other)
 

__str__()

lsst.ip.isr.calibType.IsrProvenance.__str__

(

self

)

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

Definition at line 717 of file calibType.py.

    def __str__(self):
        return f"{self.__class__.__name__}(obstype={self._OBSTYPE}, calibType={self.calibType}, )"
 

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.

    def fromDataIds(self, dataIdList):
        """Update provenance from dataId List.
 
        Parameters
        ----------
        dataIdList : `list` [`lsst.daf.butler.DataId`]
            List of dataIds used in generating this calibration.
        """
        for dataId in dataIdList:
            for key in dataId:
                if key not in self.dimensions:
                    self.dimensions.add(key)
            self.dataIdList.append(dataId)
 

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.

    def 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.
        """
        calib = cls()
        if calib._OBSTYPE != dictionary["metadata"]["OBSTYPE"]:
            raise RuntimeError(f"Incorrect calibration supplied.  Expected {calib._OBSTYPE}, "
                               f"found {dictionary['metadata']['OBSTYPE']}")
        calib.updateMetadata(setDate=False, setCalibInfo=True, **dictionary["metadata"])
 
        # These properties should be in the metadata, but occasionally
        # are found in the dictionary itself.  Check both places,
        # ending with `None` if neither contains the information.
        calib.calibType = dictionary["calibType"]
        calib.dimensions = set(dictionary["dimensions"])
        calib.dataIdList = dictionary["dataIdList"]
 
        calib.updateMetadata()
        return calib
 

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.

    def 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.
        """
        table = tableList[0]
        metadata = table.meta
        inDict = dict()
        inDict["metadata"] = metadata
        inDict["calibType"] = metadata["calibType"]
        inDict["dimensions"] = set()
        inDict["dataIdList"] = list()
 
        schema = dict()
        for colName in table.columns:
            schema[colName.lower()] = colName
            inDict["dimensions"].add(colName.lower())
        inDict["dimensions"] = sorted(inDict["dimensions"])
 
        for row in table:
            entry = dict()
            for dim in sorted(inDict["dimensions"]):
                entry[dim] = row[schema[dim]]
            inDict["dataIdList"].append(entry)
 
        return cls.fromDict(inDict)
 

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.

    def toDict(self):
        """Return a dictionary containing the provenance information.
 
        Returns
        -------
        dictionary : `dict`
            Dictionary of provenance.
        """
        self.updateMetadata()
 
        outDict = {}
 
        metadata = self.getMetadata()
        outDict["metadata"] = metadata
        outDict["detectorName"] = self._detectorName
        outDict["detectorSerial"] = self._detectorSerial
        outDict["detectorId"] = self._detectorId
        outDict["instrument"] = self._instrument
        outDict["calibType"] = self.calibType
        outDict["dimensions"] = list(self.dimensions)
        outDict["dataIdList"] = self.dataIdList
 
        return outDict
 

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.

    def 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
        """
        tableList = []
        self.updateMetadata(setDate=True, setCalibInfo=True)
 
        catalog = Table(rows=self.dataIdList,
                        names=self.dimensions)
        filteredMetadata = {k: v for k, v in self.getMetadata().toDict().items() if v is not None}
        catalog.meta = filteredMetadata
        tableList.append(catalog)
        return tableList

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.

    def 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.
        """
        kwargs["calibType"] = self.calibType
        super().updateMetadata(setDate=setDate, **kwargs)
 

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_isr/g02d81e74bb+f5613e8b4f/python/lsst/ip/isr/calibType.py