lsst.meas.algorithms.sourceSelector.ReferenceSourceSelectorTask Class Reference

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

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

Static Public Attributes
	ConfigClass = ReferenceSourceSelectorConfig

Detailed Description

Reference source selector

This selects reference sources by (optionally) applying each of a
magnitude limit, flag requirements and color limits.

Definition at line 669 of file sourceSelector.py.

Member Function Documentation

selectSources()

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

Return a selection of reference sources selected by some 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 677 of file sourceSelector.py.

    def selectSources(self, sourceCat, matches=None, exposure=None):
        """Return a selection of reference sources selected by some 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.doMagLimit:
            selected &= self.config.magLimit.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.doMagError:
            selected &= self.config.magError.apply(sourceCat)
        if self.config.doRequireFiniteRaDec:
            selected &= self.config.requireFiniteRaDec.apply(sourceCat)
        for limit in self.config.colorLimits.values():
            selected &= limit.apply(sourceCat)
 
        self.log.info("Selected %d/%d references", selected.sum(), len(sourceCat))
 
        return pipeBase.Struct(selected=selected)
 
 
@pexConfig.registerConfigurable("null", sourceSelectorRegistry)

Member Data Documentation

ConfigClass

lsst.meas.algorithms.sourceSelector.ReferenceSourceSelectorTask.ConfigClass = ReferenceSourceSelectorConfig

static

Definition at line 675 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+508d0e0a30/python/lsst/meas/algorithms/sourceSelector.py