lsst.coadd.utils  16.0-5-g6a53317+27
coaddDataIdContainer.py
Go to the documentation of this file.
1 #
2 # LSST Data Management System
3 # Copyright 2008-2015 AURA/LSST.
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 __all__ = ["CoaddDataIdContainer", "ExistingCoaddDataIdContainer", "TractDataIdContainer"]
23 
24 import argparse
25 from collections import defaultdict
26 
27 import lsst.pipe.base as pipeBase
28 
29 
30 class CoaddDataIdContainer(pipeBase.DataIdContainer):
31  """A version of lsst.pipe.base.DataIdContainer specialized for coaddition.
32 
33  Required because butler.subset does not support patch and tract
34 
35  This code was originally in pipe_tasks (coaddBase.py)
36  """
37 
38  def getSkymap(self, namespace):
39  """Only retrieve skymap if required"""
40  if not hasattr(self, "_skymap"):
41  self._skymap = namespace.butler.get(namespace.config.coaddName + "Coadd_skyMap")
42  return self._skymap
43 
44  def makeDataRefList(self, namespace):
45  """Make self.refList from self.idList
46  """
47  validKeys = namespace.butler.getKeys(datasetType=self.datasetType, level=self.level)
48 
49  for dataId in self.idList:
50  for key in validKeys:
51  if key in ("tract", "patch"):
52  # Will deal with these explicitly
53  continue
54  if key not in dataId:
55  raise argparse.ArgumentError(None, "--id must include " + key)
56 
57  # tract and patch are required; iterate over them if not provided
58  if "tract" not in dataId:
59  if "patch" in dataId:
60  raise RuntimeError("'patch' cannot be specified without 'tract'")
61  addList = [dict(tract=tract.getId(), patch="%d,%d" % patch.getIndex(), **dataId)
62  for tract in self.getSkymap(namespace) for patch in tract]
63  elif "patch" not in dataId:
64  tract = self.getSkymap(namespace)[dataId["tract"]]
65  addList = [dict(patch="%d,%d" % patch.getIndex(), **dataId) for patch in tract]
66  else:
67  addList = [dataId]
68 
69  self.refList += [namespace.butler.dataRef(datasetType=self.datasetType, dataId=addId)
70  for addId in addList]
71 
72 
74  """A version of CoaddDataIdContainer that only produces references that exist"""
75 
76  def makeDataRefList(self, namespace):
77  super(ExistingCoaddDataIdContainer, self).makeDataRefList(namespace)
78  self.refList = [ref for ref in self.refList if ref.datasetExists()]
79 
80 
82 
83  def makeDataRefList(self, namespace):
84  """Make self.refList from self.idList
85  It's difficult to make a data reference that merely points to an entire
86  tract: there is no data product solely at the tract level. Instead, we
87  generate a list of data references for patches within the tract.
88  """
89  datasetType = namespace.config.coaddName + "Coadd"
90  validKeys = set(["tract", "filter", "patch", ])
91 
92  def getPatchRefList(tract):
93  return [namespace.butler.dataRef(datasetType=datasetType,
94  tract=tract.getId(),
95  filter=dataId["filter"],
96  patch="%d,%d" % patch.getIndex()) for patch in tract]
97 
98  tractRefs = defaultdict(list) # Data references for each tract
99  for dataId in self.idList:
100  for key in validKeys:
101  if key in ("tract", "patch",):
102  # Will deal with these explicitly
103  continue
104  if key not in dataId:
105  raise argparse.ArgumentError(None, "--id must include " + key)
106 
107  skymap = self.getSkymap(namespace)
108 
109  if "tract" in dataId:
110  tractId = dataId["tract"]
111  if "patch" in dataId:
112  tractRefs[tractId].append(namespace.butler.dataRef(datasetType=datasetType, tract=tractId,
113  filter=dataId['filter'],
114  patch=dataId['patch']))
115  else:
116  tractRefs[tractId] += getPatchRefList(skymap[tractId])
117  else:
118  tractRefs = dict((tract.getId(), tractRefs.get(tract.getId(), []) + getPatchRefList(tract))
119  for tract in skymap)
120 
121  self.refList = list(tractRefs.values())