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.

    def __init__(self, task, visitId, num=0):
        self.task = task
        self.coaddInputs = self.task.makeCoaddInputs()
        self.coaddInputs.visits.reserve(1)
        if num > 0:
            self.coaddInputs.ccds.reserve(num)
        self.visitRecord = self.coaddInputs.visits.addNew()
        self.visitRecord.setId(visitId)
 

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.

    def _setExposureInfoInRecord(self, exposure, record):
        """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.
        """
        info = exposure.getInfo()
        record.setPsf(info.getPsf())
        record.setWcs(info.getWcs())
        record.setPhotoCalib(info.getPhotoCalib())
        record.setApCorrMap(info.getApCorrMap())
        record.setValidPolygon(info.getValidPolygon())
        record.setVisitInfo(info.getVisitInfo())
        record.setBBox(exposure.getBBox())
        record.setTransmissionCurve(info.getTransmissionCurve())
 
 

◆ 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.

    def 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.
        """
        if nGoodPix == 0 and not self.task.config.saveEmptyCcds:
            return
        record = self.coaddInputs.ccds.addNew()
        record.setId(ccdId)
        record.setL(self.task.ccdVisitKey, self.visitRecord.getId())
        try:
            record.setI(self.task.ccdCcdKey, calExp.getDetector().getId())
        except Exception as e:
            self.task.log.warning("Error getting detector serial number in visit %d; using -1; error=%s",
                                  self.visitRecord.getId(), e)
            record.setI(self.task.ccdCcdKey, -1)
        record.setI(self.task.ccdGoodPixKey, nGoodPix)
        if calExp is not None:
            self._setExposureInfoInRecord(exposure=calExp, record=record)
            if self.task.config.saveCcdWeights:
                record.setD(self.task.ccdWeightKey, 1.0)  # No weighting or overlap when warping
            record.set(self.task.ccdFilterKey, calExp.getFilter().physicalLabel)
 

◆ 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.

    def 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.
        """
        self._setExposureInfoInRecord(exposure=coaddTempExp, record=self.visitRecord)
        if self.task.config.saveVisitGoodPix:
            self.visitRecord.setI(self.task.visitGoodPixKey, nGoodPix)
        coaddTempExp.getInfo().setCoaddInputs(self.coaddInputs)
        wcs = coaddTempExp.getWcs()
        if False:
            # This causes a test failure, pending fix in issue HSC-802
            coaddTempExp.setPsf(CoaddPsf(self.coaddInputs.ccds, wcs))
        apCorrMap = makeCoaddApCorrMap(self.coaddInputs.ccds, coaddTempExp.getBBox(afwImage.PARENT), wcs)
        coaddTempExp.getInfo().setApCorrMap(apCorrMap)
 

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:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/g14a832a312+9d12ad093c/python/lsst/pipe/tasks/coaddInputRecorder.py

Public Member Functions

Public Attributes

Protected Member Functions