FgcmMakeLutRunner¶
-
class
lsst.fgcmcal.
FgcmMakeLutRunner
(TaskClass, parsedCmd, doReturnResults=False)¶ Bases:
lsst.pipe.base.ButlerInitializedTaskRunner
Subclass of TaskRunner for fgcmMakeLutTask
fgcmMakeLutTask.run() takes one argument, the butler, and does not run on any data in the repository. This runner does not use any parallelization.
Attributes Summary
TIMEOUT
Methods Summary
__call__
(butler)Parameters: getTargetList
(parsedCmd)Return a list with one element, the butler. makeTask
([parsedCmd, args])A variant of the base version that passes a butler argument to the task’s constructor. precall
(parsedCmd)Hook for code that should run exactly once, before multiprocessing. prepareForMultiProcessing
()Prepare this instance for multiprocessing run
(parsedCmd)Run the task, with no multiprocessing runTask
(task, dataRef, kwargs)Make the actual call to runDataRef
for this task.Attributes Documentation
-
TIMEOUT
= 2592000¶
Methods Documentation
-
__call__
(butler)¶ Parameters: - butler: `lsst.daf.persistence.Butler`
Returns: - exitStatus: `list` with `pipeBase.Struct`
exitStatus (0: success; 1: failure)
-
static
getTargetList
(parsedCmd)¶ Return a list with one element, the butler.
-
makeTask
(parsedCmd=None, args=None)¶ A variant of the base version that passes a butler argument to the task’s constructor.
Parameters: - parsedCmd :
argparse.Namespace
Parsed command-line options, as returned by the
ArgumentParser
; if specified then args is ignored.- args
Other arguments; if
parsedCmd
isNone
then this must be specified.
Raises: - RuntimeError
Raised if
parsedCmd
andargs
are bothNone
.
- parsedCmd :
-
precall
(parsedCmd)¶ Hook for code that should run exactly once, before multiprocessing.
Notes
Must return True if
TaskRunner.__call__
should subsequently be called.Warning
Implementations must take care to ensure that no unpicklable attributes are added to the TaskRunner itself, for compatibility with multiprocessing.
The default implementation writes package versions, schemas and configs, or compares them to existing files on disk if present.
-
prepareForMultiProcessing
()¶ Prepare this instance for multiprocessing
Optional non-picklable elements are removed.
This is only called if the task is run under multiprocessing.
-
run
(parsedCmd)¶ Run the task, with no multiprocessing
Parameters: - parsedCmd: ArgumentParser parsed command line
-
runTask
(task, dataRef, kwargs)¶ Make the actual call to
runDataRef
for this task.Parameters: - task :
lsst.pipe.base.CmdLineTask
class The class of the task to run.
- dataRef
Butler data reference that contains the data the task will process.
- kwargs
Any additional keyword arguments. See
TaskRunner.getTargetList
above.
Notes
The default implementation of
TaskRunner.runTask
works for any command-line task which has arunDataRef
method that takes a data reference and an optional set of additional keyword arguments. This method returns the results generated by the task’srunDataRef
method.- task :
-