ForcedPhotCcdTask#

class lsst.meas.base.ForcedPhotCcdTask(*args, **kwargs)#

A pipeline task for performing forced measurement on CCD 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.
**kwargs: Keyword arguments are passed to the supertask constructor.

Deprecated since version v29.0: This task is replaced by lsst.pipe.tasks.ForcedPhotCcdTask. This task will be removed after v30.

Attributes Summary

Methods Summary

`attachFootprints`(sources, refCat, exposure, ...)	Attach footprints to blank sources prior to measurements.
`generateMeasCat`(dataId, exposure, refCat, refWcs)	Generate a measurement catalog.
`prepareCalibratedExposure`(exposure[, ...])	Prepare a calibrated exposure and apply external calibrations and sky corrections if so configured.
`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

attachFootprints(sources, refCat, exposure, refWcs)#: Attach footprints to blank sources prior to measurements.

Notes#

Footprint objects for forced photometry must be in the pixel coordinate system of the image being measured, while the actual detections may start out in a different coordinate system.

Subclasses of this class may implement this method to define how those Footprint objects should be generated.

This default implementation transforms depends on the footprintSource configuration parameter.

generateMeasCat(dataId, exposure, refCat, refWcs)#

Generate a measurement catalog.

dataIdlsst.daf.butler.DataCoordinate: Butler data ID for this image, with {visit, detector} 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.
refWcslsst.afw.image.SkyWcs: Reference world coordinate system. This parameter is not currently used.

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

prepareCalibratedExposure(exposure, skyCorr=None, visitSummary=None)#

Prepare a calibrated exposure and apply external calibrations and sky corrections if so configured.

exposurelsst.afw.image.exposure.Exposure: Input exposure to adjust calibrations.
skyCorrlsst.afw.math.backgroundList, optional: Sky correction frame to apply if doApplySkyCorr=True.
visitSummarylsst.afw.table.ExposureCatalog, optional: Exposure catalog with update calibrations; any not-None calibration objects attached will be used. These are applied first and may be overridden by other arguments.

exposurelsst.afw.image.exposure.Exposure: Exposure with adjusted calibrations.

run(measCat, exposure, refCat, refWcs, exposureId=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.

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.