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