ForcedPhotCoaddTask#

class lsst.drp.tasks.forcedPhotCoadd.ForcedPhotCoaddTask(refSchema=None, initInputs=None, **kwds)#

A pipeline task for performing forced measurement on coadd images.

Parameters#

refSchemalsst.afw.table.Schema, optional: The schema of the reference catalog, passed to the constructor of the references subtask. Optional, but must be specified if initInputs is not; if both are specified, initInputs takes precedence.
initInputsdict: Dictionary that can contain a key inputSchema containing the schema. If present will override the value of refSchema.
**kwds: Keyword arguments are passed to the supertask constructor.

Attributes Summary

Methods Summary

`generateMeasCat`(dataId, exposure, refCat, ...)	Generate a measurement catalog.
`run`(measCat, exposure, refCat, refWcs[, ...])	Perform forced measurement on a single exposure.
`runQuantum`(butlerQC, inputRefs, outputRefs)	Do butler IO and transform to provide in memory objects for tasks `run` method.

Attributes Documentation

Methods Documentation

generateMeasCat(dataId, exposure, refCat, refCatInBand, refWcs, footprintData)#

Generate a measurement catalog.

dataIdlsst.daf.butler.DataCoordinate: Butler data ID for this image, with {tract, patch, band} keys.
exposurelsst.afw.image.exposure.Exposure: Exposure to generate the catalog for.
refCatlsst.afw.table.SourceCatalog: Catalog of shapes and positions at which to force photometry.
refCatInBandlsst.afw.table.SourceCatalog: Catalog of shapes and position in the band forced photometry is currently being performed
refWcslsst.afw.image.SkyWcs: Reference world coordinate system.
footprintDataScarletDataModel or lsst.afw.table.SourceCatalog: Either the scarlet data models or the deblended catalog containings footprints. If footprintData is None then the footprints contained in refCatInBand are used.

measCatlsst.afw.table.SourceCatalog: Catalog of forced sources to measure.
expIdint: Unique binary id associated with the input exposure

LookupError: Raised if a footprint with a given source id was in the reference catalog but not in the reference catalog in band (meaning there was some sort of mismatch in the two input catalogs)

run(measCat, exposure, refCat, refWcs, exposureId=None, apCorrMap=None)#

Perform forced measurement on a single exposure.

measCatlsst.afw.table.SourceCatalog: The measurement catalog, based on the sources listed in the reference catalog.
exposurelsst.afw.image.Exposure: The measurement image upon which to perform forced detection.
refCatlsst.afw.table.SourceCatalog: The reference catalog of sources to measure.
refWcslsst.afw.image.SkyWcs: The WCS for the references.
exposureIdint: Optional unique exposureId used for random seed in measurement task.
apCorrMapApCorrMap, optional: Aperture correction map to use for aperture corrections. If not provided, the map is read from the exposure.

result~`lsst.pipe.base.Struct`

Structure with fields:

measCat: Catalog of forced measurement results (lsst.afw.table.SourceCatalog).

runQuantum(butlerQC, inputRefs, outputRefs)#

Do butler IO and transform to provide in memory objects for tasks run method.

butlerQCQuantumContext: A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.
inputRefsInputQuantizedConnection: Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined input/prerequisite connections.
outputRefsOutputQuantizedConnection: Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined output connections.