lsst.meas.algorithms g04242d3e92+8eaa23c173
Loading...
Searching...
No Matches
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:
lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask

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.

Member Data Documentation

◆ _DefaultName

str lsst.meas.algorithms.flaggedSourceSelector.FlaggedSourceSelectorTask._DefaultName = "flagged"
staticprotected

Definition at line 57 of file flaggedSourceSelector.py.

◆ ConfigClass

lsst.meas.algorithms.flaggedSourceSelector.FlaggedSourceSelectorTask.ConfigClass = FlaggedSourceSelectorConfig
static

Definition at line 56 of file flaggedSourceSelector.py.


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