Public Member Functions |
Static Public Attributes |
Static Protected Attributes |
List of all members
lsst.meas.algorithms.flaggedSourceSelector.FlaggedSourceSelectorTask Class Reference
Inheritance diagram for lsst.meas.algorithms.flaggedSourceSelector.FlaggedSourceSelectorTask:
Public Member Functions | |
| selectSources (self, sourceCat, matches=None, exposure=None) | |
Static Public Attributes | |
| ConfigClass = FlaggedSourceSelectorConfig | |
Static Protected Attributes | |
| str | _DefaultName = "flagged" |
Detailed Description
A trivial SourceSelector that simply uses an existing flag field to filter
a SourceCatalog.
This is most frequently used in steps that occur after the a PSF model has
been built, to allow other procedures that need Sources to use the set of
Sources used to determine the PSF.
Attributes
----------
usesMatches : `bool`
A boolean variable specify if the inherited source selector uses
matches.
Definition at line 40 of file flaggedSourceSelector.py.
Member Function Documentation
◆ selectSources()
| lsst.meas.algorithms.flaggedSourceSelector.FlaggedSourceSelectorTask.selectSources | ( | self, | |
| sourceCat, | |||
| matches = None, | |||
| exposure = None ) |
Return a bool array representing which sources to select from
sourceCat.
The input catalog must be contiguous in memory.
Parameters
----------
sourceCat : `lsst.afw.table.SourceCatalog`
Catalog of sources to select from.
matches : `list` of `lsst.afw.table.ReferenceMatch` or None
Ignored in this SourceSelector.
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 59 of file flaggedSourceSelector.py.
59 def selectSources(self, sourceCat, matches=None, exposure=None):
60 """Return a bool array representing which sources to select from
61 sourceCat.
62
63 The input catalog must be contiguous in memory.
64
65 Parameters
66 ----------
67 sourceCat : `lsst.afw.table.SourceCatalog`
68 Catalog of sources to select from.
69 matches : `list` of `lsst.afw.table.ReferenceMatch` or None
70 Ignored in this SourceSelector.
71 exposure : `lsst.afw.image.Exposure` or None
72 The exposure the catalog was built from; used for debug display.
73
74 Returns
75 -------
76 struct : `lsst.pipe.base.Struct`
77 The struct contains the following data:
78
79 ``selected``
80 Boolean array of sources that were selected, same length as
81 ``sourceCat``. (`numpy.ndarray` of `bool`)
82 """
83 key = sourceCat.schema.find(self.config.field).key
84 return pipeBase.Struct(selected=sourceCat[key])
Member Data Documentation
◆ _DefaultName
|
staticprotected |
Definition at line 57 of file flaggedSourceSelector.py.
◆ ConfigClass
|
static |
Definition at line 56 of file flaggedSourceSelector.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/meas_algorithms/g97b8272a79+a8c4cb337e/python/lsst/meas/algorithms/flaggedSourceSelector.py
Generated on Mon Jan 20 2025 08:02:06 for LSST Applications by
1.11.0