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

Public Member Functions
def	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")

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

Member Function Documentation

◆ apply()

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

Apply the color limit to a catalog

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
          or `astropy.table.Table`
    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 218 of file sourceSelector.py.

     def apply(self, catalog):
         """Apply the color limit to a catalog
  
         Parameters
         ----------
         catalog : `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
                   or `astropy.table.Table`
             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).
         """
         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

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

◆ primary

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

static

Definition at line 215 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 216 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

Static Public Attributes