lsst.pipe.base.cmdLineTask.ButlerInitializedTaskRunner Class Reference

A TaskRunner for CmdLineTasks that require a 'butler' keyword argument to be passed to their constructor. More...

Inheritance diagram for lsst.pipe.base.cmdLineTask.ButlerInitializedTaskRunner:

Public Member Functions
def	makeTask
	A variant of the base version that passes a butler argument to the task's constructor. More...
Public Member Functions inherited from lsst.pipe.base.cmdLineTask.TaskRunner
def	__init__
	Construct a TaskRunner. More...
def	prepareForMultiProcessing
	Prepare this instance for multiprocessing by removing optional non-picklable elements. More...
def	run
	Run the task on all targets. More...
def	makeTask
	Create a Task instance. More...
def	precall
	Hook for code that should run exactly once, before multiprocessing is invoked. More...
def	__call__
	Run the Task on a single target. More...

Additional Inherited Members
Static Public Member Functions inherited from lsst.pipe.base.cmdLineTask.TaskRunner
def	getTargetList
	Return a list of (dataRef, kwargs) to be used as arguments for TaskRunner. More...
Public Attributes inherited from lsst.pipe.base.cmdLineTask.TaskRunner
	TaskClass
	doReturnResults
	config
	log
	doRaise
	clobberConfig
	numProcesses
	timeout
Static Public Attributes inherited from lsst.pipe.base.cmdLineTask.TaskRunner
int	TIMEOUT = 9999

Detailed Description

A TaskRunner for CmdLineTasks that require a 'butler' keyword argument to be passed to their constructor.

Definition at line 334 of file cmdLineTask.py.

Member Function Documentation

def lsst.pipe.base.cmdLineTask.ButlerInitializedTaskRunner.makeTask	(		self,
			parsedCmd = None,
			args = None
	)

A variant of the base version that passes a butler argument to the task's constructor.

Parameters

[in]	parsedCmd	parsed command-line options, as returned by the argument parser; if specified then args is ignored
[in]	args	other arguments; if parsedCmd is None then this must be specified

Exceptions

RuntimeError

if parsedCmd and args are both None

Definition at line 338 of file cmdLineTask.py.

    def makeTask(self, parsedCmd=None, args=None):
        """!A variant of the base version that passes a butler argument to the task's constructor

        @param[in] parsedCmd    parsed command-line options, as returned by the argument parser;
            if specified then args is ignored
        @param[in] args         other arguments; if parsedCmd is None then this must be specified

        @throw RuntimeError if parsedCmd and args are both None
        """
        if parsedCmd is not None:
            butler = parsedCmd.butler
        elif args is not None:
            dataRef, kwargs = args
            butler = dataRef.butlerSubset.butler
        else:
            raise RuntimeError("parsedCmd or args must be specified")
        return self.TaskClass(config=self.config, log=self.log, butler=butler)