LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+ffe7eabc7e,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g36da64cc00+ea84795170,g3ddfee87b4+955a963fd8,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+955a963fd8,g591dd9f2cf+bac198a2cb,g5ec818987f+420292cfeb,g858d7b2824+d6c9a0a3b8,g876c692160+aabc49a3c3,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+e6cd765486,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+acd47f83f4,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+12c8382528,gba4ed39666+1ac82b564f,gbb8dafda3b+0574160a1f,gbeb006f7da+dea2fbb49f,gc28159a63d+c6dfa2ddaf,gc86a011abf+d6c9a0a3b8,gcf0d15dbbd+955a963fd8,gdaeeff99f8+1cafcb7cd4,gdc0c513512+d6c9a0a3b8,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,gee10cc3b42+90ebb246c7,gf1cff7945b+d6c9a0a3b8,w.2024.13
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.sourceSelector.SignalToNoiseLimit Class Reference
Inheritance diagram for lsst.meas.algorithms.sourceSelector.SignalToNoiseLimit:
lsst.meas.algorithms.sourceSelector.BaseLimit

Public Member Functions

 apply (self, catalog)
 

Static Public Attributes

 fluxField
 
 errField
 

Detailed Description

Select sources using a flux signal-to-noise limit

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

Member Function Documentation

◆ apply()

lsst.meas.algorithms.sourceSelector.SignalToNoiseLimit.apply ( self,
catalog )
Apply the signal-to-noise limits to a catalog

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

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

Reimplemented from lsst.meas.algorithms.sourceSelector.BaseLimit.

Definition at line 323 of file sourceSelector.py.

323 def apply(self, catalog):
324 """Apply the signal-to-noise limits to a catalog
325
326 Parameters
327 ----------
328 catalog : `lsst.afw.table.SourceCatalog`
329 Catalog of sources to which the limit will be applied.
330
331 Returns
332 -------
333 selected : `numpy.ndarray`
334 Boolean array indicating for each source whether it is selected
335 (True means selected).
336 """
337 flagField = self.fluxField + "_flag"
338 selected = np.logical_not(_getFieldFromCatalog(catalog, flagField, isFlag=True))
339 flux = _getFieldFromCatalog(catalog, self.fluxField)
340 err = _getFieldFromCatalog(catalog, self.errField)
341
342 signalToNoise = flux/err
343 selected &= BaseLimit.apply(self, signalToNoise)
344 return selected
345
346

Member Data Documentation

◆ errField

lsst.meas.algorithms.sourceSelector.SignalToNoiseLimit.errField
static
Initial value:
= pexConfig.Field(dtype=str, default="flux_err",
doc="Name of the source flux error field to use.")

Definition at line 320 of file sourceSelector.py.

◆ fluxField

lsst.meas.algorithms.sourceSelector.SignalToNoiseLimit.fluxField
static
Initial value:
= pexConfig.Field(dtype=str, default="flux",
doc="Name of the source flux field to use.")

Definition at line 318 of file sourceSelector.py.


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