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
psfDeterminerRegistry.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 .pcaPsfDeterminer import PcaPsfDeterminer
24 
25 __all__ = ["psfDeterminerRegistry"]
26 
27 psfDeterminerRegistry = makeRegistry(
28  '''A registry of PSF determiner factories
29 
30  A PSF determiner factory makes a class with the following API:
31 
32  def __init__(self, config, schema=None):
33  """Construct a PSF Determiner
34 
35  @param[in] config an instance of pexConfig.Config that configures this algorithm
36  @param[in,out] schema an instance of afw.table.Schema used for sources; passing a
37  schema allows the determiner to reserve a flag field to mark
38  stars used in PSF measurement
39  """
40 
41  def determinePsf(exposure, psfCandidateList, metadata=None):
42  """Determine a PSF model
43 
44  @param[in] exposure exposure containing the psf candidates (lsst.afw.image.Exposure)
45  @param[in] psfCandidateList: a sequence of PSF candidates (each an
46  lsst.meas.algorithms.PsfCandidate); typically obtained by
47  detecting sources and then running them through a star selector
48  @param[in,out] metadata a place to save interesting items
49 
50  @return
51  - psf: the fit PSF; a subclass of lsst.afw.detection.Psf
52  - cellSet: the spatial cell set used to determine the PSF (lsst.afw.math.SpatialCellSet)
53  """
54 '''
55 )
56 
57 psfDeterminerRegistry.register("pca", PcaPsfDeterminer)