CentroidErrorLimit#

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

Bases: BaseLimit

Select sources using a limit on the centroid errors.

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

centroidField

Name of the source centroid 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 limit on source centroid errors to a catalog.

setDefaults()

Subclass hook for computing defaults.

Attributes Documentation

centroidField#

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

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 limit on source centroid errors 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).

setDefaults()#

Subclass hook for computing defaults.

Notes#

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.