Public Member Functions |
Static Public Attributes |
Static Protected Attributes |
List of all members
lsst.meas.algorithms.sourceSelector.ReferenceSourceSelectorTask Class Reference
Inheritance diagram for lsst.meas.algorithms.sourceSelector.ReferenceSourceSelectorTask:
Public Member Functions | |
| selectSources (self, sourceCat, matches=None, exposure=None) | |
| 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
Reference source selector This selects reference sources by (optionally) applying each of a magnitude limit, flag requirements and color limits.
Definition at line 761 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.ReferenceSourceSelectorTask.selectSources | ( | self, | |
| sourceCat, | |||
| matches = None, | |||
| exposure = None ) |
Return a selection of reference sources selected by some criteria.
Parameters
----------
sourceCat : `lsst.afw.table.SourceCatalog`
Catalog of sources to select from.
This catalog must be contiguous in memory.
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 769 of file sourceSelector.py.
769 def selectSources(self, sourceCat, matches=None, exposure=None):
770 """Return a selection of reference sources selected by some criteria.
771
772 Parameters
773 ----------
774 sourceCat : `lsst.afw.table.SourceCatalog`
775 Catalog of sources to select from.
776 This catalog must be contiguous in memory.
777 matches : `list` of `lsst.afw.table.ReferenceMatch` or None
778 Ignored in this SourceSelector.
779 exposure : `lsst.afw.image.Exposure` or None
780 The exposure the catalog was built from; used for debug display.
781
782 Returns
783 -------
784 struct : `lsst.pipe.base.Struct`
785 The struct contains the following data:
786
787 ``selected``
788 Boolean array of sources that were selected, same length as
789 sourceCat.
790 (`numpy.ndarray` of `bool`)
791 """
792 selected = np.ones(len(sourceCat), dtype=bool)
793 if self.config.doMagLimit:
794 selected &= self.config.magLimit.apply(sourceCat)
795 if self.config.doFlags:
796 selected &= self.config.flags.apply(sourceCat)
797 if self.config.doUnresolved:
798 selected &= self.config.unresolved.apply(sourceCat)
799 if self.config.doSignalToNoise:
800 selected &= self.config.signalToNoise.apply(sourceCat)
801 if self.config.doMagError:
802 selected &= self.config.magError.apply(sourceCat)
803 if self.config.doRequireFiniteRaDec:
804 selected &= self.config.requireFiniteRaDec.apply(sourceCat)
805 for limit in self.config.colorLimits.values():
806 selected &= limit.apply(sourceCat)
807 if self.config.doCullFromMaskedRegion:
808 selected &= self.config.cullFromMaskedRegion.apply(sourceCat, exposure)
809 self.log.info("Selected %d/%d references", selected.sum(), len(sourceCat))
810
811 return pipeBase.Struct(selected=selected)
812
813
814@pexConfig.registerConfigurable("null", sourceSelectorRegistry)
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/ga815be3f0b+911242149a/python/lsst/meas/algorithms/sourceSelector.py
Generated on Tue May 13 2025 08:22:31 for LSST Applications by
1.13.2