LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
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, lsst.meas.algorithms.sourceSelector.ReferenceSourceSelectorTask, and lsst.meas.extensions.psfex.psfexStarSelector.PsfexStarSelectorTask.
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.