lsst.meas.algorithms  16.0-17-g6a7bfb3b+12
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.matcherSourceSelector.MatcherPessimisticSourceSelectorTask Class Reference
Inheritance diagram for lsst.meas.algorithms.matcherSourceSelector.MatcherPessimisticSourceSelectorTask:
lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask

Public Member Functions

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

Public Attributes

 edgeKey
 
 interpolatedCenterKey
 
 saturatedKey
 
 parentKey
 
 centroidXKey
 
 centroidYKey
 
 centroidFlagKey
 
 fluxField
 
 fluxKey
 
 fluxFlagKey
 
 fluxErrKey
 

Static Public Attributes

 ConfigClass = MatcherSourceSelectorConfig
 
bool usesMatches = False
 

Detailed Description

Select sources that are useful for matching.

Good matching sources have high signal/noise, are non-blended. They need not
be PSF sources, just have reliable centroids. This inherited class adds
the removal of saturated, interpolated, and edge_key objects to the set of
bad flags. It is a temporary addition designed preserve the source selction
used in matchOptimisticB. Once matchPessimisticB is adopted as the default
source selector the class will be removed and the saturated, interpoalted, and
edge_key flags will be added to the matcherSourceSelector class.

TODO: Once DM-10399 is complete an RFC will be filed to make matchPessimisticB
the default matcher this class will replace matcherSourceSelector with this source
selector resulting in only one matcherSourceSeletor. The ticket describing
this work is DM-10800.

Definition at line 137 of file matcherSourceSelector.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`
    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`
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 69 of file sourceSelector.py.

◆ selectSources()

def lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.selectSources (   self,
  sourceCat,
  matches = None,
  exposure = None 
)
inherited
Return a selection of sources that are useful for matching.

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.

Definition at line 60 of file matcherSourceSelector.py.

Member Data Documentation

◆ centroidFlagKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.centroidFlagKey
inherited

Definition at line 92 of file matcherSourceSelector.py.

◆ centroidXKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.centroidXKey
inherited

Definition at line 90 of file matcherSourceSelector.py.

◆ centroidYKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.centroidYKey
inherited

Definition at line 91 of file matcherSourceSelector.py.

◆ ConfigClass

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.ConfigClass = MatcherSourceSelectorConfig
staticinherited

Definition at line 55 of file matcherSourceSelector.py.

◆ edgeKey

lsst.meas.algorithms.matcherSourceSelector.MatcherPessimisticSourceSelectorTask.edgeKey

Definition at line 157 of file matcherSourceSelector.py.

◆ fluxErrKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.fluxErrKey
inherited

Definition at line 98 of file matcherSourceSelector.py.

◆ fluxField

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.fluxField
inherited

Definition at line 95 of file matcherSourceSelector.py.

◆ fluxFlagKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.fluxFlagKey
inherited

Definition at line 97 of file matcherSourceSelector.py.

◆ fluxKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.fluxKey
inherited

Definition at line 96 of file matcherSourceSelector.py.

◆ interpolatedCenterKey

lsst.meas.algorithms.matcherSourceSelector.MatcherPessimisticSourceSelectorTask.interpolatedCenterKey

Definition at line 158 of file matcherSourceSelector.py.

◆ parentKey

lsst.meas.algorithms.matcherSourceSelector.MatcherSourceSelectorTask.parentKey
inherited

Definition at line 89 of file matcherSourceSelector.py.

◆ saturatedKey

lsst.meas.algorithms.matcherSourceSelector.MatcherPessimisticSourceSelectorTask.saturatedKey

Definition at line 159 of file matcherSourceSelector.py.

◆ usesMatches

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

Definition at line 64 of file sourceSelector.py.


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