PropagateSourceFlagsConfig#

class lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig(*args, **kw)#

Bases: Config

Configuration for propagating source flags to coadd objects.

Attributes Summary

`finalized_source_flags`	Finalized source flags to propagate, with the threshold of relative occurrence (valid range: [0-1]).
`finalized_x_column`	Name of column with source x position (finalized_src_table).
`finalized_y_column`	Name of column with source y position (finalized_src_table).
`match_radius`	Source matching radius (arcsec) (`float`, default `0.2`)
`source_flags`	Source flags to propagate, with the threshold of relative occurrence (valid range: [0-1]).
`x_column`	Name of column with source x position (sourceTable_visit).
`y_column`	Name of column with source y position (sourceTable_visit).

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

finalized_source_flags#: 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. (Dict, default {'calib_psf_candidate': 0.2, 'calib_psf_used': 0.2, 'calib_psf_reserved': 0.2})

finalized_x_column#: Name of column with source x position (finalized_src_table). (str, default 'slot_Centroid_x')

finalized_y_column#: Name of column with source y position (finalized_src_table). (str, default 'slot_Centroid_y')

match_radius#: Source matching radius (arcsec) (float, default 0.2)

source_flags#: 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. (Dict, default {'calib_astrometry_used': 0.2, 'calib_photometry_used': 0.2, 'calib_photometry_reserved': 0.2})

x_column#: Name of column with source x position (sourceTable_visit). (str, default 'x')

y_column#: Name of column with source y position (sourceTable_visit). (str, default 'y')

Methods Documentation

validate()#

Validate the Config, raising an exception if invalid.

Raises#

lsst.pex.config.FieldValidationError: Raised if verification fails.

Notes#

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.