LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
starSelectorRegistry.py
Go to the documentation of this file.
1 #
2 # LSST Data Management System
3 # Copyright 2008, 2009, 2010 LSST Corporation.
4 #
5 # This product includes software developed by the
6 # LSST Project (http://www.lsst.org/).
7 #
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the LSST License Statement and
19 # the GNU General Public License along with this program. If not,
20 # see <http://www.lsstcorp.org/LegalNotices/>.
21 #
22 from lsst.pex.config import makeRegistry
23 from .secondMomentStarSelector import SecondMomentStarSelector
24 from .sizeMagnitudeStarSelectorFactory import sizeMagnitudeStarSelectorFactory
25 
26 __all__ = ["starSelectorRegistry"]
27 
28 starSelectorRegistry = makeRegistry(
29  '''A registry of star selector factories
30 
31  A star selector factory makes a class with the following API:
32 
33  def __init__(self, config):
34  """Construct a star selector
35 
36  @param[in] config: an instance of pexConfig.Config that configures this algorithm
37  """
38 
39  def selectStars(self, exposure, sourceList):
40  """Return a list of PSF candidates that represent likely stars
41 
42  The list of PSF candidates may be used by a PSF fitter to construct a PSF.
43 
44  @param[in] exposure: the exposure containing the sources (lsst.afw.image.Exposure)
45  @param[in] sourceList: a list of sources that may be stars (lsst.afw.detection.SourceSet)
46 
47  @return psfCandidateList: a list of PSF candidates (each an lsst.meas.algorithms.PsfCandidate)
48  """
49  '''
50 )
51 
52 starSelectorRegistry.register("secondMoment", SecondMomentStarSelector)
53 starSelectorRegistry.register("sizeMagnitude", sizeMagnitudeStarSelectorFactory)