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

Public Member Functions
	apply (self, values)

Static Public Attributes
	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

Base class for selecting sources by applying a limit

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.

This provides the `maximum` and `minimum` fields in the Config, and
a method to apply the limits to an array of values calculated by the
subclass.

Definition at line 163 of file sourceSelector.py.

Member Function Documentation

◆ apply()

lsst.meas.algorithms.sourceSelector.BaseLimit.apply	(		self,
			values )

Apply the limits to an array of values

Subclasses should calculate the array of values and then
return the result of calling this method.

Parameters
----------
values : `numpy.ndarray`
    Array of values to which to apply limits.

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

Reimplemented in lsst.meas.algorithms.sourceSelector.CentroidErrorLimit, lsst.meas.algorithms.sourceSelector.ColorLimit, lsst.meas.algorithms.sourceSelector.FluxLimit, lsst.meas.algorithms.sourceSelector.MagnitudeErrorLimit, lsst.meas.algorithms.sourceSelector.MagnitudeLimit, lsst.meas.algorithms.sourceSelector.RequireUnresolved, and lsst.meas.algorithms.sourceSelector.SignalToNoiseLimit.

Definition at line 177 of file sourceSelector.py.

    def apply(self, values):
        """Apply the limits to an array of values
 
        Subclasses should calculate the array of values and then
        return the result of calling this method.
 
        Parameters
        ----------
        values : `numpy.ndarray`
            Array of values to which to apply limits.
 
        Returns
        -------
        selected : `numpy.ndarray`
            Boolean array indicating for each source whether it is selected
            (True means selected).
        """
        selected = np.ones(len(values), dtype=bool)
        with np.errstate(invalid="ignore"):  # suppress NAN warnings
            if self.minimum is not None:
                selected &= values > self.minimum
            if self.maximum is not None:
                selected &= values < self.maximum
        return selected
 
 

Member Data Documentation

◆ maximum

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

static

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")

static

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