Skip to content

Commit

Permalink
Fixup: remove redundant documentation from starSelectorRegistry
Browse files Browse the repository at this point in the history
Now that stars selectors have an abstract base that fully documents
the API, there is no need to repeat that information in the
documentation for starSelectorRegistry
  • Loading branch information
r-owen committed Jun 9, 2016
1 parent 5f8d623 commit 1b54b51
Showing 1 changed file with 1 addition and 27 deletions.
28 changes: 1 addition & 27 deletions python/lsst/meas/algorithms/starSelector.py
Original file line number Diff line number Diff line change
Expand Up @@ -165,31 +165,5 @@ def makePsfCandidates(self, exposure, starCat):


starSelectorRegistry = pexConfig.makeRegistry(
'''A registry of star selectors
A star selector is a class with the following class variables and methods:
ConfigClass = configuration class, a subclass of lsst.pex.config.Config
usesMatches = True/False depending if selectStars uses its matches argument
def __init__(self, config):
"""Construct a star selector
@param[in] config: an instance of pexConfig.Config that configures this algorithm
"""
def selectStars(self, exposure, sourceCat, matches=None):
"""Return a list of PSF candidates that represent likely stars
The list of PSF candidates may be used by a PSF fitter to construct a PSF.
@param[in] exposure the exposure containing the sources (an lsst.afw.image.Exposure)
@param[in] sourceCat catalog of sources that may be stars (an lsst.afw.table.SourceCatalog)
@param[in] matches list of reference object/source matches
(an lsst.afw.table.ReferenceMatchVector), or None. Some star selectors
will ignore this argument, others may require it. See the usesMatches class variable.
@return psfCandidateList: a list of PSF candidates (each an lsst.meas.algorithms.PsfCandidate)
"""
'''
doc="A registry of star selectors (subclasses of BaseStarSelectorTask)",
)

0 comments on commit 1b54b51

Please sign in to comment.