lsst.pipe.tasks.getRepositoryData.DataRefListRunner Class Reference

Inheritance diagram for lsst.pipe.tasks.getRepositoryData.DataRefListRunner:

Public Member Functions
def	__call__ (self, dataRefList)

Static Public Member Functions
def	getTargetList (parsedCmd)

Detailed Description

A task runner that calls run with a list of data references

Differs from the default TaskRunner by providing all data references at once,
instead of iterating over them one at a time.

Definition at line 32 of file getRepositoryData.py.

Member Function Documentation

__call__()

def lsst.pipe.tasks.getRepositoryData.DataRefListRunner.__call__	(		self,
			dataRefList
	)

Run GetRepositoryDataTask.run on a single target

@param dataRefList: argument dict for run; contains one key: dataRefList

@return:
- None if doReturnResults false
- A pipe_base Struct containing these fields if doReturnResults true:
    - dataRefList: the argument dict sent to runDataRef
    - metadata: task metadata after execution of runDataRef
    - result: result returned by task runDataRef

Definition at line 44 of file getRepositoryData.py.

    def __call__(self, dataRefList):
        """Run GetRepositoryDataTask.run on a single target

        @param dataRefList: argument dict for run; contains one key: dataRefList

        @return:
        - None if doReturnResults false
        - A pipe_base Struct containing these fields if doReturnResults true:
            - dataRefList: the argument dict sent to runDataRef
            - metadata: task metadata after execution of runDataRef
            - result: result returned by task runDataRef
        """
        task = self.TaskClass(config=self.config, log=self.log)
        result = task.runDataRef(dataRefList)

        if self.doReturnResults:
            return pipeBase.Struct(
                dataRefList=dataRefList,
                metadata=task.metadata,
                result=result,
            )

getTargetList()

def lsst.pipe.tasks.getRepositoryData.DataRefListRunner.getTargetList (   parsedCmd )

static

Return a list of targets (arguments for __call__); one entry per invocation

Definition at line 39 of file getRepositoryData.py.

    def getTargetList(parsedCmd):
        """Return a list of targets (arguments for __call__); one entry per invocation
        """
        return [parsedCmd.id.refList]  # one argument consisting of a list of dataRefs

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/pipe_tasks/18.1.0/python/lsst/pipe/tasks/getRepositoryData.py