lsst.meas.algorithms  15.0-10-g113cadf7
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...
 
def run (self, exposure, sourceCat, matches=None, isStarField=None)
 

Static Public Attributes

 ConfigClass = ObjectSizeStarSelectorConfig
 
bool usesMatches = False
 

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 281 of file objectSizeStarSelector.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.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 343 of file objectSizeStarSelector.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 340 of file objectSizeStarSelector.py.

◆ usesMatches

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

Definition at line 341 of file objectSizeStarSelector.py.


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