ForcedPhotCoaddTask¶
ForcedPhotCoaddTask
performs forced measurement on a co-added image using as a reference catalog detections which were made on coadds in other bands.
Butler datasets¶
Input datasets¶
- A
Coadd_src
variant (e.g.deepCoadd_src
) - Used as the reference catalog.
This is not loaded directly from the provided
dataRef
; only the patch and tract are used, while the filter is set by the configuration of the references subtask. Seelsst.meas.base.references.CoaddSrcReferencesTask
. - A
Coadd_calexp
variant (e.g.deepCoadd_calexp
) - Used as the measurement image.
Note that this means that
lsst.pipe.tasks.multiBand.DetectCoaddSourcesTask
must have been run on the image previously.
Ouptut datasets¶
- A
Coadd_forced_src
variant (e.g.deepCoadd_forced_src
) - The resulting measurement catalog.
Python API summary¶
from lsst.meas.base.forcedPhotCoadd import ForcedPhotCoaddTask
-
class
(butler=None, refSchema=None, initInputs=None, **kwds)ForcedPhotCoaddTask
A command-line driver for performing forced measurement on coadd images
...
-
attribute
config
Access configuration fields and retargetable subtasks.
-
method
(measCat, exposure, refCat, refWcs, exposureId=None)run
Perform forced measurement on a single exposure
...
-
method
(dataRef, psfCache=None)runDataRef
Perform forced measurement on a single exposure
...
See also
See the ForcedPhotCoaddTask
API reference for complete details.
Retargetable subtasks¶
applyApCorr¶
- Default
lsst.meas.base.applyApCorr.ApplyApCorrTask
- Field type
ConfigurableField
Subtask to apply aperture corrections
catalogCalculation¶
- Default
lsst.meas.base.catalogCalculation.CatalogCalculationTask
- Field type
ConfigurableField
Subtask to run catalogCalculation plugins on catalog
measurement¶
- Default
lsst.meas.base.forcedMeasurement.ForcedMeasurementTask
- Field type
ConfigurableField
subtask to do forced measurement
references¶
- Default
lsst.meas.base.references.MultiBandReferencesTask
- Field type
ConfigurableField
subtask to retrieve reference source catalog
Configuration fields¶
exposure¶
- Data type
lsst.pipe.base.config.InputDatasetConfig
- Field type
ConfigField
Input exposure to perform photometry on.
footprintDatasetName¶
Dataset (without coadd prefix) that should be used to obtain (Heavy)Footprints for sources. Must have IDs that match those of the reference catalog.If None, Footprints will be generated by transforming the reference Footprints.
inputSchema¶
- Data type
lsst.pipe.base.config.InitInputDatasetConfig
- Field type
ConfigField
Schema for the input measurement catalogs.
measCat¶
- Data type
lsst.pipe.base.config.OutputDatasetConfig
- Field type
ConfigField
Output forced photometry catalog.
outputSchema¶
- Data type
lsst.pipe.base.config.InitOutputDatasetConfig
- Field type
ConfigField
Schema for the output forced measurement catalogs.
quantum¶
- Data type
lsst.pipe.base.config.QuantumConfig
- Field type
ConfigField
configuration for PipelineTask quantum
refCat¶
- Data type
lsst.pipe.base.config.InputDatasetConfig
- Field type
ConfigField
Catalog of shapes and positions at which to force photometry.
refWcs¶
- Data type
lsst.pipe.base.config.InputDatasetConfig
- Field type
ConfigField
Reference world coordinate system.