SignalToNoiseLimit#

class lsst.meas.algorithms.SignalToNoiseLimit(*args, **kw)#

Bases: BaseLimit

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.

Attributes Summary

errField

Name of the source flux error field to use.

fluxField

Name of the source flux field to use.

maximum

Select objects with value less than this (float, default None)

minimum

Select objects with value greater than this (float, default None)

Methods Summary

apply(catalog)

Apply the signal-to-noise limits to a catalog

Attributes Documentation

errField#

Name of the source flux error field to use. (str, default 'flux_err')

fluxField#

Name of the source flux field to use. (str, default 'flux')

maximum#

Select objects with value less than this (float, default None)

minimum#

Select objects with value greater than this (float, default None)

Methods Documentation

apply(catalog)#

Apply the signal-to-noise limits to a catalog

Parameters#

cataloglsst.afw.table.SourceCatalog

Catalog of sources to which the limit will be applied.

Returns#

selectednumpy.ndarray

Boolean array indicating for each source whether it is selected (True means selected).