lsst.meas.algorithms  20.0.0-4-g085c40a3
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.sourceSelector.RequireFlags Class Reference
Inheritance diagram for lsst.meas.algorithms.sourceSelector.RequireFlags:

Public Member Functions

def 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 379 of file sourceSelector.py.

Member Function Documentation

◆ apply()

def 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 391 of file sourceSelector.py.

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 388 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 386 of file sourceSelector.py.


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