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

Static Public Attributes
	ConfigClass = CatalogStarSelectorConfig

bool	usesMatches = True

Detailed Description

Select stars based on a reference catalog.

Attributes
----------
usesMatches : `bool`
    A boolean variable specify if the inherited source selector uses
    matches to an external catalog, and thus requires the ``matches``
    argument to ``run()``. Set to True for this selector.

Definition at line 85 of file catalogStarSelector.py.

Member Function Documentation

◆ selectSources()

def lsst.meas.astrom.catalogStarSelector.CatalogStarSelectorTask.selectSources	(	self,
		sourceCat,
		matches = `None`,
		exposure = `None`
	)

Return a selection of sources based on reference catalog matches.

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`
    A match vector as produced by meas_astrom; required.
exposure : `lsst.afw.image.Exposure` or None
    The exposure the catalog was built from; used for debug display.

Return
------
struct : `lsst.pipe.base.Struct`
    Result struct with components:

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

Definition at line 98 of file catalogStarSelector.py.

     def selectSources(self, sourceCat, matches=None, exposure=None):
         """Return a selection of sources based on reference catalog matches.
 
         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`
             A match vector as produced by meas_astrom; required.
         exposure : `lsst.afw.image.Exposure` or None
             The exposure the catalog was built from; used for debug display.
 
         Return
         ------
         struct : `lsst.pipe.base.Struct`
             Result struct with components:
 
             - selected : Boolean array of sources that were selected, same
               length as sourceCat (`numpy.ndarray` of `bool`)
         """
         import lsstDebug
         debugInfo = lsstDebug.Info(__name__)
         display = debugInfo.display
         pauseAtEnd = debugInfo.pauseAtEnd  # pause when done
 
         if matches is None:
             raise RuntimeError("CatalogStarSelectorTask requires matches")
 
         mi = exposure.getMaskedImage()
 
         if display:
             frame = 1
             ds9.mtv(mi, frame=frame, title="PSF candidates")
 
         isGoodSource = CheckSource(sourceCat, self.config.fluxLim, self.config.fluxMax, self.config.badFlags)
         good = np.array([isGoodSource(record) for record in sourceCat])
 
         with ds9.Buffering():
             for ref, source, d in matches:
                 if not ref.get("resolved"):
                     if not isGoodSource(source):
                         symb, ctype = "+", ds9.RED
                     else:
                         symb, ctype = "+", ds9.GREEN
 
                         if display:
                             ds9.dot(symb, source.getX() - mi.getX0(), source.getY() - mi.getY0(),
                                     size=4, frame=frame, ctype=ctype)
 
         if display and pauseAtEnd:
             input("Continue? y[es] p[db] ")
 
         return Struct(selected=good)

Member Data Documentation

◆ ConfigClass

lsst.meas.astrom.catalogStarSelector.CatalogStarSelectorTask.ConfigClass = CatalogStarSelectorConfig

static

Definition at line 95 of file catalogStarSelector.py.

◆ usesMatches

bool lsst.meas.astrom.catalogStarSelector.CatalogStarSelectorTask.usesMatches = True

static

Definition at line 96 of file catalogStarSelector.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/Linux64/meas_astrom/16.0-18-g51a54b3+3/python/lsst/meas/astrom/catalogStarSelector.py