lsst.meas.algorithms.sourceSelector.ScienceSourceSelectorTask Class Reference

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

Public Member Functions
	selectSources (self, sourceCat, matches=None, exposure=None)

Static Public Attributes
	ConfigClass = ScienceSourceSelectorConfig

Detailed Description

Science source selector

By "science" sources, we mean sources that are on images that we
are processing, as opposed to sources from reference catalogs.

This selects (science) sources by (optionally) applying each of a
magnitude limit, flag requirements and star/galaxy separation.

Definition at line 592 of file sourceSelector.py.

Member Function Documentation

selectSources()

lsst.meas.algorithms.sourceSelector.ScienceSourceSelectorTask.selectSources	(		self,
			sourceCat,
			matches = None,
			exposure = None )

Return a selection of sources selected by specified criteria.

Parameters
----------
sourceCat : `lsst.afw.table.SourceCatalog`
    Catalog of sources to select from.
    This catalog must be contiguous in memory.
matches : `list` of `lsst.afw.table.ReferenceMatch` or None
    Ignored in this SourceSelector.
exposure : `lsst.afw.image.Exposure` or None
    The exposure the catalog was built from; used for debug display.

Returns
-------
struct : `lsst.pipe.base.Struct`
    The struct contains the following data:

    ``selected``
        Boolean array of sources that were selected, same length as
        sourceCat.
        (`numpy.ndarray` of `bool`)

Reimplemented from lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.

Definition at line 603 of file sourceSelector.py.

    def selectSources(self, sourceCat, matches=None, exposure=None):
        """Return a selection of sources selected by specified criteria.
 
        Parameters
        ----------
        sourceCat : `lsst.afw.table.SourceCatalog`
            Catalog of sources to select from.
            This catalog must be contiguous in memory.
        matches : `list` of `lsst.afw.table.ReferenceMatch` or None
            Ignored in this SourceSelector.
        exposure : `lsst.afw.image.Exposure` or None
            The exposure the catalog was built from; used for debug display.
 
        Returns
        -------
        struct : `lsst.pipe.base.Struct`
            The struct contains the following data:
 
            ``selected``
                Boolean array of sources that were selected, same length as
                sourceCat.
                (`numpy.ndarray` of `bool`)
        """
        selected = np.ones(len(sourceCat), dtype=bool)
        if self.config.doFluxLimit:
            selected &= self.config.fluxLimit.apply(sourceCat)
        if self.config.doFlags:
            selected &= self.config.flags.apply(sourceCat)
        if self.config.doUnresolved:
            selected &= self.config.unresolved.apply(sourceCat)
        if self.config.doSignalToNoise:
            selected &= self.config.signalToNoise.apply(sourceCat)
        if self.config.doIsolated:
            selected &= self.config.isolated.apply(sourceCat)
        if self.config.doRequireFiniteRaDec:
            selected &= self.config.requireFiniteRaDec.apply(sourceCat)
        if self.config.doRequirePrimary:
            selected &= self.config.requirePrimary.apply(sourceCat)
        if self.config.doSkySources:
            selected |= self.config.skyFlag.apply(sourceCat)
 
        self.log.info("Selected %d/%d sources", selected.sum(), len(sourceCat))
 
        return pipeBase.Struct(selected=selected)
 
 

Member Data Documentation

ConfigClass

lsst.meas.algorithms.sourceSelector.ScienceSourceSelectorTask.ConfigClass = ScienceSourceSelectorConfig

static

Definition at line 601 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+889fc9d533/python/lsst/meas/algorithms/sourceSelector.py