lsst.meas.algorithms.sourceSelector.RequirePrimary Class Reference

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

Public Member Functions
	apply (self, catalog)

Static Public Attributes
	primaryColName

Detailed Description

Select sources that have the detect_isPrimary flag set.

This object can be used as a `lsst.pex.config.Config` for configuring
the column names to check for "detect_isPrimary".  For single frame
catalogs this will be True when the source is not a sky object, and is
either an isolated parent that is un-modeled or deblended from a parent
with multiple children.  For meas_deblender, this is equivalent to
deblend_nChild=0.  For coadd catalogs there is an additional constraint
that the source is located on the interior of a patch and tract.

Definition at line 527 of file sourceSelector.py.

Member Function Documentation

apply()

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

Apply the primary requirements to a catalog.

Returns whether the sources were selected.

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

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

Definition at line 544 of file sourceSelector.py.

    def apply(self, catalog):
        """Apply the primary requirements to a catalog.
 
        Returns whether the sources were selected.
 
        Parameters
        ----------
        catalog : lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
                  or `astropy.table.Table`
            Catalog of sources to which the requirement will be applied.
 
        Returns
        -------
        selected : `numpy.ndarray`
            Boolean array indicating for each source whether it is selected
            (True means selected).
        """
        selected = (_getFieldFromCatalog(catalog, self.primaryColName)).astype(bool)
 
        return selected
 
 

Member Data Documentation

primaryColName

lsst.meas.algorithms.sourceSelector.RequirePrimary.primaryColName

static

Initial value:

=  pexConfig.Field(
        dtype=str,
        default="detect_isPrimary",
        doc="Name of primary flag column",
    )

Definition at line 538 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