lsst.meas.algorithms  13.0-18-gc4ad4228
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask Class Reference

A star selector that looks for a cluster of small objects in a size-magnitude plot. More...

Inheritance diagram for lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask:
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...
 
- Public Member Functions inherited from lsst.meas.algorithms.starSelector.BaseStarSelectorTask
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

 ConfigClass = ObjectSizeStarSelectorConfig
 
bool usesMatches = False
 
- Static Public Attributes inherited from lsst.meas.algorithms.starSelector.BaseStarSelectorTask
bool usesMatches = False
 
 ConfigClass = BaseStarSelectorConfig
 

Detailed Description

A star selector that looks for a cluster of small objects in a size-magnitude plot.

Contents

Description

A star selector that looks for a cluster of small objects in a size-magnitude plot.

Task initialisation

Invoking the Task

Like all star selectors, the main method is run.

Configuration parameters

See ObjectSizeStarSelectorConfig

Debug variables

ObjectSizeStarSelectorTask has a debug dictionary with the following keys:

display
bool; if True display debug information
displayExposure
bool; if True display the exposure and spatial cells
plotMagSize
bool: if True display the magnitude-size relation using matplotlib
dumpData
bool; if True dump data to a pickle file

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("objectSizeStarSelector"):
di.display = True
di.displayExposure = True
di.plotMagSize = True
return di
lsstDebug.Info = DebugInfo

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

Definition at line 290 of file objectSizeStarSelector.py.

Member Function Documentation

◆ selectStars()

def lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask.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 352 of file objectSizeStarSelector.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask.ConfigClass = ObjectSizeStarSelectorConfig
static

Definition at line 349 of file objectSizeStarSelector.py.

◆ usesMatches

bool lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask.usesMatches = False
static

Definition at line 350 of file objectSizeStarSelector.py.


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