BaseSourceSelectorTask#

class lsst.meas.algorithms.BaseSourceSelectorTask(**kwargs)#

Bases: Task

Base class for source selectors

Source selectors are classes that perform a selection on a catalog object given a set of criteria or cuts. They return the selected catalog and can optionally set a specified Flag field in the input catalog to identify if the source was selected.

Register all source selectors with the sourceSelectorRegistry using:: sourceSelectorRegistry.register(name, class)

Attributes#

usesMatchesbool: A boolean variable specify if the inherited source selector uses matches to an external catalog, and thus requires the matches argument to run().

Attributes Summary

usesMatches

Methods Summary

`run`(sourceCat[, sourceSelectedField, ...])	Select sources and return them.
`selectSources`(sourceCat[, matches, exposure])	Return a selection of sources selected by some criteria.

Attributes Documentation

usesMatches = False#

Methods Documentation

run(sourceCat, sourceSelectedField=None, matches=None, exposure=None)#

Select sources and return them.

The input catalog must be contiguous in memory.

Parameters#

sourceCatVarious table formats: Catalog of sources to select from. Can be lsst.afw.table.SourceCatalog or pandas.DataFrame or astropy.table.Table,
sourceSelectedFieldstr or None: Name of flag field in sourceCat to set for selected sources. If set, will modify sourceCat in-place.
matcheslist of lsst.afw.table.ReferenceMatch or None: List of matches to use for source selection. If usesMatches is set in source selector this field is required. If not, it is ignored.
exposurelsst.afw.image.Exposure or None: The exposure the catalog was built from; used for debug display.

Returns#

structlsst.pipe.base.Struct

The struct contains the following data:

sourceCat: The catalog of sources that were selected. (may not be memory-contiguous) (lsst.afw.table.SourceCatalog or pandas.DataFrame or astropy.table.Table)
selected: Boolean array of sources that were selected, same length as sourceCat. (numpy.ndarray of bool)

Raises#

RuntimeError: Raised if sourceCat is not contiguous.

abstract selectSources(sourceCat, matches=None, exposure=None)#

Return a selection of sources selected by some criteria.

Parameters#

sourceCatVarious table formats: Catalog of sources to select from. Supports lsst.afw.table.SourceCatalog or pandas.DataFrame or astropy.table.Table This catalog must be contiguous in memory.
matcheslist of lsst.afw.table.ReferenceMatch or None: A list of lsst.afw.table.ReferenceMatch objects
exposurelsst.afw.image.Exposure or None: The exposure the catalog was built from; used for debug display.

Returns#

structlsst.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)