|
def | __init__ (self, schema, **kwds) |
|
def | run (self, exposure, sourceCat, matches=None, isStarField=None) |
|
def | selectStars (self, exposure, sourceCat, matches=None) |
|
Base class for star selectors
Register all star selectors with the starSelectorRegistry using:
starSelectorRegistry.register(name, class)
Definition at line 47 of file starSelector.py.
◆ __init__()
def lsst.meas.algorithms.starSelector.BaseStarSelectorTask.__init__ |
( |
|
self, |
|
|
|
schema, |
|
|
** |
kwds |
|
) |
| |
◆ run()
def lsst.meas.algorithms.starSelector.BaseStarSelectorTask.run |
( |
|
self, |
|
|
|
exposure, |
|
|
|
sourceCat, |
|
|
|
matches = None , |
|
|
|
isStarField = None |
|
) |
| |
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.starSelector.BaseStarSelectorTask.selectStars |
( |
|
self, |
|
|
|
exposure, |
|
|
|
sourceCat, |
|
|
|
matches = None |
|
) |
| |
Return a catalog of stars: a subset of sourceCat whose records are shallow copies
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.
Paramters
---------
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)
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.
Definition at line 98 of file starSelector.py.
◆ ConfigClass
◆ usesMatches
bool lsst.meas.algorithms.starSelector.BaseStarSelectorTask.usesMatches = False |
|
static |
The documentation for this class was generated from the following file: