RequirePrimary#

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

Bases: Config

Select sources that have the detect_isPrimary flag set.

This object can be used as a lsst.pex.config.Config for configuring the column names to check for “detect_isPrimary”. For single frame catalogs this will be True when the source is not a sky object, and is either an isolated parent that is un-modeled or deblended from a parent with multiple children. For meas_deblender, this is equivalent to deblend_nChild=0. For coadd catalogs there is an additional constraint that the source is located on the interior of a patch and tract.

Attributes Summary

primaryColName

Name of primary flag column (str, default 'detect_isPrimary')

Methods Summary

apply(catalog)

Apply the primary requirements to a catalog.

Attributes Documentation

primaryColName#

Name of primary flag column (str, default 'detect_isPrimary')

Methods Documentation

apply(catalog)#

Apply the primary requirements to a catalog.

Returns whether the sources were selected.

Parameters#

cataloglsst.afw.table.SourceCatalog` or pandas.DataFrame

or astropy.table.Table

Catalog of sources to which the requirement will be applied.

Returns#

selectednumpy.ndarray

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