ForcedPhotCcdTask¶
ForcedPhotCcdTask
performs forced measurement on an image from a CCD.
Python API summary¶
from lsst.meas.base.forcedPhotCcd import ForcedPhotCcdTask
-
class
ForcedPhotCcdTask
(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.
-
method
run
(measCat, exposure, refCat, refWcs, exposureId=None) Perform forced measurement on a single exposure
...
-
method
runDataRef
(dataRef, psfCache=None) Perform forced measurement on a single exposure
...
See also
See the ForcedPhotCcdTask
API reference for complete details.
Retargetable subtasks¶
applyApCorr¶
- Default
- Field type
Subtask to apply aperture corrections
catalogCalculation¶
Subtask to run catalogCalculation plugins on catalog
measurement¶
- Default
- Field type
subtask to do forced measurement
references¶
- Default
- Field type
subtask to retrieve reference source catalog
Configuration fields¶
coaddName¶
coadd name: typically one of deep or goodSeeing
connections¶
- Data type
lsst.pipe.base.config.Connections
- Field type
Configurations describing the connections of the PipelineTask to datatypes
doApCorr¶
Run subtask to apply aperture corrections
doApplyExternalPhotoCalib¶
Whether to apply external photometric calibration via an lsst.afw.image.PhotoCalib
object. Uses the externalPhotoCalibName
field to determine which calibration to load.
doApplyExternalSkyWcs¶
Whether to apply external astrometric calibration via an lsst.afw.geom.SkyWcs
object. Uses externalSkyWcsName
field to determine which calibration to load.
doApplyFinalizedPsf¶
Whether to apply finalized psf models and aperture correction map.
doApplySkyCorr¶
Apply sky correction?
doApplyUberCal¶
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¶
Add photometric calibration variance to warp variance plane?
psfFootprintScaling¶
Scaling factor to apply to the PSF shape when footprintSource=’psf’ (ignored otherwise).
saveLogOutput¶
Flag to enable/disable saving of log output for a task, enabled by default.
saveMetadata¶
Flag to enable/disable metadata saving for a task, enabled by default.
useGlobalExternalPhotoCalib¶
When using doApplyExternalPhotoCalib, use ‘global’ calibrations that are not run per-tract. When False, use per-tract photometric calibration files.
useGlobalExternalSkyWcs¶
When using doApplyExternalSkyWcs, use ‘global’ calibrations that are not run per-tract. When False, use per-tract wcs files.