Coverage for tests/test_ptcDataset.py: 8%

231 statements  

« prev     ^ index     » next       coverage.py v7.4.4, created at 2024-04-19 04:47 -0700

1# This file is part of ip_isr. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (https://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 <https://www.gnu.org/licenses/>. 

21import unittest 

22import tempfile 

23import copy 

24import logging 

25 

26import numpy as np 

27 

28import lsst.utils.tests 

29 

30from lsst.ip.isr import PhotonTransferCurveDataset 

31import lsst.ip.isr.isrMock as isrMock 

32 

33 

34class PtcDatasetCases(lsst.utils.tests.TestCase): 

35 """Test that write/read methods of PhotonTransferCurveDataset work 

36 """ 

37 def setUp(self): 

38 

39 self.flatMean = 2000 

40 self.readNoiseAdu = 10 

41 mockImageConfig = isrMock.IsrMock.ConfigClass() 

42 

43 # flatDrop is not really relevant as we replace the data 

44 # but good to note it in case we change how this image is made 

45 mockImageConfig.flatDrop = 0.99999 

46 mockImageConfig.isTrimmed = True 

47 

48 self.flatExp1 = isrMock.FlatMock(config=mockImageConfig).run() 

49 self.flatExp2 = self.flatExp1.clone() 

50 (shapeY, shapeX) = self.flatExp1.getDimensions() 

51 

52 self.flatWidth = np.sqrt(self.flatMean) + self.readNoiseAdu 

53 

54 self.rng1 = np.random.RandomState(1984) 

55 flatData1 = self.rng1.normal(self.flatMean, self.flatWidth, (shapeX, shapeY)) 

56 self.rng2 = np.random.RandomState(666) 

57 flatData2 = self.rng2.normal(self.flatMean, self.flatWidth, (shapeX, shapeY)) 

58 

59 self.flatExp1.image.array[:] = flatData1 

60 self.flatExp2.image.array[:] = flatData2 

61 

62 self.flux = 1000. # ADU/sec 

63 self.gain = 1.5 # e-/ADU 

64 self.noiseSq = 5*self.gain # 7.5 (e-)^2 

65 self.c1 = 1./self.gain 

66 self.timeVec = np.arange(1., 101., 5) 

67 self.k2NonLinearity = -5e-6 

68 # quadratic signal-chain non-linearity 

69 muVec = self.flux*self.timeVec + self.k2NonLinearity*self.timeVec**2 

70 

71 self.ampNames = [amp.getName() for amp in self.flatExp1.getDetector().getAmplifiers()] 

72 self.dataset = PhotonTransferCurveDataset(self.ampNames, " ") # pack raw data for fitting 

73 self.covariancesSqrtWeights = {} 

74 for ampName in self.ampNames: # just the expTimes and means here - vars vary per function 

75 self.dataset.rawExpTimes[ampName] = self.timeVec 

76 self.dataset.rawMeans[ampName] = muVec 

77 self.covariancesSqrtWeights[ampName] = [] 

78 

79 def _checkTypes(self, ptcDataset): 

80 """Check that all the types are correct for a ptc dataset.""" 

81 for ampName in ptcDataset.ampNames: 

82 self.assertIsInstance(ptcDataset.expIdMask[ampName], np.ndarray) 

83 self.assertEqual(ptcDataset.expIdMask[ampName].dtype, bool) 

84 self.assertIsInstance(ptcDataset.rawExpTimes[ampName], np.ndarray) 

85 self.assertEqual(ptcDataset.rawExpTimes[ampName].dtype, np.float64) 

86 self.assertIsInstance(ptcDataset.rawMeans[ampName], np.ndarray) 

87 self.assertEqual(ptcDataset.rawMeans[ampName].dtype, np.float64) 

88 self.assertIsInstance(ptcDataset.rawVars[ampName], np.ndarray) 

89 self.assertEqual(ptcDataset.rawVars[ampName].dtype, np.float64) 

90 self.assertEqual(ptcDataset.rowMeanVariance[ampName].dtype, np.float64) 

91 self.assertIsInstance(ptcDataset.noiseList[ampName], np.ndarray) 

92 self.assertEqual(ptcDataset.noiseList[ampName].dtype, np.float64) 

93 self.assertIsInstance(ptcDataset.gain[ampName], float) 

94 self.assertIsInstance(ptcDataset.gainErr[ampName], float) 

95 self.assertIsInstance(ptcDataset.noise[ampName], float) 

96 self.assertIsInstance(ptcDataset.noiseErr[ampName], float) 

97 self.assertIsInstance(ptcDataset.histVars[ampName], np.ndarray) 

98 self.assertEqual(ptcDataset.histVars[ampName].dtype, np.float64) 

99 self.assertIsInstance(ptcDataset.histChi2Dofs[ampName], np.ndarray) 

100 self.assertEqual(ptcDataset.histChi2Dofs[ampName].dtype, np.float64) 

101 self.assertIsInstance(ptcDataset.kspValues[ampName], np.ndarray) 

102 self.assertEqual(ptcDataset.kspValues[ampName].dtype, np.float64) 

103 self.assertIsInstance(ptcDataset.ptcFitPars[ampName], np.ndarray) 

104 self.assertEqual(ptcDataset.ptcFitPars[ampName].dtype, np.float64) 

105 self.assertIsInstance(ptcDataset.ptcFitParsError[ampName], np.ndarray) 

106 self.assertEqual(ptcDataset.ptcFitParsError[ampName].dtype, np.float64) 

107 self.assertIsInstance(ptcDataset.ptcFitChiSq[ampName], float) 

108 self.assertIsInstance(ptcDataset.ptcTurnoff[ampName], float) 

109 self.assertIsInstance(ptcDataset.covariances[ampName], np.ndarray) 

110 self.assertEqual(ptcDataset.covariances[ampName].dtype, np.float64) 

111 self.assertIsInstance(ptcDataset.covariancesModel[ampName], np.ndarray) 

112 self.assertEqual(ptcDataset.covariancesModel[ampName].dtype, np.float64) 

113 self.assertIsInstance(ptcDataset.covariancesSqrtWeights[ampName], np.ndarray) 

114 self.assertEqual(ptcDataset.covariancesSqrtWeights[ampName].dtype, np.float64) 

115 self.assertIsInstance(ptcDataset.aMatrix[ampName], np.ndarray) 

116 self.assertEqual(ptcDataset.aMatrix[ampName].dtype, np.float64) 

117 self.assertIsInstance(ptcDataset.bMatrix[ampName], np.ndarray) 

118 self.assertEqual(ptcDataset.bMatrix[ampName].dtype, np.float64) 

119 self.assertIsInstance(ptcDataset.noiseMatrix[ampName], np.ndarray) 

120 self.assertEqual(ptcDataset.noiseMatrix[ampName].dtype, np.float64) 

121 self.assertIsInstance(ptcDataset.covariancesModelNoB[ampName], np.ndarray) 

122 self.assertEqual(ptcDataset.covariancesModelNoB[ampName].dtype, np.float64) 

123 self.assertIsInstance(ptcDataset.aMatrixNoB[ampName], np.ndarray) 

124 self.assertEqual(ptcDataset.aMatrixNoB[ampName].dtype, np.float64) 

125 self.assertIsInstance(ptcDataset.noiseMatrixNoB[ampName], np.ndarray) 

126 self.assertEqual(ptcDataset.noiseMatrixNoB[ampName].dtype, np.float64) 

127 self.assertIsInstance(ptcDataset.finalVars[ampName], np.ndarray) 

128 self.assertEqual(ptcDataset.finalVars[ampName].dtype, np.float64) 

129 self.assertIsInstance(ptcDataset.finalModelVars[ampName], np.ndarray) 

130 self.assertEqual(ptcDataset.finalModelVars[ampName].dtype, np.float64) 

131 self.assertIsInstance(ptcDataset.finalMeans[ampName], np.ndarray) 

132 self.assertEqual(ptcDataset.finalMeans[ampName].dtype, np.float64) 

133 self.assertIsInstance(ptcDataset.photoCharges[ampName], np.ndarray) 

134 self.assertEqual(ptcDataset.photoCharges[ampName].dtype, np.float64) 

135 

136 for key, value in ptcDataset.auxValues.items(): 

137 self.assertIsInstance(value, np.ndarray) 

138 self.assertEqual(value.dtype, np.float64) 

139 

140 def test_emptyPtcDataset(self): 

141 """Test an empty PTC dataset.""" 

142 emptyDataset = PhotonTransferCurveDataset( 

143 self.ampNames, 

144 ptcFitType="PARTIAL", 

145 ) 

146 self._checkTypes(emptyDataset) 

147 

148 with tempfile.NamedTemporaryFile(suffix=".yaml") as f: 

149 usedFilename = emptyDataset.writeText(f.name) 

150 fromText = PhotonTransferCurveDataset.readText(usedFilename) 

151 self.assertEqual(emptyDataset, fromText) 

152 self._checkTypes(emptyDataset) 

153 

154 with tempfile.NamedTemporaryFile(suffix=".fits") as f: 

155 usedFilename = emptyDataset.writeFits(f.name) 

156 fromFits = PhotonTransferCurveDataset.readFits(usedFilename) 

157 self.assertEqual(emptyDataset, fromFits) 

158 self._checkTypes(emptyDataset) 

159 

160 def test_partialPtcDataset(self): 

161 """Test of a partial PTC dataset.""" 

162 # Fill the dataset with made up data. 

163 nSideCovMatrix = 2 

164 nSideCovMatrixFullCovFit = 2 

165 

166 partialDataset = PhotonTransferCurveDataset( 

167 self.ampNames, 

168 ptcFitType="PARTIAL", 

169 covMatrixSide=nSideCovMatrix, 

170 covMatrixSideFullCovFit=nSideCovMatrixFullCovFit 

171 ) 

172 self._checkTypes(partialDataset) 

173 

174 for ampName in partialDataset.ampNames: 

175 partialDataset.setAmpValuesPartialDataset( 

176 ampName, 

177 inputExpIdPair=(10, 11), 

178 rawExpTime=10.0, 

179 rawMean=10.0, 

180 rawVar=10.0, 

181 ) 

182 

183 for useAuxValues in [False, True]: 

184 if useAuxValues: 

185 partialDataset.setAuxValuesPartialDataset( 

186 { 

187 "CCOBCURR": 1.0, 

188 "CCDTEMP": 0.0, 

189 } 

190 ) 

191 self._checkTypes(partialDataset) 

192 

193 with tempfile.NamedTemporaryFile(suffix=".yaml") as f: 

194 usedFilename = partialDataset.writeText(f.name) 

195 fromText = PhotonTransferCurveDataset.readText(usedFilename) 

196 self.assertEqual(fromText, partialDataset) 

197 self._checkTypes(fromText) 

198 

199 with tempfile.NamedTemporaryFile(suffix=".fits") as f: 

200 usedFilename = partialDataset.writeFits(f.name) 

201 fromFits = PhotonTransferCurveDataset.readFits(usedFilename) 

202 self.assertEqual(fromFits, partialDataset) 

203 self._checkTypes(fromFits) 

204 

205 def test_ptcDatset(self): 

206 """Test of a full PTC dataset.""" 

207 # Fill the dataset with made up data. 

208 nSignalPoints = 5 

209 nSideCovMatrixInput = 3 # Size of measured covariances 

210 

211 for nSideCovMatrixFullCovFitInput in np.arange(1, nSideCovMatrixInput + 2): 

212 for fitType in ['POLYNOMIAL', 'EXPAPPROXIMATION', 'FULLCOVARIANCE']: 

213 localDataset = PhotonTransferCurveDataset( 

214 self.ampNames, 

215 ptcFitType=fitType, 

216 covMatrixSide=nSideCovMatrixInput, 

217 covMatrixSideFullCovFit=nSideCovMatrixFullCovFitInput, 

218 ) 

219 nSideCovMatrix = localDataset.covMatrixSide 

220 nSideCovMatrixFullCovFit = localDataset.covMatrixSideFullCovFit 

221 localDataset.badAmps = [localDataset.ampNames[0], localDataset.ampNames[1]] 

222 for ampName in localDataset.ampNames: 

223 

224 localDataset.inputExpIdPairs[ampName] = [(1, 2)]*nSignalPoints 

225 localDataset.expIdMask[ampName] = np.ones(nSignalPoints, dtype=bool) 

226 localDataset.expIdMask[ampName][1] = False 

227 localDataset.rawExpTimes[ampName] = np.arange(nSignalPoints, dtype=np.float64) 

228 localDataset.rawMeans[ampName] = self.flux*np.arange(nSignalPoints) 

229 localDataset.rawVars[ampName] = self.c1*self.flux*np.arange(nSignalPoints) 

230 localDataset.photoCharges[ampName] = np.full(nSignalPoints, np.nan) 

231 localDataset.gain[ampName] = self.gain 

232 localDataset.gainErr[ampName] = 0.1 

233 localDataset.noise[ampName] = self.noiseSq 

234 localDataset.noiseErr[ampName] = 2.0 

235 localDataset.histVars[ampName] = localDataset.rawVars[ampName] 

236 localDataset.histChi2Dofs[ampName] = np.full(nSignalPoints, 1.0) 

237 localDataset.kspValues[ampName] = np.full(nSignalPoints, 0.5) 

238 

239 localDataset.finalVars[ampName] = self.c1*self.flux*np.arange(nSignalPoints) 

240 localDataset.finalModelVars[ampName] = np.full(nSignalPoints, 100.0) 

241 localDataset.finalMeans[ampName] = self.flux*np.arange(nSignalPoints) 

242 

243 if fitType in ['POLYNOMIAL', 'EXPAPPROXIMATION', ]: 

244 localDataset.ptcFitPars[ampName] = np.array([10.0, 1.5, 1e-6]) 

245 localDataset.ptcFitParsError[ampName] = np.array([1.0, 0.2, 1e-7]) 

246 localDataset.ptcFitChiSq[ampName] = 1.0 

247 localDataset.ptcTurnoff[ampName] = localDataset.rawMeans[ampName][-1] 

248 

249 localDataset.covariances[ampName] = np.full( 

250 (nSignalPoints, nSideCovMatrix, nSideCovMatrix), 105.0) 

251 localDataset.covariancesModel[ampName] = np.full( 

252 (nSignalPoints, nSideCovMatrixFullCovFit, nSideCovMatrixFullCovFit), np.nan) 

253 localDataset.covariancesSqrtWeights[ampName] = np.full((nSignalPoints, nSideCovMatrix, 

254 nSideCovMatrix), 10.0) 

255 localDataset.aMatrix[ampName] = np.full((nSideCovMatrixFullCovFit, 

256 nSideCovMatrixFullCovFit), np.nan) 

257 localDataset.bMatrix[ampName] = np.full((nSideCovMatrixFullCovFit, 

258 nSideCovMatrixFullCovFit), np.nan) 

259 localDataset.noiseMatrix[ampName] = np.full((nSideCovMatrixFullCovFit, 

260 nSideCovMatrixFullCovFit), np.nan) 

261 localDataset.covariancesModelNoB[ampName] = np.full((nSignalPoints, 

262 nSideCovMatrixFullCovFit, 

263 nSideCovMatrixFullCovFit), np.nan) 

264 localDataset.aMatrixNoB[ampName] = np.full( 

265 (nSideCovMatrixFullCovFit, nSideCovMatrixFullCovFit), np.nan) 

266 localDataset.noiseMatrixNoB[ampName] = np.full( 

267 (nSideCovMatrixFullCovFit, nSideCovMatrixFullCovFit), np.nan) 

268 

269 if localDataset.ptcFitType in ['FULLCOVARIANCE', ]: 

270 localDataset.ptcFitPars[ampName] = np.array([np.nan, np.nan]) 

271 localDataset.ptcFitParsError[ampName] = np.array([np.nan, np.nan]) 

272 localDataset.ptcFitChiSq[ampName] = np.nan 

273 localDataset.ptcTurnoff[ampName] = np.nan 

274 

275 localDataset.covariances[ampName] = np.full( 

276 (nSignalPoints, nSideCovMatrix, nSideCovMatrix), 105.0) 

277 localDataset.covariancesModel[ampName] = np.full( 

278 (nSignalPoints, nSideCovMatrixFullCovFit, nSideCovMatrixFullCovFit), 100.0) 

279 localDataset.covariancesSqrtWeights[ampName] = np.full((nSignalPoints, nSideCovMatrix, 

280 nSideCovMatrix), 10.0) 

281 localDataset.aMatrix[ampName] = np.full((nSideCovMatrixFullCovFit, 

282 nSideCovMatrixFullCovFit), 1e-6) 

283 localDataset.bMatrix[ampName] = np.full((nSideCovMatrixFullCovFit, 

284 nSideCovMatrixFullCovFit), 1e-7) 

285 localDataset.noiseMatrix[ampName] = np.full((nSideCovMatrixFullCovFit, 

286 nSideCovMatrixFullCovFit), 3.0) 

287 localDataset.covariancesModelNoB[ampName] = np.full((nSignalPoints, 

288 nSideCovMatrixFullCovFit, 

289 nSideCovMatrixFullCovFit), 15.0) 

290 localDataset.aMatrixNoB[ampName] = np.full( 

291 (nSideCovMatrixFullCovFit, nSideCovMatrixFullCovFit), 2e-6) 

292 localDataset.noiseMatrixNoB[ampName] = np.full( 

293 (nSideCovMatrixFullCovFit, nSideCovMatrixFullCovFit), 3.0) 

294 

295 for useAuxValues in [False, True]: 

296 if useAuxValues: 

297 localDataset.auxValues = { 

298 "CCOBCURR": np.ones(nSignalPoints), 

299 "CCDTEMP": np.zeros(nSignalPoints), 

300 } 

301 

302 self._checkTypes(localDataset) 

303 with tempfile.NamedTemporaryFile(suffix=".yaml") as f: 

304 usedFilename = localDataset.writeText(f.name) 

305 fromText = PhotonTransferCurveDataset.readText(usedFilename) 

306 self.assertEqual(fromText, localDataset) 

307 self._checkTypes(fromText) 

308 

309 with tempfile.NamedTemporaryFile(suffix=".fits") as f: 

310 usedFilename = localDataset.writeFits(f.name) 

311 fromFits = PhotonTransferCurveDataset.readFits(usedFilename) 

312 self.assertEqual(fromFits, localDataset) 

313 self._checkTypes(fromFits) 

314 

315 def test_getExpIdsUsed(self): 

316 localDataset = copy.copy(self.dataset) 

317 

318 for pair in [(12, 34), (56, 78), (90, 10)]: 

319 localDataset.inputExpIdPairs["C:0,0"].append(pair) 

320 localDataset.expIdMask["C:0,0"] = np.array([True, False, True]) 

321 self.assertTrue(np.all(localDataset.getExpIdsUsed("C:0,0") == [(12, 34), (90, 10)])) 

322 

323 localDataset.expIdMask["C:0,0"] = np.array([True, False, True, True]) # wrong length now 

324 with self.assertRaises(AssertionError): 

325 localDataset.getExpIdsUsed("C:0,0") 

326 

327 def test_getGoodAmps(self): 

328 dataset = self.dataset 

329 

330 self.assertTrue(dataset.ampNames == self.ampNames) 

331 dataset.badAmps.append("C:0,1") 

332 self.assertTrue(dataset.getGoodAmps() == [amp for amp in self.ampNames if amp != "C:0,1"]) 

333 

334 def test_ptcDataset_pre_dm38309(self): 

335 """Test for PTC datasets created by cpSolvePtcTask prior to DM-38309. 

336 """ 

337 localDataset = copy.copy(self.dataset) 

338 

339 for pair in [[(12, 34)], [(56, 78)], [(90, 10)]]: 

340 localDataset.inputExpIdPairs["C:0,0"].append(pair) 

341 localDataset.expIdMask["C:0,0"] = np.array([True, False, True]) 

342 

343 with self.assertLogs("lsst.ip.isr.calibType", logging.WARNING) as cm: 

344 used = localDataset.getExpIdsUsed("C:0,0") 

345 self.assertIn("PTC file was written incorrectly", cm.output[0]) 

346 

347 self.assertTrue(np.all(used == [(12, 34), (90, 10)])) 

348 

349 

350class MemoryTester(lsst.utils.tests.MemoryTestCase): 

351 pass 

352 

353 

354def setup_module(module): 

355 lsst.utils.tests.init() 

356 

357 

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

359 import sys 

360 setup_module(sys.modules[__name__]) 

361 unittest.main()