lsst.pipe.tasks.postprocess.VisitDataIdContainer Class Reference

Inheritance diagram for lsst.pipe.tasks.postprocess.VisitDataIdContainer:

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

Public Attributes
	refList
	datasetType
	level
	idList

Detailed Description

DataIdContainer that groups sensor-level id's by visit

Definition at line 1072 of file postprocess.py.

Member Function Documentation

castDataIds()

def lsst.pipe.base.argumentParser.DataIdContainer.castDataIds (   self,   butler  )

inherited

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

This code casts the values in the data IDs dicts in `dataIdList`
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`.

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

Definition at line 133 of file argumentParser.py.

    def castDataIds(self, butler):
        """Validate data IDs and cast them to the correct type
        (modify idList in place).
 
        This code casts the values in the data IDs dicts in `dataIdList`
        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`.
 
        Parameters
        ----------
        butler : `lsst.daf.persistence.Butler`
            Data butler.
        """
        if self.datasetType is None:
            raise RuntimeError("Must call setDatasetType first")
        try:
            idKeyTypeDict = butler.getKeys(datasetType=self.datasetType, level=self.level)
        except KeyError as e:
            msg = f"Cannot get keys for datasetType {self.datasetType} at level {self.level}"
            raise KeyError(msg) from e
 
        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
 
                    log = lsstLog.Log.getDefaultLogger()
                    log.warn("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.pipe.tasks.postprocess.VisitDataIdContainer.makeDataRefList	(		self,
			namespace
	)

Make self.refList from self.idList

Generate a list of data references grouped by visit.

Parameters
----------
namespace : `argparse.Namespace`
    Namespace used by `lsst.pipe.base.CmdLineTask` to parse command line arguments

Reimplemented from lsst.pipe.base.argumentParser.DataIdContainer.

Definition at line 1076 of file postprocess.py.

    def makeDataRefList(self, namespace):
        """Make self.refList from self.idList
 
        Generate a list of data references grouped by visit.
 
        Parameters
        ----------
        namespace : `argparse.Namespace`
            Namespace used by `lsst.pipe.base.CmdLineTask` to parse command line arguments
        """
        # Group by visits
        visitRefs = defaultdict(list)
        for dataId in self.idList:
            if "visit" in dataId:
                visitId = dataId["visit"]
                # append all subsets to
                subset = namespace.butler.subset(self.datasetType, dataId=dataId)
                visitRefs[visitId].extend([dataRef for dataRef in subset])
 
        outputRefList = []
        for refList in visitRefs.values():
            existingRefs = [ref for ref in refList if ref.datasetExists()]
            if existingRefs:
                outputRefList.append(existingRefs)
 
        self.refList = outputRefList
 
 

setDatasetType()

def lsst.pipe.base.argumentParser.DataIdContainer.setDatasetType (   self,   datasetType  )

inherited

Set actual dataset type, once it is known.

Parameters
----------
datasetType : `str`
    Dataset type.

Notes
-----
The reason ``datasetType`` is not a constructor argument is that
some subclasses do not know the dataset type until the command
is parsed. Thus, to reduce special cases in the code,
``datasetType`` is always set after the command is parsed.

Definition at line 116 of file argumentParser.py.

    def setDatasetType(self, datasetType):
        """Set actual dataset type, once it is known.
 
        Parameters
        ----------
        datasetType : `str`
            Dataset type.
 
        Notes
        -----
        The reason ``datasetType`` is not a constructor argument is that
        some subclasses do not know the dataset type until the command
        is parsed. Thus, to reduce special cases in the code,
        ``datasetType`` is always set after the command is parsed.
        """
        self.datasetType = datasetType
 

Member Data Documentation

datasetType

lsst.pipe.base.argumentParser.DataIdContainer.datasetType

inherited

Definition at line 98 of file argumentParser.py.

idList

lsst.pipe.base.argumentParser.DataIdContainer.idList

inherited

Definition at line 104 of file argumentParser.py.

level

lsst.pipe.base.argumentParser.DataIdContainer.level

inherited

Definition at line 101 of file argumentParser.py.

refList

lsst.pipe.tasks.postprocess.VisitDataIdContainer.refList

Definition at line 1101 of file postprocess.py.

---

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

• /j/snowflake/release/lsstsw/stack/0.4.3/Linux64/pipe_tasks/21.0.0-61-ge77b8116+a869d0a5a5/python/lsst/pipe/tasks/postprocess.py