ColorLimit#

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

Bases: BaseLimit

Select sources using a color 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.

We refer to ‘primary’ and ‘secondary’ flux measurements; these are the two components of the color, which is:

instFluxToMag(cat[primary]) - instFluxToMag(cat[secondary])

Attributes Summary

maximum

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

minimum

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

primary

Name of column with primary flux measurement (str)

secondary

Name of column with secondary flux measurement (str)

Methods Summary

apply(catalog)

Apply the color limit to a catalog

Attributes Documentation

maximum#

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

minimum#

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

primary#

Name of column with primary flux measurement (str)

secondary#

Name of column with secondary flux measurement (str)

Methods Documentation

apply(catalog)#

Apply the color limit to a catalog

Parameters#

catalogVarious table formats

Catalog of sources to which the limit will be applied. Supports lsst.afw.table.SourceCatalog or pandas.DataFrame or astropy.table.Table

Returns#

selectednumpy.ndarray

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