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

Public Member Functions
	apply (self, catalog)

Static Public Attributes
	primary = pexConfig.Field(dtype=str, doc="Name of column with primary flux measurement")

	secondary = pexConfig.Field(dtype=str, doc="Name of column with secondary flux measurement")

Detailed Description

Select sources using a color 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.

We refer to 'primary' and 'secondary' flux measurements; these are the
two components of the color, which is:

    instFluxToMag(cat[primary]) - instFluxToMag(cat[secondary])

Definition at line 201 of file sourceSelector.py.

Member Function Documentation

◆ apply()

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

Apply the color limit to a catalog

Parameters
----------
catalog : Various table formats
    Catalog of sources to which the limit will be applied.
    Supports `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
    or `astropy.table.Table`

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

    def apply(self, catalog):
        """Apply the color limit to a catalog
 
        Parameters
        ----------
        catalog : Various table formats
            Catalog of sources to which the limit will be applied.
            Supports `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
            or `astropy.table.Table`
 
        Returns
        -------
        selected : `numpy.ndarray`
            Boolean array indicating for each source whether it is selected
            (True means selected).
        """
        primary = _getFieldFromCatalog(catalog, self.primary)
        secondary = _getFieldFromCatalog(catalog, self.secondary)
 
        primary = (primary*u.nJy).to_value(u.ABmag)
        secondary = (secondary*u.nJy).to_value(u.ABmag)
        color = primary - secondary
        return BaseLimit.apply(self, color)
 
 

Member Data Documentation

◆ primary

lsst.meas.algorithms.sourceSelector.ColorLimit.primary = pexConfig.Field(dtype=str, doc="Name of column with primary flux measurement")

static

Definition at line 213 of file sourceSelector.py.

◆ secondary

lsst.meas.algorithms.sourceSelector.ColorLimit.secondary = pexConfig.Field(dtype=str, doc="Name of column with secondary flux measurement")

static

Definition at line 214 of file sourceSelector.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+3a7c1ac5f1/python/lsst/meas/algorithms/sourceSelector.py