BaseStarSelectorTask

class lsst.meas.algorithms.BaseStarSelectorTask(schema, **kwds)

Bases: Task

Base class for star selectors

Register all star selectors with the starSelectorRegistry using:

starSelectorRegistry.register(name, class)

Attributes Summary

usesMatches

Methods Summary

run(exposure, sourceCat[, matches, isStarField])	Select stars and set a flag field True for stars in the input catalog.
selectStars(exposure, sourceCat[, matches])	Return a catalog of stars: a subset of sourceCat whose records are shallow copies

Attributes Documentation

usesMatches = False

Methods Documentation

run(exposure, sourceCat, matches=None, isStarField=None)

Select stars and set a flag field True for stars in the input catalog.

Parameters

exposurelsst.afw.image.Exposure

the exposure containing the sources

sourceCatlsst.afw.table.SourceCatalog

catalog of sources that may be stars

matcheslsst.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.

isStarFieldstr

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)

abstract selectStars(exposure, sourceCat, matches=None)

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

Parameters

exposurelsst.afw.image.Exposure

The exposure containing the sources.

sourceCatlsst.afw.table.SourceCatalog

Catalog of sources that may be stars.

matcheslsst.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.

Returns

structlsst.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). (lsst.afw.table.SourceCatalog)

Notes

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.