Inheritance diagram for lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask:
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" |
Detailed Description
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.
Constructor & Destructor Documentation
◆ __init__()
| 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.
67 def __init__(self, **kwargs):
68 pipeBase.Task.__init__(self, **kwargs)
69
Member Function Documentation
◆ run()
| 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.
70 def run(self, sourceCat, sourceSelectedField=None, matches=None, exposure=None):
71 """Select sources and return them.
72
73 The input catalog must be contiguous in memory.
74
75 Parameters
76 ----------
77 sourceCat : Various table formats
78 Catalog of sources to select from. Can be
79 `lsst.afw.table.SourceCatalog` or `pandas.DataFrame` or
80 `astropy.table.Table`,
81 sourceSelectedField : `str` or None
82 Name of flag field in sourceCat to set for selected sources.
83 If set, will modify sourceCat in-place.
84 matches : `list` of `lsst.afw.table.ReferenceMatch` or None
85 List of matches to use for source selection.
86 If usesMatches is set in source selector this field is required.
87 If not, it is ignored.
88 exposure : `lsst.afw.image.Exposure` or None
89 The exposure the catalog was built from; used for debug display.
90
91 Returns
92 -------
93 struct : `lsst.pipe.base.Struct`
94 The struct contains the following data:
95
96 ``sourceCat``
97 The catalog of sources that were selected.
98 (may not be memory-contiguous)
99 (`lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
100 or `astropy.table.Table`)
101 ``selected``
102 Boolean array of sources that were selected, same length as
103 sourceCat.
104 (`numpy.ndarray` of `bool`)
105
106 Raises
107 ------
108 RuntimeError
109 Raised if ``sourceCat`` is not contiguous.
110 """
111 if hasattr(sourceCat, 'isContiguous'):
112 # Check for continuity on afwTable catalogs
113 if not sourceCat.isContiguous():
114 raise RuntimeError("Input catalogs for source selection must be contiguous.")
115
116 result = self.selectSources(sourceCat=sourceCat,
117 exposure=exposure,
118 matches=matches)
119
120 if sourceSelectedField is not None:
121 sourceCat[sourceSelectedField] = result.selected
122
123 return pipeBase.Struct(sourceCat=sourceCat[result.selected],
124 selected=result.selected)
125
◆ selectSources()
| 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.
127 def selectSources(self, sourceCat, matches=None, exposure=None):
128 """Return a selection of sources selected by some criteria.
129
130 Parameters
131 ----------
132 sourceCat : Various table formats
133 Catalog of sources to select from. Supports
134 `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
135 or `astropy.table.Table`
136 This catalog must be contiguous in memory.
137 matches : `list` of `lsst.afw.table.ReferenceMatch` or None
138 A list of lsst.afw.table.ReferenceMatch objects
139 exposure : `lsst.afw.image.Exposure` or None
140 The exposure the catalog was built from; used for debug display.
141
142 Returns
143 -------
144 struct : `lsst.pipe.base.Struct`
145 The struct contains the following data:
146
147 ``selected``
148 Boolean array of sources that were selected, same length as
149 sourceCat.
150 (`numpy.ndarray` of `bool`)
151 """
152 raise NotImplementedError("BaseSourceSelectorTask is abstract")
153
154
Member Data Documentation
◆ _DefaultName
|
staticprotected |
Definition at line 64 of file sourceSelector.py.
◆ ConfigClass
|
static |
Definition at line 63 of file sourceSelector.py.
◆ usesMatches
|
static |
Definition at line 65 of file sourceSelector.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+889fc9d533/python/lsst/meas/algorithms/sourceSelector.py
