lsst.meas.algorithms g04242d3e92+8eaa23c173
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.sourceSelector.MagnitudeErrorLimit Class Reference
Inheritance diagram for lsst.meas.algorithms.sourceSelector.MagnitudeErrorLimit:
lsst.meas.algorithms.sourceSelector.BaseLimit

Public Member Functions

 apply (self, catalog)
 

Static Public Attributes

 magErrField
 

Detailed Description

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.

Definition at line 347 of file sourceSelector.py.

Member Function Documentation

◆ apply()

lsst.meas.algorithms.sourceSelector.MagnitudeErrorLimit.apply ( self,
catalog )
Apply the magnitude error limits to a catalog

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog`
    Catalog of sources to which the limit will be applied.

Returns
-------
selected : `numpy.ndarray`
    Boolean array indicating for each source whether it is selected
    (True means selected).

Reimplemented from lsst.meas.algorithms.sourceSelector.BaseLimit.

Definition at line 361 of file sourceSelector.py.

Member Data Documentation

◆ magErrField

lsst.meas.algorithms.sourceSelector.MagnitudeErrorLimit.magErrField
static
Initial value:
= pexConfig.Field(dtype=str, default="mag_err",
doc="Name of the source flux error field to use.")

Definition at line 358 of file sourceSelector.py.


The documentation for this class was generated from the following file: