lsst.meas.algorithms  14.0-9-g82279ae0+8
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.secondMomentStarSelector.SecondMomentStarSelectorTask Class Reference

A star selector based on second moments. More...

Inheritance diagram for lsst.meas.algorithms.secondMomentStarSelector.SecondMomentStarSelectorTask:
lsst.meas.algorithms.starSelector.BaseStarSelectorTask

Public Member Functions

def selectStars (self, exposure, sourceCat, matches=None)
 Return a list of PSF candidates that represent likely stars. More...
 
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 makePsfCandidates (self, exposure, starCat)
 Make a list of PSF candidates from a star catalog. More...
 

Static Public Attributes

 ConfigClass = SecondMomentStarSelectorConfig
 
bool usesMatches = False
 

Detailed Description

A star selector based on second moments.

Contents

Description

A star selector based on second moments.

Warning
This is a naive algorithm; use with caution.

Task initialisation

Invoking the Task

Like all star selectors, the main method is run.

Configuration parameters

See SecondMomentStarSelectorConfig

Debug variables

SecondMomentStarSelectorTask has a debug dictionary with the following keys:

display
bool; if True display debug information

display = lsstDebug.Info(name).display displayExposure = lsstDebug.Info(name).displayExposure pauseAtEnd = lsstDebug.Info(name).pauseAtEnd

For example, put something like:

import lsstDebug
def DebugInfo(name):
di = lsstDebug.getInfo(name) # N.b. lsstDebug.Info(name) would call us recursively
if name.endswith("catalogStarSelector"):
di.display = True
return di
lsstDebug.Info = DebugInfo

into your debug.py file and run your task with the --debug flag.

Definition at line 137 of file secondMomentStarSelector.py.

Member Function Documentation

◆ makePsfCandidates()

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

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 
)
inherited

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.secondMomentStarSelector.SecondMomentStarSelectorTask.selectStars (   self,
  exposure,
  sourceCat,
  matches = None 
)

Return a list of PSF candidates that represent likely stars.

A list of PSF candidates may be used by a PSF fitter to construct a PSF.

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
Returns
an lsst.pipe.base.Struct containing:
  • starCat catalog of selected stars (a subset of sourceCat)

Definition at line 196 of file secondMomentStarSelector.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.secondMomentStarSelector.SecondMomentStarSelectorTask.ConfigClass = SecondMomentStarSelectorConfig
static

Definition at line 193 of file secondMomentStarSelector.py.

◆ usesMatches

bool lsst.meas.algorithms.secondMomentStarSelector.SecondMomentStarSelectorTask.usesMatches = False
static

Definition at line 194 of file secondMomentStarSelector.py.


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