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.