Hide keyboard shortcuts

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

1# This file is part of obs_lsst. 

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__ = ("LsstCam", "LsstCamImSim", "LsstCamPhoSim", "LsstTS8", 

23 "Latiss", "LsstTS3", "LsstUCDCam", "LsstComCam") 

24 

25import os.path 

26 

27import lsst.obs.base.yamlCamera as yamlCamera 

28from lsst.daf.butler.core.utils import getFullTypeName 

29from lsst.utils import getPackageDir 

30from lsst.obs.base import Instrument 

31from lsst.obs.base.gen2to3 import TranslatorFactory 

32from .filters import (LSSTCAM_FILTER_DEFINITIONS, LATISS_FILTER_DEFINITIONS, 

33 LSSTCAM_IMSIM_FILTER_DEFINITIONS, TS3_FILTER_DEFINITIONS, 

34 TS8_FILTER_DEFINITIONS, COMCAM_FILTER_DEFINITIONS, 

35 ) 

36 

37from .translators import LatissTranslator, LsstCamTranslator, \ 

38 LsstUCDCamTranslator, LsstTS3Translator, LsstComCamTranslator, \ 

39 LsstCamPhoSimTranslator, LsstTS8Translator, LsstCamImSimTranslator 

40 

41PACKAGE_DIR = getPackageDir("obs_lsst") 

42 

43 

44class LsstCam(Instrument): 

45 """Gen3 Butler specialization for the LSST Main Camera. 

46 

47 Parameters 

48 ---------- 

49 camera : `lsst.cameraGeom.Camera` 

50 Camera object from which to extract detector information. 

51 filters : `list` of `FilterDefinition` 

52 An ordered list of filters to define the set of PhysicalFilters 

53 associated with this instrument in the registry. 

54 

55 While both the camera geometry and the set of filters associated with a 

56 camera are expected to change with time in general, their Butler Registry 

57 representations defined by an Instrument do not. Instead: 

58 

59 - We only extract names, IDs, and purposes from the detectors in the 

60 camera, which should be static information that actually reflects 

61 detector "slots" rather than the physical sensors themselves. Because 

62 the distinction between physical sensors and slots is unimportant in 

63 the vast majority of Butler use cases, we just use "detector" even 

64 though the concept really maps better to "detector slot". Ideally in 

65 the future this distinction between static and time-dependent 

66 information would be encoded in cameraGeom itself (e.g. by making the 

67 time-dependent Detector class inherit from a related class that only 

68 carries static content). 

69 

70 - The Butler Registry is expected to contain physical_filter entries for 

71 all filters an instrument has ever had, because we really only care 

72 about which filters were used for particular observations, not which 

73 filters were *available* at some point in the past. And changes in 

74 individual filters over time will be captured as changes in their 

75 TransmissionCurve datasets, not changes in the registry content (which 

76 is really just a label). While at present Instrument and Registry 

77 do not provide a way to add new physical_filters, they will in the 

78 future. 

79 """ 

80 filterDefinitions = LSSTCAM_FILTER_DEFINITIONS 

81 instrument = "LSSTCam" 

82 policyName = "lsstCam" 

83 translatorClass = LsstCamTranslator 

84 obsDataPackage = "obs_lsst_data" 

85 

86 @property 

87 def configPaths(self): 

88 return [os.path.join(PACKAGE_DIR, "config"), 

89 os.path.join(PACKAGE_DIR, "config", self.policyName)] 

90 

91 @classmethod 

92 def getName(cls): 

93 # Docstring inherited from Instrument.getName 

94 return cls.instrument 

95 

96 @classmethod 

97 def getCamera(cls): 

98 # Constructing a YAML camera takes a long time but we rely on 

99 # yamlCamera to cache for us. 

100 cameraYamlFile = os.path.join(PACKAGE_DIR, "policy", f"{cls.policyName}.yaml") 

101 camera = yamlCamera.makeCamera(cameraYamlFile) 

102 if camera.getName() != cls.getName(): 

103 raise RuntimeError(f"Expected to read camera geometry for {cls.instrument}" 

104 f" but instead got geometry for {camera.getName()}") 

105 return camera 

106 

107 def getRawFormatter(self, dataId): 

108 # Docstring inherited from Instrument.getRawFormatter 

109 # local import to prevent circular dependency 

110 from .rawFormatter import LsstCamRawFormatter 

111 return LsstCamRawFormatter 

112 

113 def register(self, registry, update=False): 

114 # Docstring inherited from Instrument.register 

115 # The maximum values below make Gen3's ObservationDataIdPacker produce 

116 # outputs that match Gen2's ccdExposureId. 

117 obsMax = self.translatorClass.max_exposure_id() 

118 with registry.transaction(): 

119 registry.syncDimensionData( 

120 "instrument", 

121 { 

122 "name": self.getName(), 

123 "detector_max": self.translatorClass.DETECTOR_MAX, 

124 "visit_max": obsMax, 

125 "exposure_max": obsMax, 

126 "class_name": getFullTypeName(self), 

127 }, 

128 update=update 

129 ) 

130 for detector in self.getCamera(): 

131 registry.syncDimensionData("detector", self.extractDetectorRecord(detector), update=update) 

132 

133 self._registerFilters(registry, update=update) 

134 

135 def extractDetectorRecord(self, camGeomDetector): 

136 """Create a Gen3 Detector entry dict from a cameraGeom.Detector. 

137 """ 

138 # All of the LSST instruments have detector names like R??_S??; we'll 

139 # split them up here, and instruments with only one raft can override 

140 # to change the group to something else if desired. 

141 # Long-term, we should get these fields into cameraGeom separately 

142 # so there's no need to specialize at this stage. 

143 # They are separate in ObservationInfo 

144 group, name = camGeomDetector.getName().split("_") 

145 

146 # getType() returns a pybind11-wrapped enum, which unfortunately 

147 # has no way to extract the name of just the value (it's always 

148 # prefixed by the enum type name). 

149 purpose = str(camGeomDetector.getType()).split(".")[-1] 

150 

151 return dict( 

152 instrument=self.getName(), 

153 id=camGeomDetector.getId(), 

154 full_name=camGeomDetector.getName(), 

155 name_in_raft=name, 

156 purpose=purpose, 

157 raft=group, 

158 ) 

159 

160 def makeDataIdTranslatorFactory(self) -> TranslatorFactory: 

161 # Docstring inherited from lsst.obs.base.Instrument. 

162 factory = TranslatorFactory() 

163 factory.addGenericInstrumentRules(self.getName(), detectorKey="detector", exposureKey="expId") 

164 return factory 

165 

166 

167class LsstComCam(LsstCam): 

168 """Gen3 Butler specialization for ComCam data. 

169 """ 

170 

171 filterDefinitions = COMCAM_FILTER_DEFINITIONS 

172 instrument = "LSSTComCam" 

173 policyName = "comCam" 

174 translatorClass = LsstComCamTranslator 

175 

176 def getRawFormatter(self, dataId): 

177 # local import to prevent circular dependency 

178 from .rawFormatter import LsstComCamRawFormatter 

179 return LsstComCamRawFormatter 

180 

181 

182class LsstCamImSim(LsstCam): 

183 """Gen3 Butler specialization for ImSim simulations. 

184 """ 

185 

186 instrument = "LSSTCam-imSim" 

187 policyName = "imsim" 

188 translatorClass = LsstCamImSimTranslator 

189 filterDefinitions = LSSTCAM_IMSIM_FILTER_DEFINITIONS 

190 

191 def getRawFormatter(self, dataId): 

192 # local import to prevent circular dependency 

193 from .rawFormatter import LsstCamImSimRawFormatter 

194 return LsstCamImSimRawFormatter 

195 

196 

197class LsstCamPhoSim(LsstCam): 

198 """Gen3 Butler specialization for Phosim simulations. 

199 """ 

200 

201 instrument = "LSSTCam-PhoSim" 

202 policyName = "phosim" 

203 translatorClass = LsstCamPhoSimTranslator 

204 

205 def getRawFormatter(self, dataId): 

206 # local import to prevent circular dependency 

207 from .rawFormatter import LsstCamPhoSimRawFormatter 

208 return LsstCamPhoSimRawFormatter 

209 

210 

211class LsstTS8(LsstCam): 

212 """Gen3 Butler specialization for raft test stand data. 

213 """ 

214 

215 filterDefinitions = TS8_FILTER_DEFINITIONS 

216 instrument = "LSST-TS8" 

217 policyName = "ts8" 

218 translatorClass = LsstTS8Translator 

219 

220 def getRawFormatter(self, dataId): 

221 # local import to prevent circular dependency 

222 from .rawFormatter import LsstTS8RawFormatter 

223 return LsstTS8RawFormatter 

224 

225 

226class LsstUCDCam(LsstCam): 

227 """Gen3 Butler specialization for UCDCam test stand data. 

228 """ 

229 

230 instrument = "LSST-UCDCam" 

231 policyName = "ucd" 

232 translatorClass = LsstUCDCamTranslator 

233 

234 def getRawFormatter(self, dataId): 

235 # local import to prevent circular dependency 

236 from .rawFormatter import LsstUCDCamRawFormatter 

237 return LsstUCDCamRawFormatter 

238 

239 

240class LsstTS3(LsstCam): 

241 """Gen3 Butler specialization for TS3 test stand data. 

242 """ 

243 

244 filterDefinitions = TS3_FILTER_DEFINITIONS 

245 instrument = "LSST-TS3" 

246 policyName = "ts3" 

247 translatorClass = LsstTS3Translator 

248 

249 def getRawFormatter(self, dataId): 

250 # local import to prevent circular dependency 

251 from .rawFormatter import LsstTS3RawFormatter 

252 return LsstTS3RawFormatter 

253 

254 

255class Latiss(LsstCam): 

256 """Gen3 Butler specialization for AuxTel LATISS data. 

257 """ 

258 filterDefinitions = LATISS_FILTER_DEFINITIONS 

259 instrument = "LATISS" 

260 policyName = "latiss" 

261 translatorClass = LatissTranslator 

262 

263 def extractDetectorRecord(self, camGeomDetector): 

264 # Override to remove group (raft) name, because LATISS only has one 

265 # detector. 

266 record = super().extractDetectorRecord(camGeomDetector) 

267 record["raft"] = None 

268 record["name_in_raft"] = record["full_name"] 

269 return record 

270 

271 def getRawFormatter(self, dataId): 

272 # local import to prevent circular dependency 

273 from .rawFormatter import LatissRawFormatter 

274 return LatissRawFormatter