ForcedPhotCcdTask

ForcedPhotCcdTask performs forced measurement on an image from a CCD.

Python API summary

from lsst.meas.base.forcedPhotCcd import ForcedPhotCcdTask
classForcedPhotCcdTask(refSchema=None, initInputs=None, **kwargs)

A pipeline task 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...

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

Configuration fields

coaddName

Default
'deep'
Field type

str Field

coadd name: typically one of deep or goodSeeing

connections

Data type

lsst.pipe.base.config.ForcedPhotCcdConfigConnections

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

doApplySkyCorr

Default
False
Field type

bool Field

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

ConfigField

Configuration for how to generate catalog IDs from data IDs.

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).

refCatDecColumn

Default
'dec'
Field type

str Field

Name of the column that provides the declination (in floating-point degrees) from the refCat connection. Ignored if refCatStorageClass=’SourceCatalog’.

refCatIdColumn

Default
'diaObjectId'
Field type

str Field

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

Default
'ra'
Field type

str Field

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

Default
True
Field type

bool Field

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

useVisitSummary

Default
True
Field type

bool Field

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.