Public Member Functions |
Static Public Attributes |
Static Protected Attributes |
List of all members
lsst.meas.algorithms.sourceSelector.NullSourceSelectorTask Class Reference
Inheritance diagram for lsst.meas.algorithms.sourceSelector.NullSourceSelectorTask:
Public Member Functions | |
| selectSources (self, sourceCat, **kwargs) | |
| 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
Source selector that returns true for all sources. Use this when you do not want any sub-selection on your inputs.
Definition at line 815 of file sourceSelector.py.
Member Function Documentation
◆ run()
|
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 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.NullSourceSelectorTask.selectSources | ( | self, | |
| sourceCat, | |||
| ** | matches ) |
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 from lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.
Definition at line 822 of file sourceSelector.py.
822 def selectSources(self, sourceCat, **kwargs):
823 # docstring inherited
824 return pipeBase.Struct(selected=np.ones(len(sourceCat), dtype=bool))
825
826
Member Data Documentation
◆ _DefaultName
|
staticprotectedinherited |
Definition at line 65 of file sourceSelector.py.
◆ ConfigClass
|
staticinherited |
Definition at line 64 of file sourceSelector.py.
◆ usesMatches
|
staticinherited |
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/g8180f54f50+60bd39f3b6/python/lsst/meas/algorithms/sourceSelector.py
Generated on Fri Apr 25 2025 08:03:55 for LSST Applications by
1.13.2