Inheritance diagram for lsst.meas.algorithms.sourceSelector.MagnitudeErrorLimit:

Public Member Functions
def	apply (self, catalog)

Static Public Attributes
	magErrField

	minimum = pexConfig.Field(dtype=float, optional=True, doc="Select objects with value greater than this")

	maximum = pexConfig.Field(dtype=float, optional=True, doc="Select objects with value less than this")

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 348 of file sourceSelector.py.

Member Function Documentation

◆ apply()

def 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 362 of file sourceSelector.py.

     def 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).
         """
         return BaseLimit.apply(self, catalog[self.magErrField])
  
  

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 359 of file sourceSelector.py.

◆ maximum

lsst.meas.algorithms.sourceSelector.BaseLimit.maximum = pexConfig.Field(dtype=float, optional=True, doc="Select objects with value less than this")

staticinherited

Definition at line 175 of file sourceSelector.py.

◆ minimum

lsst.meas.algorithms.sourceSelector.BaseLimit.minimum = pexConfig.Field(dtype=float, optional=True, doc="Select objects with value greater than this")

staticinherited

Definition at line 174 of file sourceSelector.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_algorithms/22.0.1-32-gf62ce7b1+aa4237961e/python/lsst/meas/algorithms/sourceSelector.py

Public Member Functions