lsst.pipe.tasks g95921f966b+d83dc58ecd
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
lsst.pipe.tasks.coaddInputRecorder.CoaddTempExpInputRecorder Class Reference

Public Member Functions

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

Public Attributes

 task
 
 coaddInputs
 
 visitRecord
 

Protected Member Functions

 _setExposureInfoInRecord (self, exposure, record)
 

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().

Parameters
----------
task : `lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderTask`
    The CoaddInputRecorderTask that is utilising us.
visitId : `int`
    Identifier (integer) for the visit.
num : `int`
    Number of CCDs for this visit that overlap this patch (for reserving memory).

Definition at line 56 of file coaddInputRecorder.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 73 of file coaddInputRecorder.py.

Member Function Documentation

◆ _setExposureInfoInRecord()

lsst.pipe.tasks.coaddInputRecorder.CoaddTempExpInputRecorder._setExposureInfoInRecord ( self,
exposure,
record )
protected
Set exposure info and bbox in an ExposureTable record.

Parameters
----------
exposure : `lsst.afw.image.ExposureF`
    Exposure whose info is to be recorded.
record : `Unknown`
    Record of an ExposureTable to set.

Definition at line 141 of file coaddInputRecorder.py.

◆ addCalExp()

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

Parameters
----------
calExp : `lsst.afw.image.Exposure`
    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.
ccdId : `int`
    A unique numeric ID for the Exposure.
nGoodPix : `int`
    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 82 of file coaddInputRecorder.py.

◆ finish()

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

Parameters
----------
coaddTempExp : `lsst.afw.image.Exposure`
    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.
nGoodPix : `int`
    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 75 of file coaddInputRecorder.py.

◆ task

lsst.pipe.tasks.coaddInputRecorder.CoaddTempExpInputRecorder.task

Definition at line 74 of file coaddInputRecorder.py.

◆ visitRecord

lsst.pipe.tasks.coaddInputRecorder.CoaddTempExpInputRecorder.visitRecord

Definition at line 79 of file coaddInputRecorder.py.


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