Inheritance diagram for lsst.meas.algorithms.sourceSelector.ScienceSourceSelectorTask:

Public Member Functions
def	selectSources (self, sourceCat, matches=None, exposure=None)

def	run (self, sourceCat, sourceSelectedField=None, matches=None, exposure=None)

Static Public Attributes
	ConfigClass = ScienceSourceSelectorConfig

bool	usesMatches = False

Detailed Description

Science source selector

By "science" sources, we mean sources that are on images that we
are processing, as opposed to sources from reference catalogs.

This selects (science) sources by (optionally) applying each of a
magnitude limit, flag requirements and star/galaxy separation.

Definition at line 508 of file sourceSelector.py.

Member Function Documentation

◆ run()

def lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.run	(	self,
		sourceCat,
		sourceSelectedField = `None`,
		matches = `None`,
		exposure = `None`
	)

inherited

Select sources and return them.

The input catalog must be contiguous in memory.

Parameters:
-----------
sourceCat : `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
            or `astropy.table.Table`
    Catalog of sources to select from.
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.

Return
------
struct : `lsst.pipe.base.Struct`
    The struct contains the following data:

    - sourceCat : `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
                  or `astropy.table.Table`
        The catalog of sources that were selected.
        (may not be memory-contiguous)
    - selected : `numpy.ndarray` of `bool``
        Boolean array of sources that were selected, same length as
        sourceCat.

Raises
------
RuntimeError
    Raised if ``sourceCat`` is not contiguous.

Definition at line 71 of file sourceSelector.py.

     def run(self, sourceCat, sourceSelectedField=None, matches=None, exposure=None):
         """Select sources and return them.
  
         The input catalog must be contiguous in memory.
  
         Parameters:
         -----------
         sourceCat : `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
                     or `astropy.table.Table`
             Catalog of sources to select from.
         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.
  
         Return
         ------
         struct : `lsst.pipe.base.Struct`
             The struct contains the following data:
  
             - sourceCat : `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
                           or `astropy.table.Table`
                 The catalog of sources that were selected.
                 (may not be memory-contiguous)
             - selected : `numpy.ndarray` of `bool``
                 Boolean array of sources that were selected, same length as
                 sourceCat.
  
         Raises
         ------
         RuntimeError
             Raised if ``sourceCat`` is not contiguous.
         """
         if hasattr(sourceCat, 'isContiguous'):
             # Check for continuity on afwTable catalogs
             if not sourceCat.isContiguous():
                 raise RuntimeError("Input catalogs for source selection must be contiguous.")
  
         result = self.selectSources(sourceCat=sourceCat,
                                     exposure=exposure,
                                     matches=matches)
  
         if sourceSelectedField is not None:
             if isinstance(sourceCat, (pandas.DataFrame, astropy.table.Table)):
                 sourceCat[sourceSelectedField] = result.selected
             else:
                 source_selected_key = \
                     sourceCat.getSchema()[sourceSelectedField].asKey()
                 # TODO: Remove for loop when DM-6981 is completed.
                 for source, flag in zip(sourceCat, result.selected):
                     source.set(source_selected_key, bool(flag))
         return pipeBase.Struct(sourceCat=sourceCat[result.selected],
                                selected=result.selected)
  

◆ selectSources()

def lsst.meas.algorithms.sourceSelector.ScienceSourceSelectorTask.selectSources	(	self,
		sourceCat,
		matches = `None`,
		exposure = `None`
	)

Return a selection of sources selected by specified 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.

Return
------
struct : `lsst.pipe.base.Struct`
    The struct contains the following data:

    - selected : `array` of `bool``
        Boolean array of sources that were selected, same length as
        sourceCat.

Reimplemented from lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.

Definition at line 519 of file sourceSelector.py.

     def selectSources(self, sourceCat, matches=None, exposure=None):
         """Return a selection of sources selected by specified 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.
  
         Return
         ------
         struct : `lsst.pipe.base.Struct`
             The struct contains the following data:
  
             - selected : `array` of `bool``
                 Boolean array of sources that were selected, same length as
                 sourceCat.
         """
         selected = np.ones(len(sourceCat), dtype=bool)
         if self.config.doFluxLimit:
             selected &= self.config.fluxLimit.apply(sourceCat)
         if self.config.doFlags:
             selected &= self.config.flags.apply(sourceCat)
         if self.config.doUnresolved:
             selected &= self.config.unresolved.apply(sourceCat)
         if self.config.doSignalToNoise:
             selected &= self.config.signalToNoise.apply(sourceCat)
         if self.config.doIsolated:
             selected &= self.config.isolated.apply(sourceCat)
  
         self.log.info("Selected %d/%d sources", selected.sum(), len(sourceCat))
  
         return pipeBase.Struct(selected=selected)
  
  

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.sourceSelector.ScienceSourceSelectorTask.ConfigClass = ScienceSourceSelectorConfig

static

Definition at line 517 of file sourceSelector.py.

◆ usesMatches

bool lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.usesMatches = False

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-0.7.0/Linux64/meas_algorithms/22.0.1-32-gf62ce7b1+aa4237961e/python/lsst/meas/algorithms/sourceSelector.py

Public Member Functions