ForcedPhotImageTask

ForcedPhotImageTask is the base class for command-line forced measurement drivers.

Python API summary

from lsst.meas.base.forcedPhotImage import ForcedPhotImageTask
classForcedPhotImageTask(butler=None, refSchema=None, initInputs=None, **kwds)

A base class for command-line forced measurement drivers...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(measCat, exposure, refCat, refWcs, exposureId=None)

Perform forced measurement on a single exposure...

methodrunDataRef(dataRef, psfCache=None)

Perform forced measurement on a single exposure...

See also

See the ForcedPhotImageTask 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

coaddName

Default
'deep'
Field type
str Field
coadd name: typically one of deep or goodSeeing

doApCorr

Default
True
Field type
bool Field
Run subtask to apply aperture corrections

exposure

Data type
lsst.pipe.base.config.InputDatasetConfig
Field type
ConfigField
Input exposure to perform photometry on.

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.