lsst.meas.algorithms  14.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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:

Public Member Functions

def selectStars
 Return a list of PSF candidates that represent likely stars. More...
 

Static Public Attributes

 ConfigClass = SecondMomentStarSelectorConfig
 
 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:

1 import lsstDebug
2 def DebugInfo(name):
3  di = lsstDebug.getInfo(name) # N.b. lsstDebug.Info(name) would call us recursively
4  if name.endswith("catalogStarSelector"):
5  di.display = True
6 
7  return di
8 
9 lsstDebug.Info = DebugInfo

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

Definition at line 136 of file secondMomentStarSelector.py.

Member Function Documentation

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 195 of file secondMomentStarSelector.py.

Member Data Documentation

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

Definition at line 192 of file secondMomentStarSelector.py.

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

Definition at line 193 of file secondMomentStarSelector.py.


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