Classes
class	ForcedPhotCoaddRunner

class	ForcedPhotCoaddConnections

class	documentation

Functions
def	getExposureId (self, dataRef)

def	fetchReferences (self, dataRef, exposure)

def	attachFootprints (self, sources, refCat, exposure, refWcs, dataRef)

def	getExposure (self, dataRef)

def	writeOutput (self, dataRef, sources)

def	getSchemaCatalogs (self)

Variables
	removePatchOverlaps

	exposureIdInfo

Function Documentation

◆ attachFootprints()

def lsst.meas.base.forcedPhotCoadd.attachFootprints	(	self,
		sources,
		refCat,
		exposure,
		refWcs,
		dataRef
	)

Attach Footprints to source records.

For coadd forced photometry, we use the deblended "heavy"
`~lsst.afw.detection.Footprint`\ s from the single-band measurements
of the same band - because we've guaranteed that the peaks (and hence
child sources) will be consistent across all bands before we get to
measurement, this should yield reasonable deblending for most sources.
It's most likely limitation is that it will not provide good flux
upper limits for sources that were not detected in this band but were
blended with sources that were.

Definition at line 389 of file forcedPhotCoadd.py.

     def attachFootprints(self, sources, refCat, exposure, refWcs, dataRef):
         r"""Attach Footprints to source records.
  
         For coadd forced photometry, we use the deblended "heavy"
         `~lsst.afw.detection.Footprint`\ s from the single-band measurements
         of the same band - because we've guaranteed that the peaks (and hence
         child sources) will be consistent across all bands before we get to
         measurement, this should yield reasonable deblending for most sources.
         It's most likely limitation is that it will not provide good flux
         upper limits for sources that were not detected in this band but were
         blended with sources that were.
         """
         if self.config.footprintDatasetName is None:
             return self.measurement.attachTransformedFootprints(sources, refCat, exposure, refWcs)
  
         self.log.info("Loading deblended footprints for sources from %s, %s",
                       self.config.footprintDatasetName, dataRef.dataId)
         fpCat = dataRef.get("%sCoadd_%s" % (self.config.coaddName, self.config.footprintDatasetName),
                             immediate=True)
         for refRecord, srcRecord in zip(refCat, sources):
             fpRecord = fpCat.find(refRecord.getId())
             if fpRecord is None:
                 raise LookupError("Cannot find Footprint for source %s; please check that %sCoadd_%s "
                                   "IDs are compatible with reference source IDs" %
                                   (srcRecord.getId(), self.config.coaddName,
                                    self.config.footprintDatasetName))
             srcRecord.setFootprint(fpRecord.getFootprint())
  

◆ fetchReferences()

def lsst.meas.base.forcedPhotCoadd.fetchReferences	(	self,
		dataRef,
		exposure
	)

Return an iterable of reference sources which overlap the exposure.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Butler data reference corresponding to the image to be measured;
    should have tract, patch, and filter keys.

exposure : `lsst.afw.image.Exposure`
    Unused.

Notes
-----
All work is delegated to the references subtask; see
`CoaddSrcReferencesTask` for information about the default behavior.

Definition at line 364 of file forcedPhotCoadd.py.

     def fetchReferences(self, dataRef, exposure):
         """Return an iterable of reference sources which overlap the exposure.
  
         Parameters
         ----------
         dataRef : `lsst.daf.persistence.ButlerDataRef`
             Butler data reference corresponding to the image to be measured;
             should have tract, patch, and filter keys.
  
         exposure : `lsst.afw.image.Exposure`
             Unused.
  
         Notes
         -----
         All work is delegated to the references subtask; see
         `CoaddSrcReferencesTask` for information about the default behavior.
         """
         skyMap = dataRef.get(self.dataPrefix + "skyMap", immediate=True)
         tractInfo = skyMap[dataRef.dataId["tract"]]
         patch = tuple(int(v) for v in dataRef.dataId["patch"].split(","))
         patchInfo = tractInfo.getPatchInfo(patch)
         references = lsst.afw.table.SourceCatalog(self.references.schema)
         references.extend(self.references.fetchInPatches(dataRef, patchList=[patchInfo]))
         return references
  

◆ getExposure()

def lsst.meas.base.forcedPhotCoadd.getExposure	(	self,
		dataRef
	)

Read input exposure on which measurement will be performed.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Butler data reference.

Definition at line 417 of file forcedPhotCoadd.py.

     def getExposure(self, dataRef):
         """Read input exposure on which measurement will be performed.
  
         Parameters
         ----------
         dataRef : `lsst.daf.persistence.ButlerDataRef`
             Butler data reference.
         """
         if self.config.hasFakes:
             name = "fakes_" + self.config.coaddName + "Coadd_calexp"
         else:
             name = self.config.coaddName + "Coadd_calexp"
  
         return dataRef.get(name) if dataRef.datasetExists(name) else None
  

◆ getExposureId()

def lsst.meas.base.forcedPhotCoadd.getExposureId	(	self,
		dataRef
	)

Definition at line 361 of file forcedPhotCoadd.py.

     def getExposureId(self, dataRef):
         return int(dataRef.get(self.config.coaddName + "CoaddId"))
  

◆ getSchemaCatalogs()

def lsst.meas.base.forcedPhotCoadd.getSchemaCatalogs ( self )

The schema catalogs that will be used by this task.

Returns
-------
schemaCatalogs : `dict`
    Dictionary mapping dataset type to schema catalog.

Notes
-----
There is only one schema for each type of forced measurement. The
dataset type for this measurement is defined in the mapper.

Definition at line 445 of file forcedPhotCoadd.py.

     def getSchemaCatalogs(self):
         """The schema catalogs that will be used by this task.
  
         Returns
         -------
         schemaCatalogs : `dict`
             Dictionary mapping dataset type to schema catalog.
  
         Notes
         -----
         There is only one schema for each type of forced measurement. The
         dataset type for this measurement is defined in the mapper.
         """
         catalog = lsst.afw.table.SourceCatalog(self.measurement.schema)
         catalog.getTable().setMetadata(self.measurement.algMetadata)
         datasetType = self.dataPrefix + "forced_src"
         return {datasetType: catalog}
  

◆ writeOutput()

def lsst.meas.base.forcedPhotCoadd.writeOutput	(	self,
		dataRef,
		sources
	)

Write forced source table

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Butler data reference. The forced_src dataset (with
    self.dataPrefix prepended) is all that will be modified.
sources : `lsst.afw.table.SourceCatalog`
    Catalog of sources to save.

Definition at line 432 of file forcedPhotCoadd.py.

     def writeOutput(self, dataRef, sources):
         """Write forced source table
  
         Parameters
         ----------
         dataRef : `lsst.daf.persistence.ButlerDataRef`
             Butler data reference. The forced_src dataset (with
             self.dataPrefix prepended) is all that will be modified.
         sources : `lsst.afw.table.SourceCatalog`
             Catalog of sources to save.
         """
         dataRef.put(sources, self.dataPrefix + "forced_src", flags=lsst.afw.table.SOURCE_IO_NO_FOOTPRINTS)
  

Variable Documentation

◆ exposureIdInfo

lsst.meas.base.forcedPhotCoadd.exposureIdInfo

Initial value:

1 = ExposureIdInfo(int(dataRef.get(self.config.coaddName + "CoaddId")),

2 dataRef.get(self.config.coaddName + "CoaddId_bits"))

Definition at line 357 of file forcedPhotCoadd.py.

◆ removePatchOverlaps

lsst.meas.base.forcedPhotCoadd.removePatchOverlaps

Definition at line 153 of file forcedPhotCoadd.py.

Classes

Functions

Variables