ForcedPhotCcdTask¶
ForcedPhotCcdTask
performs forced measurement on an image from a CCD.
Python API summary¶
from lsst.meas.base.forcedPhotCcd import ForcedPhotCcdTask
-
class
ForcedPhotCcdTask
(refSchema=None, initInputs=None, **kwargs) A pipeline task 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
...
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
Configuration fields¶
coaddName¶
coadd name: typically one of deep or goodSeeing
connections¶
- Data type
lsst.pipe.base.config.ForcedPhotCcdConfigConnections
- Field type
Configurations describing the connections of the PipelineTask to datatypes
doApCorr¶
Run subtask to apply aperture corrections
doApplySkyCorr¶
Apply sky correction?
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.
idGenerator¶
- Data type
lsst.meas.base._id_generator.DetectorVisitIdGeneratorConfig
- Field type
Configuration for how to generate catalog IDs from data IDs.
includePhotoCalibVar¶
Add photometric calibration variance to warp variance plane?
psfFootprintScaling¶
Scaling factor to apply to the PSF shape when footprintSource=’psf’ (ignored otherwise).
refCatDecColumn¶
Name of the column that provides the declination (in floating-point degrees) from the refCat connection. Ignored if refCatStorageClass=’SourceCatalog’.
refCatIdColumn¶
Name of the column that provides the object ID from the refCat connection. measurement.copyColumns[‘id’] must be set to this value as well.Ignored if refCatStorageClass=’SourceCatalog’.
refCatRaColumn¶
Name of the column that provides the right ascension (in floating-point degrees) from the refCat connection. Ignored if refCatStorageClass=’SourceCatalog’.
refCatStorageClass¶
- Default
'SourceCatalog'
- Field type
str
ChoiceField
(optional)- Choices
'SourceCatalog'
Read an lsst.afw.table.SourceCatalog.
'DataFrame'
Read a pandas.DataFrame.
'ArrowAstropy'
Read an astropy.table.Table saved to Parquet.
None
Field is optional
The butler storage class for the refCat connection. If set to something other than ‘SourceCatalog’, the ‘inputSchema’ connection will be ignored.
saveLogOutput¶
Flag to enable/disable saving of log output for a task, enabled by default.
useVisitSummary¶
Use updated WCS, PhotoCalib, ApCorr, and PSF from visit summary? This should be False if and only if the input image already has the best-available calibration objects attached.