Inheritance diagram for lsst.ip.diffim.diaCatalogSourceSelector.DiaCatalogSourceSelectorTask:

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

Static Public Attributes
	ConfigClass = DiaCatalogSourceSelectorConfig

bool	usesMatches = True

Detailed Description

A task that selects sources for Kernel candidates.

A naive star selector based on second moments. Use with caution.

Notes
-----
Debug Variables

DiaCatalogSourceSelectorTask has a debug dictionary with the following keys:

display : `bool`
    if True display debug information
displayExposure : `bool`
    if True display exposure
pauseAtEnd `bool`
    if True wait after displaying everything and wait for user input

Examples
--------
For example, put something like:

.. code-block:: py

    import lsstDebug
    def DebugInfo(name):
        di = lsstDebug.getInfo(name)  # N.b. lsstDebug.Info(name) would call us recursively
        if name.endswith("diaCatalogSourceSelector"):
            di.display = True

        return di

    lsstDebug.Info = DebugInfo

into your `debug.py` file and run your task with the `--debug` flag.

Definition at line 103 of file diaCatalogSourceSelector.py.

Member Function Documentation

◆ selectSources()

def lsst.ip.diffim.diaCatalogSourceSelector.DiaCatalogSourceSelectorTask.selectSources	(	self,
		sourceCat,
		matches = `None`,
		exposure = `None`
	)

Return a selection of sources for Kernel candidates.

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.
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 : `array` of `bool``
        Boolean array of sources that were selected, same length as
        sourceCat.

Definition at line 142 of file diaCatalogSourceSelector.py.

     def selectSources(self, sourceCat, matches=None, exposure=None):
         """Return a selection of sources for Kernel candidates.
  
         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.
         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 : `array` of `bool``
                 Boolean array of sources that were selected, same length as
                 sourceCat.
         """
         import lsstDebug
         display = lsstDebug.Info(__name__).display
         displayExposure = lsstDebug.Info(__name__).displayExposure
         pauseAtEnd = lsstDebug.Info(__name__).pauseAtEnd
  
         if matches is None:
             raise RuntimeError("DiaCatalogSourceSelector requires matches")
  
         mi = exposure.getMaskedImage()
  
         if display and displayExposure:
             disp = afwDisplay.Display(frame=lsstDebug.frame)
             disp.mtv(mi, title="Kernel candidates")
         #
         # Look for flags in each Source
         #
         isGoodSource = CheckSource(sourceCat, self.config.fluxLim, self.config.fluxMax, self.config.badFlags)
  
         # Go through and find all the acceptable candidates in the catalogue
         selected = np.zeros(len(sourceCat), dtype=bool)
  
         if display and displayExposure:
             symbs = []
             ctypes = []
  
         doColorCut = True
  
         refSchema = matches[0][0].schema
         rRefFluxField = measAlg.getRefFluxField(refSchema, "r")
         gRefFluxField = measAlg.getRefFluxField(refSchema, "g")
         for i, (ref, source, d) in enumerate(matches):
             if not isGoodSource(source):
                 if display and displayExposure:
                     symbs.append("+")
                     ctypes.append(afwDisplay.RED)
             else:
                 isStar = not ref.get("resolved")
                 isVar = not ref.get("photometric")
                 gMag = None
                 rMag = None
                 if doColorCut:
                     try:
                         gMag = -2.5 * np.log10(ref.get(gRefFluxField))
                         rMag = -2.5 * np.log10(ref.get(rRefFluxField))
                     except KeyError:
                         self.log.warning("Cannot cut on color info; fields 'g' and 'r' do not exist")
                         doColorCut = False
                         isRightColor = True
                     else:
                         isRightColor = (gMag-rMag) >= self.config.grMin and (gMag-rMag) <= self.config.grMax
  
                 isRightType = (self.config.selectStar and isStar) or (self.config.selectGalaxy and not isStar)
                 isRightVar = (self.config.includeVariable) or (self.config.includeVariable is isVar)
                 if isRightType and isRightVar and isRightColor:
                     selected[i] = True
                     if display and displayExposure:
                         symbs.append("+")
                         ctypes.append(afwDisplay.GREEN)
                 elif display and displayExposure:
                     symbs.append("o")
                     ctypes.append(afwDisplay.BLUE)
  
         if display and displayExposure:
             disp = afwDisplay.Display(frame=lsstDebug.frame)
             with disp.Buffering():
                 for (ref, source, d), symb, ctype in zip(matches, symbs, ctypes):
                     disp.dot(symb, source.getX() - mi.getX0(), source.getY() - mi.getY0(),
                              size=4, ctype=ctype)
  
         if display:
             lsstDebug.frame += 1
             if pauseAtEnd:
                 input("Continue? y[es] p[db] ")
  
         return Struct(selected=selected)

Member Data Documentation

◆ ConfigClass

lsst.ip.diffim.diaCatalogSourceSelector.DiaCatalogSourceSelectorTask.ConfigClass = DiaCatalogSourceSelectorConfig

static

Definition at line 139 of file diaCatalogSourceSelector.py.

◆ usesMatches

bool lsst.ip.diffim.diaCatalogSourceSelector.DiaCatalogSourceSelectorTask.usesMatches = True

static

Definition at line 140 of file diaCatalogSourceSelector.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/ip_diffim/22.0.1-19-gb93eaa13+aab3ef7709/python/lsst/ip/diffim/diaCatalogSourceSelector.py