lsst.meas.algorithms  13.0-24-g22030a45
flaggedStarSelector.py
Go to the documentation of this file.
1 #
2 # LSST Data Management System
3 #
4 # Copyright 2008-2017 AURA/LSST.
5 #
6 # This product includes software developed by the
7 # LSST Project (http://www.lsst.org/).
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the LSST License Statement and
20 # the GNU General Public License along with this program. If not,
21 # see <https://www.lsstcorp.org/LegalNotices/>.
22 #
23 __all__ = ("FlaggedStarSelectorConfig", "FlaggedStarSelectorTask")
24 
25 import lsst.pex.config
26 import lsst.afw.table
27 import lsst.pipe.base
28 
29 from .starSelector import BaseStarSelectorTask, starSelectorRegistry
30 
31 
32 class FlaggedStarSelectorConfig(BaseStarSelectorTask.ConfigClass):
33  field = lsst.pex.config.Field(
34  dtype=str, default="calib_psfUsed",
35  doc="Name of a flag field that is True for stars that should be used."
36  )
37 
38 
40  """!
41  A trivial StarSelector that simply uses an existing flag field to filter a SourceCatalog.
42 
43  This is most frequently used in steps that occur after the a PSF model has
44  been built, to allow other procedures that need stars to use the set of
45  stars used to determine the PSF.
46  """
47 
48  usesMatches = False # This selector does not require a match to an external catalog
49  ConfigClass = FlaggedStarSelectorConfig
50 
51  def __init__(self, schema, **kwds):
52  BaseStarSelectorTask.__init__(self, schema=schema, **kwds)
53  self.key = schema.find(self.config.field).key
54 
55  def selectStars(self, exposure, sourceCat, matches=None):
56  starCat = lsst.afw.table.SourceCatalog(sourceCat.table)
57  for record in sourceCat:
58  if record.get(self.key):
59  starCat.append(record)
60  return lsst.pipe.base.Struct(starCat=starCat)
61 
62 
63 starSelectorRegistry.register("flagged", FlaggedStarSelectorTask)
A trivial StarSelector that simply uses an existing flag field to filter a SourceCatalog.