lsst.meas.base  14.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask Class Reference

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

Inheritance diagram for lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask:

Public Member Functions

def getExposure
 
def makeIdFactory
 
def getExposureId
 
def fetchReferences
 
def attachFootprints
 

Static Public Attributes

 ConfigClass = ForcedPhotCoaddConfig
 
 RunnerClass = lsst.pipe.base.ButlerInitializedTaskRunner
 
string dataPrefix = "deepCoadd_"
 

Detailed Description

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

This task is a subclass of ForcedPhotImageTask which is specifically for doing forced measurement on a coadd, using as a reference catalog detections which were made on overlapping coadds (i.e. in other bands).

The run method (inherited from ForcedPhotImageTask) takes a lsst.daf.persistence.ButlerDataRef argument that corresponds to a coadd image. This is used to provide all the inputs and outputs for the task:

In addition to the run method, ForcedPhotCcdTask overrides several methods of ForcedPhotImageTask to specialize it for coadd processing, including makeIdFactory() and 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 69 of file forcedPhotCoadd.py.

Member Function Documentation

def lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.attachFootprints (   self,
  sources,
  refCat,
  exposure,
  refWcs,
  dataRef 
)
For coadd forced photometry, we use the deblended HeavyFootprints 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 139 of file forcedPhotCoadd.py.

def lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.fetchReferences (   self,
  dataRef,
  exposure 
)
Return an iterable of reference sources which overlap the exposure

@param dataRef       Data reference from butler corresponding to the image to be measured;
             should have tract, patch, and filter keys.
@param exposure      lsst.afw.image.Exposure to be measured (not used by this implementation)

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

Definition at line 121 of file forcedPhotCoadd.py.

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

Definition at line 99 of file forcedPhotCoadd.py.

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

Definition at line 118 of file forcedPhotCoadd.py.

def lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.makeIdFactory (   self,
  dataRef 
)
Create an object that generates globally unique source IDs from per-CCD IDs and the CCD ID.

@param dataRef       Data reference from butler.  The "CoaddId_bits" and "CoaddId"
             datasets are accessed.  The data ID must have tract and patch keys.

Definition at line 103 of file forcedPhotCoadd.py.

Member Data Documentation

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

Definition at line 94 of file forcedPhotCoadd.py.

string lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.dataPrefix = "deepCoadd_"
static

Definition at line 97 of file forcedPhotCoadd.py.

lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddTask.RunnerClass = lsst.pipe.base.ButlerInitializedTaskRunner
static

Definition at line 95 of file forcedPhotCoadd.py.


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