lsst.jointcal.jointcal.JointcalRunner Class Reference

Inheritance diagram for lsst.jointcal.jointcal.JointcalRunner:

Public Member Functions
def	__call__ (self, args)

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

Detailed Description

Subclass of TaskRunner for jointcalTask (gen2)

jointcalTask.runDataRef() takes a number of arguments, one of which is a list of dataRefs
extracted from the command line (whereas most CmdLineTasks' runDataRef methods take
single dataRef, are are called repeatedly). This class transforms the processed
arguments generated by the ArgumentParser into the arguments expected by
Jointcal.runDataRef().

See pipeBase.TaskRunner for more information.

Definition at line 65 of file jointcal.py.

Member Function Documentation

__call__()

def lsst.jointcal.jointcal.JointcalRunner.__call__	(		self,
			args
	)

Parameters
----------
args
    Arguments for Task.runDataRef()

Returns
-------
pipe.base.Struct
    if self.doReturnResults is False:

    - ``exitStatus``: 0 if the task completed successfully, 1 otherwise.

    if self.doReturnResults is True:

    - ``result``: the result of calling jointcal.runDataRef()
    - ``exitStatus``: 0 if the task completed successfully, 1 otherwise.

Definition at line 94 of file jointcal.py.

    def __call__(self, args):
        """
        Parameters
        ----------
        args
            Arguments for Task.runDataRef()
 
        Returns
        -------
        pipe.base.Struct
            if self.doReturnResults is False:
 
            - ``exitStatus``: 0 if the task completed successfully, 1 otherwise.
 
            if self.doReturnResults is True:
 
            - ``result``: the result of calling jointcal.runDataRef()
            - ``exitStatus``: 0 if the task completed successfully, 1 otherwise.
        """
        exitStatus = 0  # exit status for shell
 
        # NOTE: cannot call self.makeTask because that assumes args[0] is a single dataRef.
        dataRefList, kwargs = args
        butler = kwargs.pop('butler')
        task = self.TaskClass(config=self.config, log=self.log, butler=butler)
        result = None
        try:
            result = task.runDataRef(dataRefList, **kwargs)
            exitStatus = result.exitStatus
            job_path = butler.get('verify_job_filename')
            result.job.write(job_path[0])
        except Exception as e:  # catch everything, sort it out later.
            if self.doRaise:
                raise e
            else:
                exitStatus = 1
                eName = type(e).__name__
                tract = dataRefList[0].dataId['tract']
                task.log.fatal("Failed processing tract %s, %s: %s", tract, eName, e)
 
        # Put the butler back into kwargs for the other Tasks.
        kwargs['butler'] = butler
        if self.doReturnResults:
            return pipeBase.Struct(result=result, exitStatus=exitStatus)
        else:
            return pipeBase.Struct(exitStatus=exitStatus)
 
 

getTargetList()

def lsst.jointcal.jointcal.JointcalRunner.getTargetList (   parsedCmd, **  kwargs  )

static

Return a list of tuples per tract, each containing (dataRefs, kwargs).

Jointcal operates on lists of dataRefs simultaneously.

Definition at line 78 of file jointcal.py.

    def getTargetList(parsedCmd, **kwargs):
        """
        Return a list of tuples per tract, each containing (dataRefs, kwargs).
 
        Jointcal operates on lists of dataRefs simultaneously.
        """
        kwargs['butler'] = parsedCmd.butler
 
        # organize data IDs by tract
        refListDict = {}
        for ref in parsedCmd.id.refList:
            refListDict.setdefault(ref.dataId["tract"], []).append(ref)
        # we call runDataRef() once with each tract
        result = [(refListDict[tract], kwargs) for tract in sorted(refListDict.keys())]
        return result
 

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/jointcal/22.0.1-25-g5bf6245+3ad8ecd50b/python/lsst/jointcal/jointcal.py