lsst.meas.base  13.0-26-g0f127ff+5
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.forcedPhotCcd.ForcedPhotCcdTask Class Reference

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

Inheritance diagram for lsst.meas.base.forcedPhotCcd.ForcedPhotCcdTask:
lsst.meas.base.forcedPhotImage.ForcedPhotImageTask

Public Member Functions

def makeIdFactory (self, dataRef)
 
def getExposureId (self, dataRef)
 
def fetchReferences (self, dataRef, exposure)
 
def getExposure (self, dataRef)
 
- Public Member Functions inherited from lsst.meas.base.forcedPhotImage.ForcedPhotImageTask
def __init__ (self, butler=None, refSchema=None, kwds)
 
def run (self, dataRef)
 Measure a single exposure using forced detection for a reference catalog. More...
 
def makeIdFactory (self, dataRef)
 Hook for derived classes to define how to make an IdFactory for forced sources. More...
 
def getExposureId (self, dataRef)
 
def fetchReferences (self, dataRef, exposure)
 Hook for derived classes to define how to get references objects. More...
 
def attachFootprints (self, sources, refCat, exposure, refWcs, dataRef)
 Hook for derived classes to define how to attach Footprints to blank sources prior to measurement. More...
 
def getExposure (self, dataRef)
 Read input exposure on which to perform the measurements. 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 = ForcedPhotCcdConfig
 
 RunnerClass = lsst.pipe.base.ButlerInitializedTaskRunner
 
string dataPrefix = ""
 
- Static Public Attributes inherited from lsst.meas.base.forcedPhotImage.ForcedPhotImageTask
 ConfigClass = ForcedPhotImageConfig
 

Detailed Description

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

This task is a subclass of ForcedPhotImageTask which is specifically for doing forced measurement on a single CCD exposure, using as a reference catalog the detections which were made on overlapping coadds.

The run method (inherited from ForcedPhotImageTask) takes a lsst.daf.persistence.ButlerDataRef argument that corresponds to a single CCD. This should contain the data ID keys that correspond to the "forced_src" dataset (the output dataset for ForcedPhotCcdTask), which are typically all those used to specify the "calexp" dataset (e.g. visit, raft, sensor for LSST data) as well as a coadd tract. The tract is used to look up the appropriate coadd measurement catalogs to use as references (e.g. deepCoadd_src; see CoaddSrcReferencesTask for more information). While the tract must be given as part of the dataRef, the patches are determined automatically from the bounding box and WCS of the calexp to be measured, and the filter used to fetch references is set via config (BaseReferencesConfig.filter).

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

Definition at line 148 of file forcedPhotCcd.py.

Member Function Documentation

◆ fetchReferences()

def lsst.meas.base.forcedPhotCcd.ForcedPhotCcdTask.fetchReferences (   self,
  dataRef,
  exposure 
)
Return a SourceCatalog of sources which overlap the exposure.

The returned catalog is sorted by ID and guarantees that all included children have their
parent included and that all Footprints are valid.

@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 (used only to obtain a Wcs and
             bounding box).

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

Definition at line 191 of file forcedPhotCcd.py.

◆ getExposure()

def lsst.meas.base.forcedPhotCcd.ForcedPhotCcdTask.getExposure (   self,
  dataRef 
)
Read input exposure to measure

@param dataRef       Data reference from butler.  Only the 'calexp' dataset is used,
             unless config.doApplyUberCal is true, in which case the corresponding
             meas_mosaic outputs are used as well.

Definition at line 222 of file forcedPhotCcd.py.

◆ getExposureId()

def lsst.meas.base.forcedPhotCcd.ForcedPhotCcdTask.getExposureId (   self,
  dataRef 
)

Definition at line 188 of file forcedPhotCcd.py.

◆ makeIdFactory()

def lsst.meas.base.forcedPhotCcd.ForcedPhotCcdTask.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 "ccdExposureId_bits" and "ccdExposureId"
             datasets are accessed.  The data ID must have the keys that correspond
             to ccdExposureId, which is generally the same that correspond to "calexp"
             (e.g. visit, raft, sensor for LSST data).

Definition at line 176 of file forcedPhotCcd.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.base.forcedPhotCcd.ForcedPhotCcdTask.ConfigClass = ForcedPhotCcdConfig
static

Definition at line 171 of file forcedPhotCcd.py.

◆ dataPrefix

string lsst.meas.base.forcedPhotCcd.ForcedPhotCcdTask.dataPrefix = ""
static

Definition at line 174 of file forcedPhotCcd.py.

◆ RunnerClass

lsst.meas.base.forcedPhotCcd.ForcedPhotCcdTask.RunnerClass = lsst.pipe.base.ButlerInitializedTaskRunner
static

Definition at line 172 of file forcedPhotCcd.py.


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