lsst.pipe.drivers  20.0.0-1-g5b95a8c+f41a630bc9
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask Class Reference
Inheritance diagram for lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask:
lsst::ctrl::pool::parallel::BatchPoolTask lsst::ctrl::pool::parallel::BatchCmdLineTask

Public Member Functions

def __init__ (self, butler=None, schema=None, refObjLoader=None, reuse=tuple(), **kwargs)
 
def __reduce__ (self)
 
def batchWallTime (cls, time, parsedCmd, numCpus)
 Return walltime request for batch job. More...
 
def runDataRef (self, patchRefList)
 Run multiband processing on coadds. More...
 
def runDetection (self, cache, patchRef)
 Run detection on a patch. More...
 
def runMergeDetections (self, cache, dataIdList)
 Run detection merging on a patch. More...
 
def runDeblendMerged (self, cache, dataIdList)
 
def runMeasurements (self, cache, dataId)
 
def runMergeMeasurements (self, cache, dataIdList)
 Run measurement merging on a patch. More...
 
def runForcedPhot (self, cache, dataId)
 Run forced photometry on a patch for a single filter. More...
 
def writeMetadata (self, dataRef)
 
def parseAndRun (cls, *args, **kwargs)
 
def parseAndSubmit (cls, args=None, **kwargs)
 
def batchWallTime (cls, time, parsedCmd, numCores)
 
def batchCommand (cls, args)
 
def logOperation (self, operation, catch=False, trace=True)
 

Public Attributes

 butler
 
 reuse
 
 measurementInput
 
 deblenderOutput
 
 coaddType
 

Static Public Attributes

 ConfigClass = MultiBandDriverConfig
 
 RunnerClass = MultiBandDriverTaskRunner
 

Detailed Description

Multi-node driver for multiband processing

Definition at line 95 of file multiBandDriver.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.__init__ (   self,
  butler = None,
  schema = None,
  refObjLoader = None,
  reuse = tuple(),
**  kwargs 
)
Parameters
[in]butlerthe butler can be used to retrieve schema or passed to the refObjLoader constructor in case it is needed.
[in]schemathe schema of the source detection catalog used as input.
[in]refObjLoaderan instance of LoadReferenceObjectsTasks that supplies an external reference catalog. May be None if the butler argument is provided or all steps requiring a reference catalog are disabled.

Definition at line 101 of file multiBandDriver.py.

Member Function Documentation

◆ __reduce__()

def lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.__reduce__ (   self)
Pickler

Definition at line 151 of file multiBandDriver.py.

◆ batchWallTime()

def lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.batchWallTime (   cls,
  time,
  parsedCmd,
  numCpus 
)

Return walltime request for batch job.

Parameters
timeRequested time per iteration
parsedCmdResults of argument parsing
numCoresNumber of cores

Definition at line 168 of file multiBandDriver.py.

◆ runDataRef()

def lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.runDataRef (   self,
  patchRefList 
)

Run multiband processing on coadds.

Only the master node runs this method.

No real MPI communication (scatter/gather) takes place: all I/O goes through the disk. We want the intermediate stages on disk, and the component Tasks are implemented around this, so we just follow suit.

Parameters
patchRefListData references to run measurement

Definition at line 181 of file multiBandDriver.py.

◆ runDeblendMerged()

def lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.runDeblendMerged (   self,
  cache,
  dataIdList 
)
Run the deblender on a list of dataId's

Only slave nodes execute this method.

Parameters
----------
cache: Pool cache
    Pool cache with butler.
dataIdList: list
    Data identifier for patch in each band.

Returns
-------
result: bool
    whether the patch requires reprocessing.

Definition at line 352 of file multiBandDriver.py.

◆ runDetection()

def lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.runDetection (   self,
  cache,
  patchRef 
)

Run detection on a patch.

Only slave nodes execute this method.

Parameters
cachePool cache, containing butler
patchRefPatch on which to do detection

Definition at line 317 of file multiBandDriver.py.

◆ runForcedPhot()

def lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.runForcedPhot (   self,
  cache,
  dataId 
)

Run forced photometry on a patch for a single filter.

Only slave nodes execute this method.

Parameters
cachePool cache, with butler
dataIdData identifier for patch

Definition at line 451 of file multiBandDriver.py.

◆ runMeasurements()

def lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.runMeasurements (   self,
  cache,
  dataId 
)
Run measurement on a patch for a single filter

Only slave nodes execute this method.

Parameters
----------
cache: Pool cache
    Pool cache, with butler
dataId: dataRef
    Data identifier for patch

Definition at line 411 of file multiBandDriver.py.

◆ runMergeDetections()

def lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.runMergeDetections (   self,
  cache,
  dataIdList 
)

Run detection merging on a patch.

Only slave nodes execute this method.

Parameters
cachePool cache, containing butler
dataIdListList of data identifiers for the patch in different filters

Definition at line 334 of file multiBandDriver.py.

◆ runMergeMeasurements()

def lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.runMergeMeasurements (   self,
  cache,
  dataIdList 
)

Run measurement merging on a patch.

Only slave nodes execute this method.

Parameters
cachePool cache, containing butler
dataIdListList of data identifiers for the patch in different filters

Definition at line 432 of file multiBandDriver.py.

◆ writeMetadata()

def lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.writeMetadata (   self,
  dataRef 
)
We don't collect any metadata, so skip

Definition at line 469 of file multiBandDriver.py.

Member Data Documentation

◆ butler

lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.butler

Definition at line 115 of file multiBandDriver.py.

◆ coaddType

lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.coaddType

Definition at line 147 of file multiBandDriver.py.

◆ ConfigClass

lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.ConfigClass = MultiBandDriverConfig
static

Definition at line 97 of file multiBandDriver.py.

◆ deblenderOutput

lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.deblenderOutput

Definition at line 122 of file multiBandDriver.py.

◆ measurementInput

lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.measurementInput

Definition at line 121 of file multiBandDriver.py.

◆ reuse

lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.reuse

Definition at line 116 of file multiBandDriver.py.

◆ RunnerClass

lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask.RunnerClass = MultiBandDriverTaskRunner
static

Definition at line 99 of file multiBandDriver.py.


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