Inheritance diagram for lsst.meas.algorithms.sourceSelector.ReferenceSourceSelectorTask:

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

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

Static Public Attributes
	ConfigClass = BaseSourceSelectorConfig

bool	usesMatches = False

Static Protected Attributes
str	_DefaultName = "sourceSelector"

Detailed Description

Reference source selector

This selects reference sources by (optionally) applying each of a
magnitude limit, flag requirements and color limits.

Definition at line 802 of file sourceSelector.py.

Member Function Documentation

◆ run()

lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.run	(	self,
		sourceCat,
		sourceSelectedField = None,
		matches = None,
		exposure = None )

inherited

Select sources and return them.

The input catalog must be contiguous in memory.

Parameters
----------
sourceCat : Various table formats
    Catalog of sources to select from. Can be
    `lsst.afw.table.SourceCatalog` or `pandas.DataFrame` or
    `astropy.table.Table`,
sourceSelectedField : `str` or None
    Name of flag field in sourceCat to set for selected sources.
    If set, will modify sourceCat in-place.
matches : `list` 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.
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:

    ``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.

Definition at line 72 of file sourceSelector.py.

◆ selectSources()

lsst.meas.algorithms.sourceSelector.ReferenceSourceSelectorTask.selectSources	(	self,
		sourceCat,
		matches = None,
		exposure = None )

Return a selection of reference sources selected by some criteria.

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 810 of file sourceSelector.py.

Member Data Documentation

◆ _DefaultName

str lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask._DefaultName = "sourceSelector"

staticprotectedinherited

Definition at line 66 of file sourceSelector.py.

◆ ConfigClass

lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.ConfigClass = BaseSourceSelectorConfig

staticinherited

Definition at line 65 of file sourceSelector.py.

◆ usesMatches

bool lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.usesMatches = False

staticinherited

Definition at line 67 of file sourceSelector.py.

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

python/lsst/meas/algorithms/sourceSelector.py

Public Member Functions

Static Public Attributes

Static Protected Attributes