lsst.meas.algorithms g33a09d4741+5a3040febd
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.

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: