LSST Applications 24.1.6,g063fba187b+56b85ce14a,g0f08755f38+df8a265115,g12f32b3c4e+891a09f10d,g1524ad2192+7a5d7b3fbd,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g28da252d5a+07cb1400be,g2bbee38e9b+ae03bbfc84,g2bc492864f+ae03bbfc84,g3156d2b45e+6e55a43351,g347aa1857d+ae03bbfc84,g35bb328faa+a8ce1bb630,g3a166c0a6a+ae03bbfc84,g3e281a1b8c+c5dd892a6c,g414038480c+6b9177ef31,g41af890bb2+8f257c4c0b,g781aacb6e4+a8ce1bb630,g7af13505b9+7137b3b17d,g80478fca09+6df6903293,g82479be7b0+091ce1d07f,g858d7b2824+df8a265115,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,g9726552aa6+414189b318,ga5288a1d22+4a2bca08d7,gacef1a1666+c9a8ff65f4,gb58c049af0+d64f4d3760,gbcfae0f0a0+de1d42d831,gc28159a63d+ae03bbfc84,gcf0d15dbbd+72117bf34e,gda6a2b7d83+72117bf34e,gdaeeff99f8+1711a396fd,ge500cccec5+c8c9c9af63,ge79ae78c31+ae03bbfc84,gf0baf85859+c1f95f4921,gfa517265be+df8a265115,gfa999e8aa5+17cd334064,gfb92a5be7c+df8a265115
LSST Data Management Base Package
Loading...
Searching...
No Matches
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

 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.

396 def apply(self, catalog):
397 """Apply the flag requirements to a catalog
398
399 Returns whether the source is selected.
400
401 Parameters
402 ----------
403 catalog : `lsst.afw.table.SourceCatalog`
404 Catalog of sources to which the requirements will be applied.
405
406 Returns
407 -------
408 selected : `numpy.ndarray`
409 Boolean array indicating for each source whether it is selected
410 (True means selected).
411 """
412 selected = np.ones(len(catalog), dtype=bool)
413 for flag in self.good:
414 selected &= catalog[flag]
415 for flag in self.bad:
416 selected &= ~catalog[flag]
417 return selected
418
419

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: