MagnitudeErrorLimit

class lsst.meas.algorithms.MagnitudeErrorLimit(*args, **kw)

Bases: BaseLimit

Select sources using a magnitude error limit

Because the magnitude error is the inverse of the signal-to-noise ratio, this also works to select sources by signal-to-noise when you only have a magnitude.

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

magErrField	Name of the source flux error 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 magnitude error limits to a catalog

Attributes Documentation

magErrField

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

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 magnitude error 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).