lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask Class Reference

Inheritance diagram for lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask:

Public Member Functions
	__init__ (self, *args, **kwargs)
	selectSources (self, sourceCat, matches=None, exposure=None)

Public Attributes
	parentKey
	centroidXKey
	centroidYKey
	centroidFlagKey
	fluxField
	fluxKey
	fluxFlagKey
	fluxErrKey
	edgeKey
	interpolatedCenterKey
	saturatedKey

Static Public Attributes
	ConfigClass = MatcherSourceSelectorConfig

Protected Member Functions
	_getSchemaKeys (self, schema)
	_isParent (self, sourceCat)
	_hasCentroid (self, sourceCat)
	_goodSN (self, sourceCat)
	_isUsable (self, sourceCat)
	_isGood (self, sourceCat)

Detailed Description

Select sources that are useful for matching.

Good matching sources have high signal/noise, are non-blended. They need not
be PSF sources, just have reliable centroids.

Distinguished from astrometrySourceSelector because it is more lenient
(i.e. not checking footprints or bad flags).

Definition at line 59 of file matcherSourceSelector.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.__init__	(		self,
		*	args,
		**	kwargs )

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

Definition at line 70 of file matcherSourceSelector.py.

    def __init__(self, *args, **kwargs):
        BaseSourceSelectorTask.__init__(self, *args, **kwargs)
 

Member Function Documentation

_getSchemaKeys()

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask._getSchemaKeys ( self, schema )

protected

Extract and save the necessary keys from schema with asKey.

Definition at line 102 of file matcherSourceSelector.py.

    def _getSchemaKeys(self, schema):
        """Extract and save the necessary keys from schema with asKey.
        """
        self.parentKey = schema["parent"].asKey()
        self.centroidXKey = schema["slot_Centroid_x"].asKey()
        self.centroidYKey = schema["slot_Centroid_y"].asKey()
        self.centroidFlagKey = schema["slot_Centroid_flag"].asKey()
 
        fluxPrefix = "slot_%sFlux_" % (self.config.sourceFluxType,)
        self.fluxField = fluxPrefix + "instFlux"
        self.fluxKey = schema[fluxPrefix + "instFlux"].asKey()
        self.fluxFlagKey = schema[fluxPrefix + "flag"].asKey()
        self.fluxErrKey = schema[fluxPrefix + "instFluxErr"].asKey()
 
        self.edgeKey = schema["base_PixelFlags_flag_edge"].asKey()
        self.interpolatedCenterKey = schema["base_PixelFlags_flag_interpolatedCenter"].asKey()
        self.saturatedKey = schema["base_PixelFlags_flag_saturated"].asKey()
 

_goodSN()

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask._goodSN ( self, sourceCat )

protected

Return True for each source that has Signal/Noise > config.minSnr.

Definition at line 133 of file matcherSourceSelector.py.

    def _goodSN(self, sourceCat):
        """Return True for each source that has Signal/Noise > config.minSnr.
        """
        if self.config.minSnr <= 0:
            return True
        else:
            with np.errstate(invalid="ignore"):  # suppress NAN warnings
                return sourceCat[self.fluxKey]/sourceCat[self.fluxErrKey] > self.config.minSnr
 

_hasCentroid()

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask._hasCentroid ( self, sourceCat )

protected

Return True for each source that has a valid centroid

Definition at line 126 of file matcherSourceSelector.py.

    def _hasCentroid(self, sourceCat):
        """Return True for each source that has a valid centroid
        """
        return np.isfinite(sourceCat[self.centroidXKey]) \
            & np.isfinite(sourceCat[self.centroidYKey]) \
            & ~sourceCat[self.centroidFlagKey]
 

_isGood()

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask._isGood ( self, sourceCat )

protected

Return True for each source that is usable for matching, even if it may
have a poor centroid.

For a source to be usable it must:

- Not be on a CCD edge.
- Not have an interpolated pixel within 3x3 around their centroid.
- Not have a saturated pixel in their footprint.

Definition at line 159 of file matcherSourceSelector.py.

    def _isGood(self, sourceCat):
        """
        Return True for each source that is usable for matching, even if it may
        have a poor centroid.
 
        For a source to be usable it must:
 
        - Not be on a CCD edge.
        - Not have an interpolated pixel within 3x3 around their centroid.
        - Not have a saturated pixel in their footprint.
        """
        return ~sourceCat[self.edgeKey] & \
               ~sourceCat[self.interpolatedCenterKey] & \
               ~sourceCat[self.saturatedKey]

_isParent()

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask._isParent ( self, sourceCat )

protected

Return True for each source that is the parent source.

Definition at line 120 of file matcherSourceSelector.py.

    def _isParent(self, sourceCat):
        """Return True for each source that is the parent source.
        """
        test = (sourceCat[self.parentKey] == 0)
        return test
 

_isUsable()

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask._isUsable ( self, sourceCat )

protected

Return True for each source that is usable for matching, even if it may
have a poor centroid.

For a source to be usable it must:

- have a valid centroid
- not be deblended
- have a valid instFlux (of the type specified in this object's constructor)
- have adequate signal-to-noise

Definition at line 142 of file matcherSourceSelector.py.

    def _isUsable(self, sourceCat):
        """
        Return True for each source that is usable for matching, even if it may
        have a poor centroid.
 
        For a source to be usable it must:
 
        - have a valid centroid
        - not be deblended
        - have a valid instFlux (of the type specified in this object's constructor)
        - have adequate signal-to-noise
        """
        return self._hasCentroid(sourceCat) \
            & self._isParent(sourceCat) \
            & self._goodSN(sourceCat) \
            & ~sourceCat[self.fluxFlagKey]
 

selectSources()

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.selectSources	(		self,
			sourceCat,
			matches = None,
			exposure = None )

Return a selection of sources that are useful for matching.

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 73 of file matcherSourceSelector.py.

    def selectSources(self, sourceCat, matches=None, exposure=None):
        """Return a selection of sources that are useful for matching.
 
        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`)
        """
        self._getSchemaKeys(sourceCat.schema)
 
        good = self._isUsable(sourceCat)
        if self.config.excludePixelFlags:
            good = good & self._isGood(sourceCat)
        return Struct(selected=good)
 

Member Data Documentation

centroidFlagKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.centroidFlagKey

Definition at line 108 of file matcherSourceSelector.py.

centroidXKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.centroidXKey

Definition at line 106 of file matcherSourceSelector.py.

centroidYKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.centroidYKey

Definition at line 107 of file matcherSourceSelector.py.

ConfigClass

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.ConfigClass = MatcherSourceSelectorConfig

static

Definition at line 68 of file matcherSourceSelector.py.

edgeKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.edgeKey

Definition at line 116 of file matcherSourceSelector.py.

fluxErrKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.fluxErrKey

Definition at line 114 of file matcherSourceSelector.py.

fluxField

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.fluxField

Definition at line 111 of file matcherSourceSelector.py.

fluxFlagKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.fluxFlagKey

Definition at line 113 of file matcherSourceSelector.py.

fluxKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.fluxKey

Definition at line 112 of file matcherSourceSelector.py.

interpolatedCenterKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.interpolatedCenterKey

Definition at line 117 of file matcherSourceSelector.py.

parentKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.parentKey

Definition at line 105 of file matcherSourceSelector.py.

saturatedKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.saturatedKey

Definition at line 118 of file matcherSourceSelector.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+0d71447b4b/python/lsst/meas/algorithms/matcherSourceSelector.py