lsst.meas.algorithms  15.0-10-g113cadf7+3
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.flaggedStarSelector.FlaggedStarSelectorTask Class Reference

A trivial StarSelector that simply uses an existing flag field to filter a SourceCatalog. More...

Inheritance diagram for lsst.meas.algorithms.flaggedStarSelector.FlaggedStarSelectorTask:
lsst.meas.algorithms.starSelector.BaseStarSelectorTask

Public Member Functions

def __init__ (self, schema, kwds)
 
def selectStars (self, exposure, sourceCat, matches=None)
 
def run (self, exposure, sourceCat, matches=None, isStarField=None)
 

Public Attributes

 key
 

Static Public Attributes

bool usesMatches = False
 
 ConfigClass = FlaggedStarSelectorConfig
 

Detailed Description

A trivial StarSelector 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 stars to use the set of stars used to determine the PSF.

Definition at line 39 of file flaggedStarSelector.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.flaggedStarSelector.FlaggedStarSelectorTask.__init__ (   self,
  schema,
  kwds 
)

Definition at line 51 of file flaggedStarSelector.py.

Member Function Documentation

◆ run()

def lsst.meas.algorithms.starSelector.BaseStarSelectorTask.run (   self,
  exposure,
  sourceCat,
  matches = None,
  isStarField = None 
)
inherited
Select stars and set a flag field True for stars in the input catalog.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    the exposure containing the sources
sourceCat : `lsst.afw.table.SourceCatalog`
    catalog of sources that may be stars
matches : `lsst.afw.table.ReferenceMatchVector` or None
    astrometric matches; ignored by this star selector. Some star selectors
    will ignore this argument, others may require it. See the
    usesMatches class variable.
isStarField : `str`
    name of flag field to set True for stars, or None to not set a field;
    the field is left unchanged for non-stars

Returns
-------
struct : `lsst.pipe.base.Struct`
Result struct containing:

    - starCat  catalog of stars that were selected as stars and successfuly made into PSF candidates
        (a subset of sourceCat whose records are shallow copies)

Definition at line 63 of file starSelector.py.

◆ selectStars()

def lsst.meas.algorithms.flaggedStarSelector.FlaggedStarSelectorTask.selectStars (   self,
  exposure,
  sourceCat,
  matches = None 
)

Definition at line 55 of file flaggedStarSelector.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.flaggedStarSelector.FlaggedStarSelectorTask.ConfigClass = FlaggedStarSelectorConfig
static

Definition at line 49 of file flaggedStarSelector.py.

◆ key

lsst.meas.algorithms.flaggedStarSelector.FlaggedStarSelectorTask.key

Definition at line 53 of file flaggedStarSelector.py.

◆ usesMatches

bool lsst.meas.algorithms.flaggedStarSelector.FlaggedStarSelectorTask.usesMatches = False
static

Definition at line 48 of file flaggedStarSelector.py.


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