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

Public Member Functions
	setDefaults (self)

	apply (self, catalog)

Static Public Attributes
	centroidField

	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 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.

Definition at line 643 of file sourceSelector.py.

Member Function Documentation

◆ apply()

lsst.meas.algorithms.sourceSelector.CentroidErrorLimit.apply	(		self,
			catalog )

Apply the limit on source centroid errors 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 656 of file sourceSelector.py.

    def apply(self, catalog):
        """Apply the limit on source centroid errors 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).
        """
        xErrField = self.centroidField + "_xErr"
        yErrField = self.centroidField + "_yErr"
        selected = ((np.isfinite(catalog[xErrField])) & (np.isfinite(catalog[yErrField])))
        selected &= BaseLimit.apply(self, catalog[xErrField])
        selected &= BaseLimit.apply(self, catalog[yErrField])
        return selected
 
 

◆ setDefaults()

lsst.meas.algorithms.sourceSelector.CentroidErrorLimit.setDefaults ( self )

Definition at line 653 of file sourceSelector.py.

    def setDefaults(self):
        self.maximum = 3.0
 

Member Data Documentation

◆ centroidField

lsst.meas.algorithms.sourceSelector.CentroidErrorLimit.centroidField

static

Initial value:

= pexConfig.Field(dtype=str, default="slot_Centroid",

doc="Name of the source centroid field to use.")

Definition at line 650 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-12.1.0/Linux/meas_algorithms/gcc769fe2a4+97d0256649/python/lsst/meas/algorithms/sourceSelector.py

Public Member Functions

Static Public Attributes