lsst.meas.base  19.0.0-9-g463f923
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask Class Reference
Inheritance diagram for lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask:

Public Member Functions

def getExposure (self, dataRef)
 
def makeIdFactory (self, dataRef)
 
def getExposureId (self, dataRef)
 
def fetchReferences (self, dataRef, exposure)
 
def attachFootprints (self, sources, refCat, exposure, refWcs, dataRef)
 

Static Public Attributes

 ConfigClass
 
 RunnerClass
 
 dataPrefix
 

Detailed Description

A command-line driver for performing forced measurement on coadd images.

Notes
-----
In addition to the run method, `ForcedPhotCcdTask` overrides several
methods of `ForcedPhotImageTask` to specialize it for coadd processing,
including `~ForcedPhotImageTask.makeIdFactory` and
`~ForcedPhotImageTask.fetchReferences`. None of these should be called
directly by the user, though it may be useful to override them further in
subclasses.

Definition at line 80 of file forcedPhotCoadd.py.

Member Function Documentation

◆ attachFootprints()

def lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.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 158 of file forcedPhotCoadd.py.

◆ fetchReferences()

def lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.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 133 of file forcedPhotCoadd.py.

◆ getExposure()

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

Definition at line 98 of file forcedPhotCoadd.py.

◆ getExposureId()

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

Definition at line 130 of file forcedPhotCoadd.py.

◆ makeIdFactory()

def lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.makeIdFactory (   self,
  dataRef 
)
Create an object that generates globally unique source IDs.

Source IDs are created based on a per-CCD ID and the ID of the CCD
itself.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Butler data reference. The "CoaddId_bits" and "CoaddId" datasets
    are accessed. The data ID must have tract and patch keys.

Definition at line 107 of file forcedPhotCoadd.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.ConfigClass
static

Definition at line 93 of file forcedPhotCoadd.py.

◆ dataPrefix

lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.dataPrefix
static

Definition at line 96 of file forcedPhotCoadd.py.

◆ RunnerClass

lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.RunnerClass
static

Definition at line 94 of file forcedPhotCoadd.py.


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