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

Public Member Functions
def	apply (self, catalog)

Static Public Attributes
	fluxField

	errField

	minimum = pexConfig.Field(dtype=float, optional=True, doc="Select objects with value greater than this")

	maximum = pexConfig.Field(dtype=float, optional=True, doc="Select objects with value less than this")

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

Member Function Documentation

◆ apply()

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

     def 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).
         """
         flagField = self.fluxField + "_flag"
         selected = np.logical_not(_getFieldFromCatalog(catalog, flagField, isFlag=True))
         flux = _getFieldFromCatalog(catalog, self.fluxField)
         err = _getFieldFromCatalog(catalog, self.errField)
  
         signalToNoise = flux/err
         selected &= BaseLimit.apply(self, signalToNoise)
         return selected
  
  

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

◆ maximum

lsst.meas.algorithms.sourceSelector.BaseLimit.maximum = pexConfig.Field(dtype=float, optional=True, doc="Select objects with value less than this")

staticinherited

Definition at line 175 of file sourceSelector.py.

◆ minimum

lsst.meas.algorithms.sourceSelector.BaseLimit.minimum = pexConfig.Field(dtype=float, optional=True, doc="Select objects with value greater than this")

staticinherited

Definition at line 174 of file sourceSelector.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_algorithms/22.0.1-32-gf62ce7b1+aa4237961e/python/lsst/meas/algorithms/sourceSelector.py

Public Member Functions

Static Public Attributes