lsst.meas.base  14.0-23-g2010ef9+3
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:
lsst.meas.base.forcedPhotImage.ForcedPhotImageTask

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)
 
def run (self, dataRef, psfCache=None)
 Measure a single exposure using forced detection for a reference catalog. More...
 
def writeOutput (self, dataRef, sources)
 Write forced source table. More...
 
def getSchemaCatalogs (self)
 Get a dict of Schema catalogs that will be used by this Task. More...
 

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 82 of file forcedPhotCoadd.py.

Member Function Documentation

◆ attachFootprints()

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 152 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

@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 134 of file forcedPhotCoadd.py.

◆ getExposure()

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

Definition at line 112 of file forcedPhotCoadd.py.

◆ getExposureId()

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

Definition at line 131 of file forcedPhotCoadd.py.

◆ getSchemaCatalogs()

def lsst.meas.base.forcedPhotImage.ForcedPhotImageTask.getSchemaCatalogs (   self)
inherited

Get a dict of Schema catalogs that will be used by this Task.

In the case of forced taks, 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 214 of file forcedPhotImage.py.

◆ makeIdFactory()

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 116 of file forcedPhotCoadd.py.

◆ run()

def lsst.meas.base.forcedPhotImage.ForcedPhotImageTask.run (   self,
  dataRef,
  psfCache = None 
)
inherited

Measure a single exposure using forced detection for a reference catalog.

Parameters
[in]dataRefAn lsst.daf.persistence.ButlerDataRef. It is passed to the references subtask to obtain the reference WCS, the getExposure() method (implemented by derived classes) to read the measurement image, and the fetchReferences() method (implemented by derived classes) to get the exposure and load the reference catalog (see the CoaddSrcReferencesTask for more information). Sources are generated with generateMeasCat() in the measurement subtask. These are passed to measurement's run method which fills the source catalog with the forced measurement results. The sources are then passed to the writeOutputs() method (implemented by derived classes) which writes the outputs. See derived class documentation for which datasets and data ID keys are used.
[in]psfCacheSize of PSF cache, or None. The size of the PSF cache can have a significant effect upon the runtime for complicated PSF models.

Definition at line 123 of file forcedPhotImage.py.

◆ writeOutput()

def lsst.meas.base.forcedPhotImage.ForcedPhotImageTask.writeOutput (   self,
  dataRef,
  sources 
)
inherited

Write forced source table.

Parameters
dataRefData reference from butler; the forced_src dataset (with self.dataPrefix included) is all that will be modified.
sourcesSourceCatalog to save

Definition at line 205 of file forcedPhotImage.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 107 of file forcedPhotCoadd.py.

◆ dataPrefix

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

Definition at line 110 of file forcedPhotCoadd.py.

◆ RunnerClass

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

Definition at line 108 of file forcedPhotCoadd.py.


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