lsst.pipe.drivers gef6abdcebb+21119e6671
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.drivers.coaddDriver.CoaddDriverTask Class Reference
Inheritance diagram for lsst.pipe.drivers.coaddDriver.CoaddDriverTask:
lsst::ctrl::pool::parallel::BatchPoolTask lsst::ctrl::pool::parallel::BatchCmdLineTask

Public Member Functions

def __init__ (self, reuse=tuple(), **kwargs)
 
def __reduce__ (self)
 
def batchWallTime (cls, time, parsedCmd, numCores)
 Return walltime request for batch job. More...
 
def runDataRef (self, tractPatchRefList, butler, selectIdList=[])
 Determine which tracts are non-empty before processing. More...
 
def run (self, patchRefList, butler, selectDataList=[])
 Run stacking on a tract. More...
 
def readSelection (self, cache, selectId)
 Read Wcs of selected inputs. More...
 
def checkTract (self, cache, tractId, selectIdList)
 Check whether a tract has any overlapping inputs. More...
 
def warp (self, cache, patchId, selectDataList)
 Warp all images for a patch. More...
 
def coadd (self, cache, data)
 Construct coadd for a patch and measure. More...
 
def selectExposures (self, patchRef, selectDataList)
 Select exposures to operate upon, via the SelectImagesTask. 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

 reuse
 
 calexpType
 

Static Public Attributes

 ConfigClass = CoaddDriverConfig
 
 RunnerClass = CoaddDriverTaskRunner
 

Detailed Description

Definition at line 85 of file coaddDriver.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.drivers.coaddDriver.CoaddDriverTask.__init__ (   self,
  reuse = tuple(),
**  kwargs 
)

Definition at line 90 of file coaddDriver.py.

Member Function Documentation

◆ __reduce__()

def lsst.pipe.drivers.coaddDriver.CoaddDriverTask.__reduce__ (   self)
Pickler

Definition at line 103 of file coaddDriver.py.

◆ batchWallTime()

def lsst.pipe.drivers.coaddDriver.CoaddDriverTask.batchWallTime (   cls,
  time,
  parsedCmd,
  numCores 
)

Return walltime request for batch job.

Parameters
timeRequested time per iteration
parsedCmdResults of argument parsing
numCoresNumber of cores
Returns
float walltime request length

Definition at line 126 of file coaddDriver.py.

◆ checkTract()

def lsst.pipe.drivers.coaddDriver.CoaddDriverTask.checkTract (   self,
  cache,
  tractId,
  selectIdList 
)

Check whether a tract has any overlapping inputs.

    This method only runs on slave nodes.

    @param cache: Pool cache
    @param tractId: Data identifier for tract
    @param selectDataList: List of selection data
    @return whether tract has any overlapping inputs

Definition at line 224 of file coaddDriver.py.

◆ coadd()

def lsst.pipe.drivers.coaddDriver.CoaddDriverTask.coadd (   self,
  cache,
  data 
)

Construct coadd for a patch and measure.

    Only slave nodes execute this method.

    Because only one argument may be passed, it is expected to
    contain multiple elements, which are:

    @param patchRef: data reference for patch
    @param selectDataList: List of SelectStruct for inputs

Definition at line 270 of file coaddDriver.py.

◆ readSelection()

def lsst.pipe.drivers.coaddDriver.CoaddDriverTask.readSelection (   self,
  cache,
  selectId 
)

Read Wcs of selected inputs.

    This method only runs on slave nodes.
    This method is similar to SelectDataIdContainer.makeDataRefList,
    creating a Struct like a SelectStruct, except with a dataId instead
    of a dataRef (to ease MPI).

    @param cache: Pool cache
    @param selectId: Data identifier for selected input
    @return a SelectStruct with a dataId instead of dataRef

Definition at line 201 of file coaddDriver.py.

◆ run()

def lsst.pipe.drivers.coaddDriver.CoaddDriverTask.run (   self,
  patchRefList,
  butler,
  selectDataList = [] 
)

Run stacking on a tract.

    This method only runs on the master node.

    @param patchRefList: List of patch data references for tract
    @param butler: Data butler
    @param selectDataList: List of SelectStruct for inputs

Definition at line 174 of file coaddDriver.py.

◆ runDataRef()

def lsst.pipe.drivers.coaddDriver.CoaddDriverTask.runDataRef (   self,
  tractPatchRefList,
  butler,
  selectIdList = [] 
)

Determine which tracts are non-empty before processing.

    @param tractPatchRefList: List of tracts and patches to include in the coaddition
    @param butler: butler reference object
    @param selectIdList: List of data Ids (i.e. visit, ccd) to consider when making the coadd
    @return list of references to sel.runTract function evaluation for each tractPatchRefList member

Definition at line 139 of file coaddDriver.py.

◆ selectExposures()

def lsst.pipe.drivers.coaddDriver.CoaddDriverTask.selectExposures (   self,
  patchRef,
  selectDataList 
)

Select exposures to operate upon, via the SelectImagesTask.

    This is very similar to CoaddBaseTask.selectExposures, except we return
    a list of SelectStruct (same as the input), so we can plug the results into
    future uses of SelectImagesTask.

    @param patchRef data reference to a particular patch
    @param selectDataList list of references to specific data products (i.e. visit, ccd)
    @return filtered list of SelectStruct

Definition at line 336 of file coaddDriver.py.

◆ warp()

def lsst.pipe.drivers.coaddDriver.CoaddDriverTask.warp (   self,
  cache,
  patchId,
  selectDataList 
)

Warp all images for a patch.

    Only slave nodes execute this method.

    Because only one argument may be passed, it is expected to
    contain multiple elements, which are:

    @param patchRef: data reference for patch
    @param selectDataList: List of SelectStruct for inputs
    @return selectDataList with non-overlapping elements removed

Definition at line 252 of file coaddDriver.py.

◆ writeMetadata()

def lsst.pipe.drivers.coaddDriver.CoaddDriverTask.writeMetadata (   self,
  dataRef 
)

Definition at line 363 of file coaddDriver.py.

Member Data Documentation

◆ calexpType

lsst.pipe.drivers.coaddDriver.CoaddDriverTask.calexpType

Definition at line 99 of file coaddDriver.py.

◆ ConfigClass

lsst.pipe.drivers.coaddDriver.CoaddDriverTask.ConfigClass = CoaddDriverConfig
static

Definition at line 86 of file coaddDriver.py.

◆ reuse

lsst.pipe.drivers.coaddDriver.CoaddDriverTask.reuse

Definition at line 92 of file coaddDriver.py.

◆ RunnerClass

lsst.pipe.drivers.coaddDriver.CoaddDriverTask.RunnerClass = CoaddDriverTaskRunner
static

Definition at line 88 of file coaddDriver.py.


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