lsst.pipe.tasks.multiBandUtils.MergeSourcesRunner Class Reference

Inheritance diagram for lsst.pipe.tasks.multiBandUtils.MergeSourcesRunner:

Public Member Functions
def	makeTask (self, parsedCmd=None, args=None)

Static Public Member Functions
def	buildRefDict (parsedCmd)
def	getTargetList (parsedCmd, **kwargs)

Detailed Description

Task runner for `MergeDetectionTask` `MergeMeasurementTask`

Required because the run method requires a list of
dataRefs rather than a single dataRef.

Definition at line 29 of file multiBandUtils.py.

Member Function Documentation

buildRefDict()

def lsst.pipe.tasks.multiBandUtils.MergeSourcesRunner.buildRefDict (   parsedCmd )

static

Build a hierarchical dictionary of patch references

Parameters
----------
parsedCmd:
    The parsed command

Returns
-------
refDict: dict
    A reference dictionary of the form {patch: {tract: {filter: dataRef}}}

Raises
------
RuntimeError
    Thrown when multiple references are provided for the same
    combination of tract, patch and filter

Definition at line 60 of file multiBandUtils.py.

    def buildRefDict(parsedCmd):
        """Build a hierarchical dictionary of patch references
 
        Parameters
        ----------
        parsedCmd:
            The parsed command
 
        Returns
        -------
        refDict: dict
            A reference dictionary of the form {patch: {tract: {filter: dataRef}}}
 
        Raises
        ------
        RuntimeError
            Thrown when multiple references are provided for the same
            combination of tract, patch and filter
        """
        refDict = {}  # Will index this as refDict[tract][patch][filter] = ref
        for ref in parsedCmd.id.refList:
            tract = ref.dataId["tract"]
            patch = ref.dataId["patch"]
            filter = ref.dataId["filter"]
            if tract not in refDict:
                refDict[tract] = {}
            if patch not in refDict[tract]:
                refDict[tract][patch] = {}
            if filter in refDict[tract][patch]:
                raise RuntimeError("Multiple versions of %s" % (ref.dataId,))
            refDict[tract][patch][filter] = ref
        return refDict
 

getTargetList()

def lsst.pipe.tasks.multiBandUtils.MergeSourcesRunner.getTargetList (   parsedCmd, **  kwargs  )

static

Provide a list of patch references for each patch, tract, filter combo.

Parameters
----------
parsedCmd:
    The parsed command
kwargs:
    Keyword arguments passed to the task

Returns
-------
targetList: list
    List of tuples, where each tuple is a (dataRef, kwargs) pair.

Definition at line 94 of file multiBandUtils.py.

    def getTargetList(parsedCmd, **kwargs):
        """Provide a list of patch references for each patch, tract, filter combo.
 
        Parameters
        ----------
        parsedCmd:
            The parsed command
        kwargs:
            Keyword arguments passed to the task
 
        Returns
        -------
        targetList: list
            List of tuples, where each tuple is a (dataRef, kwargs) pair.
        """
        refDict = MergeSourcesRunner.buildRefDict(parsedCmd)
        return [(list(p.values()), kwargs) for t in refDict.values() for p in t.values()]
 
 

makeTask()

def lsst.pipe.tasks.multiBandUtils.MergeSourcesRunner.makeTask	(		self,
			parsedCmd = None,
			args = None
	)

Provide a butler to the Task constructor.

Parameters
----------
parsedCmd:
    The parsed command
args: tuple
    Tuple of a list of data references and kwargs (un-used)

Raises
------
RuntimeError
    Thrown if both `parsedCmd` & `args` are `None`

Definition at line 35 of file multiBandUtils.py.

    def makeTask(self, parsedCmd=None, args=None):
        """Provide a butler to the Task constructor.
 
        Parameters
        ----------
        parsedCmd:
            The parsed command
        args: tuple
            Tuple of a list of data references and kwargs (un-used)
 
        Raises
        ------
        RuntimeError
            Thrown if both `parsedCmd` & `args` are `None`
        """
        if parsedCmd is not None:
            butler = parsedCmd.butler
        elif args is not None:
            dataRefList, kwargs = args
            butler = dataRefList[0].getButler()
        else:
            raise RuntimeError("Neither parsedCmd or args specified")
        return self.TaskClass(config=self.config, log=self.log, butler=butler)
 

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/multiBandUtils.py