lsst.pipe.tasks g38dd528b55+8ad9029b72
Public Member Functions | Public Attributes | List of all members
lsst.pipe.tasks.coaddInputRecorder.CoaddTempExpInputRecorder Class Reference

Public Member Functions

def __init__ (self, task, visitId, num=0)
 
def addCalExp (self, calExp, ccdId, nGoodPix)
 
def finish (self, coaddTempExp, nGoodPix=None)
 

Public Attributes

 task
 
 coaddInputs
 
 visitRecord
 

Detailed Description

A helper class for CoaddInputRecorderTask, managing the CoaddInputs object for that single
CoaddTempExp.  This will contain a single 'visit' record for the CoaddTempExp and a number of 'ccd'
records.

Should generally be created by calling CoaddInputRecorderTask.makeCoaddTempExp().

Definition at line 63 of file coaddInputRecorder.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.coaddInputRecorder.CoaddTempExpInputRecorder.__init__ (   self,
  task,
  visitId,
  num = 0 
)
Constructor

@param task  The CoaddInputRecorderTask that is utilising us
@param visitId  Identifier (integer) for the visit
@param num  Number of CCDs for this visit that overlap this
                patch (for reserving memory)

Definition at line 71 of file coaddInputRecorder.py.

Member Function Documentation

◆ addCalExp()

def lsst.pipe.tasks.coaddInputRecorder.CoaddTempExpInputRecorder.addCalExp (   self,
  calExp,
  ccdId,
  nGoodPix 
)
Add a 'ccd' record for a calexp just added to the CoaddTempExp

@param[in] calExp   Calibrated exposure just added to the CoaddTempExp, or None in case of
                    failures that should nonetheless be tracked.  Should be the original
                    calexp, in that it should contain the original Psf and Wcs, not the
                    warped and/or matched ones.
@param[in] ccdId    A unique numeric ID for the Exposure.
@param[in] nGoodPix Number of good pixels this image will contribute to the CoaddTempExp.
                    If saveEmptyCcds is not set and this value is zero, no record will be
                    added.

Definition at line 87 of file coaddInputRecorder.py.

◆ finish()

def lsst.pipe.tasks.coaddInputRecorder.CoaddTempExpInputRecorder.finish (   self,
  coaddTempExp,
  nGoodPix = None 
)
Finish creating the CoaddInputs for a CoaddTempExp.

@param[in,out] coaddTempExp   Exposure object from which to obtain the PSF, WCS, and bounding
                              box for the entry in the 'visits' table.  On return, the completed
                              CoaddInputs object will be attached to it.
@param[in]     nGoodPix       Total number of good pixels in the CoaddTempExp; ignored unless
                              saveVisitGoodPix is true.

Definition at line 117 of file coaddInputRecorder.py.

Member Data Documentation

◆ coaddInputs

lsst.pipe.tasks.coaddInputRecorder.CoaddTempExpInputRecorder.coaddInputs

Definition at line 80 of file coaddInputRecorder.py.

◆ task

lsst.pipe.tasks.coaddInputRecorder.CoaddTempExpInputRecorder.task

Definition at line 79 of file coaddInputRecorder.py.

◆ visitRecord

lsst.pipe.tasks.coaddInputRecorder.CoaddTempExpInputRecorder.visitRecord

Definition at line 84 of file coaddInputRecorder.py.


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