ForcedPhotCcdTask

ForcedPhotCcdTask performs forced measurement on an image from a CCD.

Python API summary

from lsst.meas.base.forcedPhotCcd import ForcedPhotCcdTask

classForcedPhotCcdTask(butler=None, refSchema=None, initInputs=None, **kwds)

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

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 ForcedPhotCcdTask 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

connections

Data type

lsst.pipe.base.config.Connections

Field type

ConfigField

Configurations describing the connections of the PipelineTask to datatypes

doApCorr

Default

True

Field type

bool Field

Run subtask to apply aperture corrections

doApplyExternalPhotoCalib

Default

False

Field type

bool Field

Whether to apply external photometric calibration via an lsst.afw.image.PhotoCalib object. Uses the externalPhotoCalibName field to determine which calibration to load.

doApplyExternalSkyWcs

Default

False

Field type

bool Field

Whether to apply external astrometric calibration via an lsst.afw.geom.SkyWcs object. Uses externalSkyWcsName field to determine which calibration to load.

doApplySkyCorr

Default

False

Field type

bool Field

Apply sky correction?

doApplyUberCal

Default

False

Field type

bool Field

Apply meas_mosaic ubercal results to input calexps? Deprecated: Deprecated by DM-23352; use doApplyExternalPhotoCalib and doApplyExternalSkyWcs instead

externalPhotoCalibName

Default

'jointcal'

Field type

str ChoiceField (optional)

Choices

'jointcal'

Use jointcal_photoCalib

'fgcm'

Use fgcm_photoCalib

'fgcm_tract'

Use fgcm_tract_photoCalib

None

Field is optional

Type of external PhotoCalib if doApplyExternalPhotoCalib is True. Unused for Gen3 middleware.

externalSkyWcsName

Default

'jointcal'

Field type

str ChoiceField (optional)

Choices

'jointcal'

Use jointcal_wcs

None

Field is optional

Type of external SkyWcs if doApplyExternalSkyWcs is True. Unused for Gen3 middleware.

footprintSource

Default

'transformed'

Field type

str ChoiceField (optional)

Choices

'transformed'

Transform footprints from the reference catalog (downgrades HeavyFootprints).

'psf'

Use the scaled shape of the PSF at the position of each source (does not generate HeavyFootprints).

None

Field is optional

Where to obtain footprints to install in the measurement catalog, prior to measurement.

includePhotoCalibVar

Default

False

Field type

bool Field

Add photometric calibration variance to warp variance plane?

psfFootprintScaling

Default

3.0

Field type

float Field

Scaling factor to apply to the PSF shape when footprintSource=’psf’ (ignored otherwise).

saveLogOutput

Default

True

Field type

bool Field

Flag to enable/disable saving of log output for a task, enabled by default.

saveMetadata

Default

True

Field type

bool Field

Flag to enable/disable metadata saving for a task, enabled by default.