PropagateSourceFlagsTask

PropagateSourceFlagsTask is a task to associate flags from source catalogs (e.g. which objects were used for astrometry, photometry, and psf fitting) with coadd object catalogs. Flagged sources may come from a mix of two different types of source catalogs. The sourceTable_visit catalogs from CalibrateTask contain flags for the first round of astrometry/photometry/psf fits. The finalized_src_table catalogs from FinalizeCalibrationTask contain flags from the second round of psf fitting. Which table should be used for the source of which flags depends on the configuration of coadds (in particular makeWarpConfig.doApplyFinalizedPsf).

Python API summary

from lsst.pipe.tasks.propagateSourceFlags import PropagateSourceFlagsTask
classPropagateSourceFlagsTask(schema, **kwargs)

Task to propagate source flags to coadd objects...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(coadd_object_cat, ccd_inputs, source_table_handle_dict=None, finalized_source_table_handle_dict=None)

Propagate flags from single-frame sources to coadd objects...

See also

See the PropagateSourceFlagsTask API reference for complete details.

Retargetable subtasks

No subtasks.

Configuration fields

finalized_source_flags

Default
{}
Field type
DictField
Key type
str
Value type
float
Finalized source flags to propagate, with the threshold of relative occurrence (valid range: [0-1]). Coadd object will have flag set if fraction of input visits in which it is flagged is greater than the threshold.

finalized_x_column

Default
'slot_Centroid_x'
Field type
str Field
Name of column with source x position (finalized_src_table).

finalized_y_column

Default
'slot_Centroid_y'
Field type
str Field
Name of column with source y position (finalized_src_table).

match_radius

Default
0.2
Field type
float Field
Source matching radius (arcsec)

source_flags

Default
{'calib_psf_candidate': 0.2, 'calib_psf_used': 0.2, 'calib_psf_reserved': 0.2, 'calib_astrometry_used': 0.2, 'calib_photometry_used': 0.2, 'calib_photometry_reserved': 0.2}
Field type
DictField
Key type
str
Value type
float
Source flags to propagate, with the threshold of relative occurrence (valid range: [0-1]). Coadd object will have flag set if fraction of input visits in which it is flagged is greater than the threshold.

x_column

Default
'x'
Field type
str Field
Name of column with source x position (sourceTable_visit).

y_column

Default
'y'
Field type
str Field
Name of column with source y position (sourceTable_visit).