MagnitudeLimit

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

Bases: BaseLimit

Select sources using a magnitude limit

Note that this assumes that a zero-point has already been applied and the fluxes are in AB fluxes in Jansky. It is therefore principally intended for reference catalogs rather than catalogs extracted from science images.

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

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 magnitude limits to a catalog

Attributes Documentation

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