Coverage for python/lsst/meas/algorithms/makePsfCandidates.py : 96%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
# # LSST Data Management System # # Copyright 2008-2017 AURA/LSST. # # This product includes software developed by the # LSST Project (http://www.lsst.org/). # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the LSST License Statement and # the GNU General Public License along with this program. If not, # see <https://www.lsstcorp.org/LegalNotices/>. #
doc="size of the kernel to create", dtype=int, default=21, ) doc="number of pixels to ignore around the edge of PSF candidate postage stamps", dtype=int, default=0, )
"""Create PSF candidates given an input catalog. """
"""Make a list of PSF candidates from a star catalog.
Parameters ---------- starCat : `lsst.afw.table.SourceCatalog` Catalog of stars, as returned by ``lsst.meas.algorithms.starSelector.run()``. exposure : `lsst.afw.image.Exposure` The exposure containing the sources. psfCandidateField : `str` or None Name of flag field to set True for PSF candidates, or None to not set a field; the field is left unchanged for non-candidates.
Returns ------- struct : `lsst.pipe.base.Struct` Results struct containing:
- ``psfCandidates`` : List of PSF candidates (`list` of `lsst.meas.algorithms.PsfCandidate`). - ``goodStarCat`` : Subset of ``starCat`` that was successfully made into PSF candidates (`lsst.afw.table.SourceCatalog`).
"""
"""Make a list of PSF candidates from a star catalog.
Parameters ---------- starCat : `lsst.afw.table.SourceCatalog` Catalog of stars, as returned by ``lsst.meas.algorithms.starSelector.run()``. exposure : `lsst.afw.image.Exposure` The exposure containing the sources.
Returns ------- struct : `lsst.pipe.base.Struct` Results struct containing:
- ``psfCandidates`` : List of PSF candidates (`list` of `lsst.meas.algorithms.PsfCandidate`). - ``goodStarCat`` : Subset of ``starCat`` that was successfully made into PSF candidates (`lsst.afw.table.SourceCatalog`). """
# The setXXX methods are class static, but it's convenient to call them on # an instance as we don't know exposures's pixel type # (and hence psfCandidate's exact type)
continue
psfCandidates=psfCandidateList, goodStarCat=goodStarCat, ) |