lsst.meas.algorithms  13.0-24-g22030a45+9
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask Class Reference

Base class for source selectors. More...

Inheritance diagram for lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask:
lsst.meas.algorithms.astrometrySourceSelector.AstrometrySourceSelectorTask lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask lsst.meas.algorithms.matcherSourceSelector.MatcherPessimisticSourceSelectorTask

Public Member Functions

def __init__ (self, kwargs)
 Initialize a source selector. More...
 
def run (self, sourceCat, maskedImage=None, kwargs)
 Select sources and return them. More...
 
def selectSources (self, sourceCat, matches=None)
 Return a catalog of sources: a subset of sourceCat. More...
 

Static Public Attributes

 ConfigClass = BaseSourceSelectorConfig
 

Detailed Description

Base class for source selectors.

Register all source selectors with the sourceSelectorRegistry using: sourceSelectorRegistry.register(name, class)

Definition at line 50 of file sourceSelector.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.__init__ (   self,
  kwargs 
)

Initialize a source selector.

Definition at line 60 of file sourceSelector.py.

Member Function Documentation

◆ run()

def lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.run (   self,
  sourceCat,
  maskedImage = None,
  kwargs 
)

Select sources and return them.

Parameters
[in]sourceCatcatalog of sources that may be sources (an lsst.afw.table.SourceCatalog)
[in]maskedImagethe maskedImage containing the sources, for plotting.
Returns
an lsst.pipe.base.Struct containing:
  • sourceCat catalog of sources that were selected

Definition at line 64 of file sourceSelector.py.

◆ selectSources()

def lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.selectSources (   self,
  sourceCat,
  matches = None 
)

Return a catalog of sources: a subset of sourceCat.

Parameters
[in]sourceCatcatalog of sources that may be sources (an lsst.afw.table.SourceCatalog)
Returns
a pipeBase.Struct containing:
  • sourceCat a catalog of sources

Definition at line 76 of file sourceSelector.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.ConfigClass = BaseSourceSelectorConfig
static

Definition at line 57 of file sourceSelector.py.


The documentation for this class was generated from the following file: