lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig:

Public Member Functions
	validate (self)

Static Public Attributes
	source_flags
	finalized_source_flags
	x_column
	y_column
	finalized_x_column
	finalized_y_column
	match_radius

Detailed Description

Configuration for propagating source flags to coadd objects.

Definition at line 32 of file propagateSourceFlags.py.

Member Function Documentation

validate()

lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig.validate

(

self

)

Definition at line 85 of file propagateSourceFlags.py.

    def validate(self):
        super().validate()
 
        if set(self.source_flags).intersection(set(self.finalized_source_flags)):
            source_flags = self.source_flags.keys()
            finalized_source_flags = self.finalized_source_flags.keys()
            raise ValueError(f"The set of source_flags {source_flags} must not overlap "
                             f"with the finalized_source_flags {finalized_source_flags}")
 
 

Member Data Documentation

finalized_source_flags

lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig.finalized_source_flags

static

Initial value:

=  pexConfig.DictField(
        keytype=str,
        itemtype=float,
        default={
            "calib_psf_candidate": 0.2,
            "calib_psf_used": 0.2,
            "calib_psf_reserved": 0.2
        },
        doc=("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."),
    )

Definition at line 46 of file propagateSourceFlags.py.

finalized_x_column

lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig.finalized_x_column

static

Initial value:

=  pexConfig.Field(
        doc="Name of column with source x position (finalized_src_table).",
        dtype=str,
        default="slot_Centroid_x",
    )

Definition at line 69 of file propagateSourceFlags.py.

finalized_y_column

lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig.finalized_y_column

static

Initial value:

=  pexConfig.Field(
        doc="Name of column with source y position (finalized_src_table).",
        dtype=str,
        default="slot_Centroid_y",
    )

Definition at line 74 of file propagateSourceFlags.py.

match_radius

lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig.match_radius

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        default=0.2,
        doc="Source matching radius (arcsec)"
    )

Definition at line 79 of file propagateSourceFlags.py.

source_flags

lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig.source_flags

static

Initial value:

=  pexConfig.DictField(
        keytype=str,
        itemtype=float,
        default={
            "calib_astrometry_used": 0.2,
            "calib_photometry_used": 0.2,
            "calib_photometry_reserved": 0.2
        },
        doc=("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."),
    )

Definition at line 34 of file propagateSourceFlags.py.

x_column

lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig.x_column

static

Initial value:

=  pexConfig.Field(
        doc="Name of column with source x position (sourceTable_visit).",
        dtype=str,
        default="x",
    )

Definition at line 59 of file propagateSourceFlags.py.

y_column

lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig.y_column

static

Initial value:

=  pexConfig.Field(
        doc="Name of column with source y position (sourceTable_visit).",
        dtype=str,
        default="y",
    )

Definition at line 64 of file propagateSourceFlags.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/gc07e1c2157+a98bf949bb/python/lsst/pipe/tasks/propagateSourceFlags.py