lsst.fgcmcal.dataIds.TractCheckDataIdContainer Class Reference

Inheritance diagram for lsst.fgcmcal.dataIds.TractCheckDataIdContainer:

Public Member Functions
def	castDataIds (self, butler)
def	makeDataRefList (self, namespace)

Detailed Description

A version of lsst.pipe.base.DataIdContainer that ensures that tract
is additionally set with sourceTable_visit catalogs.

Definition at line 30 of file dataIds.py.

Member Function Documentation

castDataIds()

def lsst.fgcmcal.dataIds.TractCheckDataIdContainer.castDataIds	(		self,
			butler
	)

Validate data IDs and cast them to the correct type
(modify self.idList in place).

This code casts the values in the data IDs dicts in `self.idList`
to the type required by the butler. Data IDs are read from the
command line as `str`, but the butler requires some values to be
other types. For example "visit" values should be `int` (which
is defined by the templates).

This is taken from lsst.pipe.base.ArgumentParser.castDataIds(),
adding in a check that the tract is an int, which must be done
explicitly because it is not in the template.

Parameters
----------
butler : `lsst.daf.persistence.Butler`
    Data butler.

Definition at line 36 of file dataIds.py.

    def castDataIds(self, butler):
        """Validate data IDs and cast them to the correct type
        (modify self.idList in place).
 
        This code casts the values in the data IDs dicts in `self.idList`
        to the type required by the butler. Data IDs are read from the
        command line as `str`, but the butler requires some values to be
        other types. For example "visit" values should be `int` (which
        is defined by the templates).
 
        This is taken from lsst.pipe.base.ArgumentParser.castDataIds(),
        adding in a check that the tract is an int, which must be done
        explicitly because it is not in the template.
 
        Parameters
        ----------
        butler : `lsst.daf.persistence.Butler`
            Data butler.
        """
        datasetType = 'sourceTable_visit'
        try:
            idKeyTypeDict = butler.getKeys(datasetType=datasetType, level=self.level)
        except KeyError as e:
            msg = f"Cannot get keys for datasetType {datasetType} at level {self.level}"
            raise KeyError(msg) from e
 
        idKeyTypeDict = idKeyTypeDict.copy()
        idKeyTypeDict['tract'] = int
 
        log = None
 
        for dataDict in self.idList:
            for key, strVal in dataDict.items():
                try:
                    keyType = idKeyTypeDict[key]
                except KeyError:
                    # OK, assume that it's a valid key and guess that it's a string
                    keyType = str
 
                    if log is None:
                        log = lsstLog.Log.getDefaultLogger()
                    log.warning("Unexpected ID %s; guessing type is \"%s\"",
                                key, 'str' if keyType == str else keyType)
                    idKeyTypeDict[key] = keyType
 
                if keyType != str:
                    try:
                        castVal = keyType(strVal)
                    except Exception:
                        raise TypeError(f"Cannot cast value {strVal!r} to {keyType} for ID key {key}")
                    dataDict[key] = castVal
 

makeDataRefList()

def lsst.fgcmcal.dataIds.TractCheckDataIdContainer.makeDataRefList	(		self,
			namespace
	)

Definition at line 88 of file dataIds.py.

    def makeDataRefList(self, namespace):
        if self.datasetType is None:
            raise RuntimeError("Must call setDatasetType first")
 
        tracts = set()
        for dataId in self.idList:
            if "tract" not in dataId:
                raise RuntimeError("Must set tract for dataId")
            tracts.add(dataId['tract'])
 
            self.refList.append(namespace.butler.dataRef(datasetType=self.datasetType,
                                                         dataId=dataId))
 
        if len(tracts) > 1:
            raise RuntimeError("Can only run a single tract")

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/fgcmcal/22.0.1-12-g9c3108e+df145f6f68/python/lsst/fgcmcal/dataIds.py