lsst.meas.algorithms  14.0-7-g23fdbe95+15
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.starSelector.BaseStarSelectorTask Class Reference

Base class for star selectors. More...

Inheritance diagram for lsst.meas.algorithms.starSelector.BaseStarSelectorTask:
lsst.meas.algorithms.flaggedStarSelector.FlaggedStarSelectorTask lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask lsst.meas.algorithms.secondMomentStarSelector.SecondMomentStarSelectorTask

Public Member Functions

def __init__ (self, schema, kwds)
 
def run (self, exposure, sourceCat, matches=None, isStarField=None)
 Select stars, make PSF candidates, and set a flag field True for stars in the input catalog. More...
 
def selectStars (self, exposure, sourceCat, matches=None)
 Return a catalog of stars: a subset of sourceCat whose records are shallow copies. More...
 
def makePsfCandidates (self, exposure, starCat)
 Make a list of PSF candidates from a star catalog. More...
 

Static Public Attributes

bool usesMatches = False
 
 ConfigClass = BaseStarSelectorConfig
 

Detailed Description

Base class for star selectors.

Register all star selectors with the starSelectorRegistry using: starSelectorRegistry.register(name, class)

Definition at line 64 of file starSelector.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.starSelector.BaseStarSelectorTask.__init__ (   self,
  schema,
  kwds 
)

Definition at line 75 of file starSelector.py.

Member Function Documentation

◆ makePsfCandidates()

def lsst.meas.algorithms.starSelector.BaseStarSelectorTask.makePsfCandidates (   self,
  exposure,
  starCat 
)

Make a list of PSF candidates from a star catalog.

Parameters
[in]exposurethe exposure containing the sources
[in]starCatcatalog of stars (an lsst.afw.table.SourceCatalog), e.g. as returned by the run or selectStars method
Returns
an lsst.pipe.base.Struct with fields:
  • psfCandidates list of PSF candidates (lsst.meas.algorithms.PsfCandidate)
  • goodStarCat catalog of stars that were successfully made into PSF candidates (a subset of starCat)

Definition at line 128 of file starSelector.py.

◆ run()

def lsst.meas.algorithms.starSelector.BaseStarSelectorTask.run (   self,
  exposure,
  sourceCat,
  matches = None,
  isStarField = None 
)

Select stars, make PSF candidates, and set a flag field True for stars in the input catalog.

Parameters
[in]exposurethe exposure containing the sources
[in]sourceCatcatalog of sources that may be stars (an lsst.afw.table.SourceCatalog)
[in]matchesastrometric matches; ignored by this star selector (an lsst.afw.table.ReferenceMatchVector), or None. Some star selectors will ignore this argument, others may require it. See the usesMatches class variable.
[in]isStarFieldname of flag field to set True for stars, or None to not set a field; the field is left unchanged for non-stars
Returns
an lsst.pipe.base.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)
  • psfCandidates list of PSF candidates (lsst.meas.algorithms.PsfCandidate)

Definition at line 80 of file starSelector.py.

◆ selectStars()

def lsst.meas.algorithms.starSelector.BaseStarSelectorTask.selectStars (   self,
  exposure,
  sourceCat,
  matches = None 
)

Return a catalog of stars: a subset of sourceCat whose records are shallow copies.

Parameters
[in]exposurethe exposure containing the sources
[in]sourceCatcatalog of sources that may be stars (an lsst.afw.table.SourceCatalog)
[in]matchesastrometric matches; ignored by this star selector (an lsst.afw.table.ReferenceMatchVector), or None. Some star selectors will ignore this argument, others may require it. See the usesMatches class variable.
Warning
The returned catalog must have records that are shallow copies (fortunately this is the default behavior when you add a record from one catalog to another); otherwise the run method cannot set the isStarField flag in the original source catalog.
Returns
a pipeBase.Struct containing:
  • starCat a catalog of stars (a subset of sourceCat whose records are shallow copies)

Definition at line 110 of file starSelector.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.starSelector.BaseStarSelectorTask.ConfigClass = BaseStarSelectorConfig
static

Definition at line 72 of file starSelector.py.

◆ usesMatches

bool lsst.meas.algorithms.starSelector.BaseStarSelectorTask.usesMatches = False
static

Definition at line 71 of file starSelector.py.


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