lsst.meas.algorithms ga2e4dd1c03+8ec1eac53e
|
Public Member Functions | |
__init__ (self, **kwargs) | |
run (self, sourceCat, sourceSelectedField=None, matches=None, exposure=None) | |
selectSources (self, sourceCat, matches=None, exposure=None) | |
Static Public Attributes | |
ConfigClass = BaseSourceSelectorConfig | |
bool | usesMatches = False |
Static Protected Attributes | |
str | _DefaultName = "sourceSelector" |
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 ---------- 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()``.
Definition at line 44 of file sourceSelector.py.
lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.__init__ | ( | self, | |
** | kwargs ) |
Reimplemented in lsst.meas.algorithms.astrometrySourceSelector.AstrometrySourceSelectorTask, and lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.
Definition at line 67 of file sourceSelector.py.
lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.run | ( | self, | |
sourceCat, | |||
sourceSelectedField = None, | |||
matches = None, | |||
exposure = None ) |
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 70 of file sourceSelector.py.
lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.selectSources | ( | self, | |
sourceCat, | |||
matches = None, | |||
exposure = None ) |
Return a selection of sources selected by some criteria. Parameters ---------- sourceCat : Various 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. matches : `list` of `lsst.afw.table.ReferenceMatch` or None A list of lsst.afw.table.ReferenceMatch objects 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 in lsst.meas.algorithms.sourceSelector.NullSourceSelectorTask, lsst.meas.algorithms.astrometrySourceSelector.AstrometrySourceSelectorTask, lsst.meas.algorithms.flaggedSourceSelector.FlaggedSourceSelectorTask, lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask, lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask, lsst.meas.algorithms.sourceSelector.ScienceSourceSelectorTask, and lsst.meas.algorithms.sourceSelector.ReferenceSourceSelectorTask.
Definition at line 127 of file sourceSelector.py.
|
staticprotected |
Definition at line 64 of file sourceSelector.py.
|
static |
Definition at line 63 of file sourceSelector.py.
|
static |
Definition at line 65 of file sourceSelector.py.