LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Member Functions | Static Public Member Functions | List of all members
lsst.pipe.tasks.getRepositoryData.DataRefListRunner Class Reference
Inheritance diagram for lsst.pipe.tasks.getRepositoryData.DataRefListRunner:

Public Member Functions

def __call__
 

Static Public Member Functions

def getTargetList
 

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 38 of file getRepositoryData.py.

Member Function Documentation

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 50 of file getRepositoryData.py.

50 
51  def __call__(self, dataRefList):
52  """Run GetRepositoryDataTask.run on a single target
53 
54  @param dataRefList: argument dict for run; contains one key: dataRefList
55 
56  @return:
57  - None if doReturnResults false
58  - A pipe_base Struct containing these fields if doReturnResults true:
59  - dataRefList: the argument dict sent to runDataRef
60  - metadata: task metadata after execution of runDataRef
61  - result: result returned by task runDataRef
62  """
63  task = self.TaskClass(config=self.config, log=self.log)
64  result = task.run(dataRefList)
65 
66  if self.doReturnResults:
67  return pipeBase.Struct(
68  dataRefList = dataRefList,
69  metadata = task.metadata,
70  result = result,
71  )
72 
def lsst.pipe.tasks.getRepositoryData.DataRefListRunner.getTargetList (   parsedCmd)
static
Return a list of targets (arguments for __call__); one entry per invocation

Definition at line 45 of file getRepositoryData.py.

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

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