lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractRunner Class Reference

Inheritance diagram for lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractRunner:

Public Member Functions
def	__call__ (self, args)
def	run (self, parsedCmd)

Static Public Member Functions
def	getTargetList (parsedCmd)

Detailed Description

Subclass of TaskRunner for FgcmCalibrateTractTask

fgcmCalibrateTractTask.run() takes a number of arguments, one of which is
the butler (for persistence and mapper data), and a list of dataRefs
extracted from the command line.  This task runs on a constrained set
of dataRefs, typically a single tract.
This class transforms the process arguments generated by the ArgumentParser
into the arguments expected by FgcmCalibrateTractTask.run().
This runner does not use any parallelization.

Definition at line 100 of file fgcmCalibrateTractBase.py.

Member Function Documentation

__call__()

def lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractRunner.__call__	(		self,
			args
	)

Parameters
----------
args: `tuple` with (butler, dataRefList)

Returns
-------
exitStatus: `list` with `lsst.pipe.base.Struct`
   exitStatus (0: success; 1: failure)
   May also contain results if `self.doReturnResults` is `True`.

Definition at line 120 of file fgcmCalibrateTractBase.py.

    def __call__(self, args):
        """
        Parameters
        ----------
        args: `tuple` with (butler, dataRefList)
 
        Returns
        -------
        exitStatus: `list` with `lsst.pipe.base.Struct`
           exitStatus (0: success; 1: failure)
           May also contain results if `self.doReturnResults` is `True`.
        """
        butler, dataRefList = args
 
        task = self.TaskClass(config=self.config, log=self.log)
 
        exitStatus = 0
        if self.doRaise:
            results = task.runDataRef(butler, dataRefList)
        else:
            try:
                results = task.runDataRef(butler, dataRefList)
            except Exception as e:
                exitStatus = 1
                task.log.fatal("Failed: %s" % e)
                if not isinstance(e, pipeBase.TaskError):
                    traceback.print_exc(file=sys.stderr)
 
        task.writeMetadata(butler)
 
        if self.doReturnResults:
            return [pipeBase.Struct(exitStatus=exitStatus,
                                    results=results)]
        else:
            return [pipeBase.Struct(exitStatus=exitStatus)]
 

getTargetList()

def lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractRunner.getTargetList (   parsedCmd )

static

Return a list with one element: a tuple with the butler and
list of dataRefs.

Definition at line 113 of file fgcmCalibrateTractBase.py.

    def getTargetList(parsedCmd):
        """
        Return a list with one element: a tuple with the butler and
        list of dataRefs.
        """
        return [(parsedCmd.butler, parsedCmd.id.refList)]
 

run()

def lsst.fgcmcal.fgcmCalibrateTractBase.FgcmCalibrateTractRunner.run	(		self,
			parsedCmd
	)

Run the task, with no multiprocessing

Parameters
----------
parsedCmd: `lsst.pipe.base.ArgumentParser` parsed command line

Definition at line 156 of file fgcmCalibrateTractBase.py.

    def run(self, parsedCmd):
        """
        Run the task, with no multiprocessing
 
        Parameters
        ----------
        parsedCmd: `lsst.pipe.base.ArgumentParser` parsed command line
        """
 
        resultList = []
 
        if self.precall(parsedCmd):
            targetList = self.getTargetList(parsedCmd)
            resultList = self(targetList[0])
 
        return resultList
 
 

---

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/fgcmCalibrateTractBase.py