Coverage for tests/test_ingest.py: 56%

116 statements  

« prev     ^ index     » next       coverage.py v7.4.4, created at 2024-04-03 02:43 -0700

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"""Unit tests for LSST raw data ingest. 

23""" 

24 

25import unittest 

26import os 

27import tempfile 

28import lsst.utils.tests 

29 

30from lsst.afw.math import flipImage 

31from lsst.afw.cameraGeom import AmplifierGeometryComparison 

32from lsst.daf.butler import Butler, DataCoordinate 

33from lsst.daf.butler.cli.butler import cli as butlerCli 

34from lsst.daf.butler.cli.utils import LogCliRunner 

35from lsst.obs.base.ingest_tests import IngestTestBase 

36from lsst.ip.isr import PhotodiodeCalib 

37import lsst.afw.cameraGeom.testUtils # for injected test asserts 

38import lsst.obs.lsst 

39 

40TESTDIR = os.path.abspath(os.path.dirname(__file__)) 

41DATAROOT = os.path.join(TESTDIR, os.path.pardir, "data", "input") 

42 

43 

44class LatissIngestTestCase(IngestTestBase, lsst.utils.tests.TestCase): 

45 

46 curatedCalibrationDatasetTypes = ("camera", "defects") 

47 instrumentClassName = "lsst.obs.lsst.Latiss" 

48 ingestDir = TESTDIR 

49 file = os.path.join(DATAROOT, "latiss", "raw", "2018-09-20", "3018092000065-det000.fits") 

50 dataIds = [dict(instrument="LATISS", exposure=3018092000065, detector=0)] 

51 filterLabel = lsst.afw.image.FilterLabel(band="unknown", physical="unknown~unknown") 

52 

53 def checkRepo(self, files=None): 

54 # Test amp parameter implementation for the LSST raw formatter. This 

55 # is the same for all instruments, so repeating it in other test cases 

56 # is wasteful. 

57 butler = Butler(self.root, run=self.outputRun) 

58 ref = butler.find_dataset("raw", self.dataIds[0]) 

59 full_assembled = butler.get(ref) 

60 unassembled_detector = self.instrumentClass().getCamera()[ref.dataId["detector"]] 

61 assembled_detector = full_assembled.getDetector() 

62 for unassembled_amp, assembled_amp in zip(unassembled_detector, assembled_detector): 

63 # Check that we're testing what we think we're testing: these 

64 # amps should differ in assembly state (offsets, flips), and they 

65 # _may_ differ in fundamental geometry if we had to patch the 

66 # overscan region sizes. 

67 comparison = unassembled_amp.compareGeometry(assembled_amp) 

68 self.assertTrue(comparison & AmplifierGeometryComparison.ASSEMBLY_DIFFERS) 

69 assembled_subimage = butler.get(ref, parameters={"amp": assembled_amp}) 

70 unassembled_subimage = butler.get(ref, parameters={"amp": unassembled_amp.getName()}) 

71 self.assertEqual(len(assembled_subimage.getDetector()), 1) 

72 self.assertEqual(len(unassembled_subimage.getDetector()), 1) 

73 self.assertEqual(len(assembled_subimage.getDetector()), 1) 

74 self.assertEqual(len(unassembled_subimage.getDetector()), 1) 

75 self.assertImagesEqual(assembled_subimage.image, full_assembled.image[assembled_amp.getRawBBox()]) 

76 self.assertImagesEqual( 

77 unassembled_subimage.image, 

78 flipImage( 

79 full_assembled.image[assembled_amp.getRawBBox()], 

80 flipLR=unassembled_amp.getRawFlipX(), 

81 flipTB=unassembled_amp.getRawFlipY(), 

82 ), 

83 ) 

84 self.assertAmplifiersEqual(assembled_subimage.getDetector()[0], assembled_amp) 

85 if comparison & comparison.REGIONS_DIFFER: 

86 # We needed to patch overscans, but unassembled_amp (which 

87 # comes straight from the camera) won't have those patches, so 

88 # we can't compare it to the amp attached to 

89 # unassembled_subimage (which does have those patches). 

90 comparison2 = unassembled_subimage.getDetector()[0].compareGeometry(unassembled_amp) 

91 

92 self.assertTrue(comparison2 & AmplifierGeometryComparison.REGIONS_DIFFER) 

93 # ...and that unassembled_subimage's amp has the same regions 

94 # (after accounting for assembly/orientation) as assembled_amp. 

95 comparison3 = unassembled_subimage.getDetector()[0].compareGeometry(assembled_amp) 

96 self.assertTrue(comparison3 & AmplifierGeometryComparison.ASSEMBLY_DIFFERS) 

97 self.assertFalse(comparison3 & AmplifierGeometryComparison.REGIONS_DIFFER) 

98 else: 

99 self.assertAmplifiersEqual(unassembled_subimage.getDetector()[0], unassembled_amp) 

100 

101 

102class Ts3IngestTestCase(IngestTestBase, lsst.utils.tests.TestCase): 

103 

104 curatedCalibrationDatasetTypes = ("camera",) 

105 instrumentClassName = "lsst.obs.lsst.LsstTS3" 

106 ingestDir = TESTDIR 

107 file = os.path.join(DATAROOT, "ts3", "raw", "2018-11-15", "201811151255111-R433-S00-det433.fits") 

108 dataIds = [dict(instrument="LSST-TS3", exposure=201811151255111, detector=433)] 

109 filterLabel = lsst.afw.image.FilterLabel(physical="550CutOn") 

110 

111 

112class ComCamIngestTestCase(IngestTestBase, lsst.utils.tests.TestCase): 

113 

114 curatedCalibrationDatasetTypes = ("camera",) 

115 instrumentClassName = "lsst.obs.lsst.LsstComCam" 

116 ingestDir = TESTDIR 

117 file = os.path.join(DATAROOT, "comCam", "raw", "2019-05-30", 

118 "3019053000001", "3019053000001-R22-S00-det000.fits") 

119 dataIds = [dict(instrument="LSSTComCam", exposure=3019053000001, detector=0)] 

120 filterLabel = lsst.afw.image.FilterLabel(physical="unknown", band="unknown") 

121 

122 

123class ComCamSimIngestTestCase(IngestTestBase, lsst.utils.tests.TestCase): 

124 

125 curatedCalibrationDatasetTypes = ("camera",) 

126 instrumentClassName = "lsst.obs.lsst.LsstComCamSim" 

127 ingestDir = TESTDIR 

128 file = os.path.join(DATAROOT, "comCamSim", "raw", "2024-03-21", 

129 "7024032100720", "7024032100720-R22-S11-det004.fits.fz") 

130 dataIds = [dict(instrument="LSSTComCamSim", exposure=7024032100720, detector=4)] 

131 filterLabel = lsst.afw.image.FilterLabel(physical="r_03", band="r") 

132 

133 @property 

134 def visits(self): 

135 butler = Butler(self.root, collections=[self.outputRun]) 

136 return { 

137 DataCoordinate.standardize( 

138 instrument="LSSTComCamSim", 

139 visit=7024032100720, 

140 universe=butler.dimensions 

141 ): [ 

142 DataCoordinate.standardize( 

143 instrument="LSSTComCamSim", 

144 exposure=7024032100720, 

145 universe=butler.dimensions 

146 ) 

147 ] 

148 } 

149 

150 

151class LSSTCamIngestTestCase(IngestTestBase, lsst.utils.tests.TestCase): 

152 

153 curatedCalibrationDatasetTypes = ("camera",) 

154 instrumentClassName = "lsst.obs.lsst.LsstCam" 

155 ingestDir = TESTDIR 

156 file = os.path.join(DATAROOT, "lsstCam", "raw", "2019-03-19", 

157 "3019031900001", "3019031900001-R10-S02-det029.fits") 

158 dataIds = [dict(instrument="LSSTCam", exposure=3019031900001, detector=29)] 

159 filterLabel = lsst.afw.image.FilterLabel(physical="unknown", band="unknown") 

160 

161 

162class LSSTCamPhotodiodeIngestTestCase(lsst.utils.tests.TestCase): 

163 instrumentClassName = "lsst.obs.lsst.LsstCam" 

164 rawIngestTask = "lsst.obs.base.RawIngestTask" 

165 ingestDir = TESTDIR 

166 file = os.path.join(DATAROOT, "lsstCam", "raw", "2021-12-12", 

167 "30211212000310", "30211212000310-R22-S22-det098.fits") 

168 dataIds = [dict(instrument="LSSTCam", exposure=3021121200310, detector=98)] 

169 filterLabel = lsst.afw.image.FilterLabel(physical="SDSSi", band="i") 

170 pdPath = os.path.join(DATAROOT, "lsstCam", "raw") 

171 

172 def setUp(self): 

173 """Setup for lightweight photodiode ingest task. 

174 

175 This will create the repo and register the instrument. 

176 """ 

177 self.root = tempfile.mkdtemp(dir=self.ingestDir) 

178 

179 # Create Repo 

180 runner = LogCliRunner() 

181 result = runner.invoke(butlerCli, ["create", self.root]) 

182 self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}") 

183 

184 # Register Instrument 

185 runner = LogCliRunner() 

186 result = runner.invoke(butlerCli, ["register-instrument", self.root, self.instrumentClassName]) 

187 self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}") 

188 

189 def testPhotodiodeFailure(self): 

190 """Test ingest to a repo missing exposure information will raise. 

191 """ 

192 runner = LogCliRunner() 

193 result = runner.invoke( 

194 butlerCli, 

195 [ 

196 "ingest-photodiode", 

197 self.root, 

198 self.instrumentClassName, 

199 self.pdPath, 

200 ], 

201 ) 

202 self.assertEqual(result.exit_code, 1, f"output: {result.output} exception: {result.exception}") 

203 

204 def testPhotodiode(self): 

205 """Test ingest to a repo with the exposure information will not raise. 

206 """ 

207 # Ingest raw to provide exposure information. 

208 outputRun = "raw_ingest_" + self.id() 

209 runner = LogCliRunner() 

210 result = runner.invoke( 

211 butlerCli, 

212 [ 

213 "ingest-raws", 

214 self.root, 

215 self.file, 

216 "--output-run", 

217 outputRun, 

218 "--ingest-task", 

219 self.rawIngestTask, 

220 ], 

221 ) 

222 self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}") 

223 

224 # Ingest photodiode matching this exposure. 

225 runner = LogCliRunner() 

226 result = runner.invoke( 

227 butlerCli, 

228 [ 

229 "ingest-photodiode", 

230 self.root, 

231 self.instrumentClassName, 

232 self.pdPath, 

233 ], 

234 ) 

235 self.assertEqual(result.exit_code, 0, f"output: {result.output} exception: {result.exception}") 

236 

237 # Confirm that we can retrieve the ingested photodiode, and 

238 # that it has the correct type. 

239 butler = Butler(self.root, run="LSSTCam/calib/photodiode") 

240 getResult = butler.get('photodiode', dataId=self.dataIds[0]) 

241 self.assertIsInstance(getResult, PhotodiodeCalib) 

242 

243 

244def setup_module(module): 

245 lsst.utils.tests.init() 

246 

247 

248if __name__ == "__main__": 248 ↛ 249line 248 didn't jump to line 249, because the condition on line 248 was never true

249 lsst.utils.tests.init() 

250 unittest.main()