Inheritance diagram for lsst.meas.algorithms.sourceSelector.RequireFlags:

Public Member Functions
	apply (self, catalog)

Static Public Attributes
	good

	bad

Detailed Description

Select sources using flags

This object can be used as a `lsst.pex.config.Config` for configuring
the limit, and then the `apply` method can be used to identify sources
in the catalog that match the configured limit.

Definition at line 384 of file sourceSelector.py.

Member Function Documentation

◆ apply()

lsst.meas.algorithms.sourceSelector.RequireFlags.apply	(		self,
			catalog )

Apply the flag requirements to a catalog

Returns whether the source is selected.

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog`
    Catalog of sources to which the requirements will be applied.

Returns
-------
selected : `numpy.ndarray`
    Boolean array indicating for each source whether it is selected
    (True means selected).

Definition at line 396 of file sourceSelector.py.

    def apply(self, catalog):
        """Apply the flag requirements to a catalog
 
        Returns whether the source is selected.
 
        Parameters
        ----------
        catalog : `lsst.afw.table.SourceCatalog`
            Catalog of sources to which the requirements will be applied.
 
        Returns
        -------
        selected : `numpy.ndarray`
            Boolean array indicating for each source whether it is selected
            (True means selected).
        """
        selected = np.ones(len(catalog), dtype=bool)
        for flag in self.good:
            selected &= catalog[flag]
        for flag in self.bad:
            selected &= ~catalog[flag]
        return selected
 
 

Member Data Documentation

◆ bad

lsst.meas.algorithms.sourceSelector.RequireFlags.bad

static

Initial value:

= pexConfig.ListField(dtype=str, default=[],

doc="List of source flag fields that must NOT be set for a source to be used.")

Definition at line 393 of file sourceSelector.py.

◆ good

lsst.meas.algorithms.sourceSelector.RequireFlags.good

static

Initial value:

= pexConfig.ListField(dtype=str, default=[],

doc="List of source flag fields that must be set for a source to be used.")

Definition at line 391 of file sourceSelector.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/meas_algorithms/gff02db199a+747430a128/python/lsst/meas/algorithms/sourceSelector.py