lsst.afw  22.0.1-27-ga185acb71+cd0c1e0a06
_footprintMerge.py
Go to the documentation of this file.
1 # This file is part of afw.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (http://www.lsst.org).
6 # See the COPYRIGHT file at the top-level directory of this distribution
7 # for details of code ownership.
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 GNU General Public License
20 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 
22 __all__ = [] # only imported for side effects
23 
24 from lsst.utils import continueClass
25 from ._detection import FootprintMergeList
26 
27 
28 @continueClass # noqa: F811 (FIXME: remove for py 3.8+)
29 class FootprintMergeList: # noqa: F811
30  def getMergedSourceCatalog(self, catalogs, filters,
31  peakDist, schema, idFactory, samePeakDist):
32  """Add multiple catalogs and get the SourceCatalog with merged Footprints
33 
34  Parameters
35  ----------
36  catalogs : `list` [`lsst.afw.table.SourceCatalog`]
37  list of catalogs
38  filters : `list` [`str`]
39  list of filters
40  peakDist : `float` or `list` [`float`]
41  distance between source peaks
42  schema : `lsst.afw.table.Schema`
43  idFactory : `lsst.afw.table.IdFactory`
44  samePeakDist : `float` or `list [`float`]
45  distance between source peaks (check)
46 
47  Returns
48  -------
49  mergedList : `lsst.afw.table.SourceCatalog`
50  merged list of sources
51 
52  See also
53  --------
54  lsst.afw.table.SourceTable
55 
56  """
57 
58  import lsst.afw.table as afwTable
59 
60  table = afwTable.SourceTable.make(schema, idFactory)
61  mergedList = afwTable.SourceCatalog(table)
62 
63  # if peak is not an array, create an array the size of catalogs
64  try:
65  len(samePeakDist)
66  except TypeError:
67  samePeakDist = [samePeakDist] * len(catalogs)
68 
69  try:
70  len(peakDist)
71  except TypeError:
72  peakDist = [peakDist] * len(catalogs)
73 
74  if len(peakDist) != len(catalogs):
75  raise ValueError("Number of catalogs (%d) does not match length of peakDist (%d)"
76  % (len(catalogs), len(peakDist)))
77 
78  if len(samePeakDist) != len(catalogs):
79  raise ValueError("Number of catalogs (%d) does not match length of samePeakDist (%d)"
80  % (len(catalogs), len(samePeakDist)))
81 
82  if len(filters) != len(catalogs):
83  raise ValueError("Number of catalogs (%d) does not match number of filters (%d)"
84  % (len(catalogs), len(filters)))
85 
86  self.clearCatalog()
87  for cat, filter, dist, sameDist in zip(catalogs, filters, peakDist, samePeakDist):
88  self.addCatalog(table, cat, filter, dist, True, sameDist)
89 
90  self.getFinalSources(mergedList)
91  return mergedList
def getMergedSourceCatalog(self, catalogs, filters, peakDist, schema, idFactory, samePeakDist)