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

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

# This file is part of ip_isr. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (https://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the GNU General Public License 

# along with this program. If not, see <https://www.gnu.org/licenses/>. 

 

import unittest 

 

import numpy as np 

 

import lsst.utils.tests 

import lsst.afw.math as afwMath 

import lsst.afw.image as afwImage 

import lsst.afw.image.utils as afwImageUtils 

import lsst.pipe.base as pipeBase 

from lsst.ip.isr.fringe import FringeTask 

 

import lsst.ip.isr.isrMock as isrMock 

 

try: 

display 

except NameError: 

display = False 

else: 

import lsst.afw.display as afwDisplay 

afwDisplay.setDefaultMaskTransparency(75) 

 

 

class FringeDataRef(object): 

"""Quacks like a ButlerDataRef, so we can provide an in-memory fringe frame. 

""" 

def __init__(self, fringe): 

self.fringe = fringe 

self.dataId = {'test': True} 

 

def get(self, name="fringe", immediate=False): 

if name == "fringe": 

return self.fringe 

if name == "ccdExposureId": 

return 1000 

 

 

def createFringe(width, height, xFreq, xOffset, yFreq, yOffset): 

"""Create a fringe frame. 

 

Parameters 

---------- 

width, height : `int` 

Size of image. 

xFreq, yFreq : `float` 

Frequency of sinusoids in x and y. 

xOffset, yOffset : `float` 

Phase of sinusoids in x and y. 

 

Returns 

------- 

exp : `lsst.afw.image.ExposureF` 

Fringe frame. 

""" 

image = afwImage.ImageF(width, height) 

array = image.getArray() 

x, y = np.indices(array.shape) 

array[x, y] = np.sin(xFreq*x + xOffset) + np.sin(yFreq*y + yOffset) 

mi = afwImage.makeMaskedImage(image) 

exp = afwImage.makeExposure(mi) 

exp.setFilter(afwImage.Filter('FILTER')) 

return exp 

 

 

class FringeTestCase(lsst.utils.tests.TestCase): 

"""Tests of the FringeTask. 

""" 

def setUp(self): 

self.size = 512 

self.config = FringeTask.ConfigClass() 

self.config.filters = ['FILTER'] 

self.config.num = 5000 

self.config.small = 1 

self.config.large = 128 

self.config.pedestal = False 

self.config.iterations = 10 

afwImageUtils.defineFilter('FILTER', lambdaEff=0) 

 

def tearDown(self): 

afwImageUtils.resetFilters() 

 

def checkFringe(self, task, exp, fringes, stddevMax): 

"""Run fringe subtraction and verify. 

 

Parameters 

---------- 

task : `lsst.ip.isr.fringe.FringeTask` 

Task to run. 

exp : `lsst.afw.image.ExposureF` 

Science exposure. 

fringes : `list` of `lsst.afw.image.ExposureF` 

Data reference that will provide the fringes. 

stddevMax : `float` 

Maximum allowable standard deviation. 

""" 

if display: 

frame = 0 

afwDisplay.Display(frame=frame).mtv(exp, title=self._testMethodName + ": Science exposure") 

frame += 1 

if not isinstance(fringes, list): 

fringe = [fringes] 

else: 

fringe = fringes 

for i, f in enumerate(fringe): 

afwDisplay.Display(frame=frame).mtv(f, title=self._testMethodName + 

": Fringe frame %d" % (i + 1)) 

frame += 1 

 

task.run(exp, fringes) 

 

mi = exp.getMaskedImage() 

 

if display: 

afwDisplay.Display(frame=frame).mtv(exp, title=self._testMethodName + ": Subtracted") 

frame += 1 

 

mi -= afwMath.makeStatistics(mi, afwMath.MEAN).getValue() 

self.assertLess(afwMath.makeStatistics(mi, afwMath.STDEV).getValue(), stddevMax) 

 

def testSingle(self, pedestal=0.0, stddevMax=1.0e-4): 

"""Test subtraction of a single fringe frame. 

 

Parameters 

---------- 

pedestal : `float`, optional 

Pedestal to add into fringe frame 

stddevMax : `float`, optional 

Maximum allowable standard deviation. 

""" 

xFreq = np.pi/10.0 

xOffset = 1.0 

yFreq = np.pi/15.0 

yOffset = 0.5 

scale = 1.0 

fringe = createFringe(self.size, self.size, xFreq, xOffset, yFreq, yOffset) 

fMi = fringe.getMaskedImage() 

fMi += pedestal 

exp = createFringe(self.size, self.size, xFreq, xOffset, yFreq, yOffset) 

eMi = exp.getMaskedImage() 

eMi *= scale 

 

task = FringeTask(name="fringe", config=self.config) 

self.checkFringe(task, exp, fringe, stddevMax) 

 

def testBad(self, bad="BAD"): 

"""Test fringe subtraction with bad inputs. 

 

Parameters 

---------- 

bad : `str`, optional 

Mask plane to use. 

""" 

xFreq = np.pi/10.0 

xOffset = 1.0 

yFreq = np.pi/15.0 

yOffset = 0.5 

fringe = createFringe(self.size, self.size, xFreq, xOffset, yFreq, yOffset) 

exp = createFringe(self.size, self.size, xFreq, xOffset, yFreq, yOffset) 

 

# This is a bad CCD: entirely masked 

exp.maskedImage.image.set(0.0) 

mask = exp.maskedImage.mask 

mask.set(mask.getPlaneBitMask(bad)) 

 

self.config.stats.badMaskPlanes = [bad] 

task = FringeTask(name="fringe", config=self.config) 

task.run(exp, fringe) 

self.assertFloatsEqual(exp.maskedImage.image.array, 0.0) 

 

def testPedestal(self): 

"""Test subtraction of a fringe frame with a pedestal. 

""" 

self.config.pedestal = True 

self.testSingle(pedestal=10000.0, stddevMax=1.0e-3) # Not sure why this produces worse sttdev 

self.testMultiple(pedestal=10000.0) 

 

def testMultiple(self, pedestal=0.0): 

"""Test subtraction of multiple fringe frames 

 

Paramters 

--------- 

pedestal : `float`, optional 

Pedestal to add into fringe frame. 

""" 

xFreqList = [0.1, 0.13, 0.06] 

xOffsetList = [0.0, 0.1, 0.2] 

yFreqList = [0.09, 0.12, 0.07] 

yOffsetList = [0.3, 0.2, 0.1] 

fringeList = [createFringe(self.size, self.size, xFreq, xOffset, yFreq, yOffset) 

for xFreq, xOffset, yFreq, yOffset in 

zip(xFreqList, xOffsetList, yFreqList, yOffsetList)] 

 

for fringe in fringeList: 

fMi = fringe.getMaskedImage() 

fMi += pedestal 

# Generate science frame 

scales = [0.33, 0.33, 0.33] 

image = afwImage.ImageF(self.size, self.size) 

image.set(0) 

for s, f in zip(scales, fringeList): 

image.scaledPlus(s, f.getMaskedImage().getImage()) 

mi = afwImage.makeMaskedImage(image) 

exp = afwImage.makeExposure(mi) 

exp.setFilter(afwImage.Filter('FILTER')) 

 

task = FringeTask(name="multiFringe", config=self.config) 

self.checkFringe(task, exp, fringeList, stddevMax=1.0e-2) 

 

def testRunDataRef(self, pedestal=0.0, stddevMax=1.0e-4): 

"""Test the .runDataRef method for complete test converage. 

 

Paramters 

--------- 

pedestal : `float`, optional 

Pedestal to add into fringe frame. 

stddevMax : `float`, optional 

Maximum allowable standard deviation. 

""" 

xFreq = np.pi/10.0 

xOffset = 1.0 

yFreq = np.pi/15.0 

yOffset = 0.5 

scale = 1.0 

fringe = createFringe(self.size, self.size, xFreq, xOffset, yFreq, yOffset) 

fMi = fringe.getMaskedImage() 

fMi += pedestal 

exp = createFringe(self.size, self.size, xFreq, xOffset, yFreq, yOffset) 

eMi = exp.getMaskedImage() 

eMi *= scale 

 

task = FringeTask(name="fringe", config=self.config) 

dataRef = FringeDataRef(fringe) 

task.runDataRef(exp, dataRef) 

 

mi = exp.getMaskedImage() 

mi -= afwMath.makeStatistics(mi, afwMath.MEAN).getValue() 

self.assertLess(afwMath.makeStatistics(mi, afwMath.STDEV).getValue(), stddevMax) 

 

def test_readFringes(self): 

"""Test that fringes can be successfully accessed from the butler. 

""" 

task = FringeTask() 

dataRef = isrMock.DataRefMock() 

 

result = task.readFringes(dataRef, assembler=None) 

self.assertIsInstance(result, pipeBase.Struct) 

 

def test_multiFringes(self): 

"""Test that multi-fringe results are handled correctly by the task. 

""" 

self.config.filters.append("_unknown_") 

self.config.large = 16 

task = FringeTask(name="multiFringeMock", config=self.config) 

 

config = isrMock.IsrMockConfig() 

config.fringeScale = [750.0, 240.0, 220.0] 

config.fringeX0 = [100.0, 150.0, 200.0] 

config.fringeY0 = [0.0, 200.0, 0.0] 

dataRef = isrMock.FringeDataRefMock(config=config) 

 

exp = dataRef.get("raw") 

medianBefore = np.nanmedian(exp.getImage().getArray()) 

fringes = task.readFringes(dataRef, assembler=None) 

 

solution, rms = task.run(exp, **fringes.getDict()) 

medianAfter = np.nanmedian(exp.getImage().getArray()) 

stdAfter = np.nanstd(exp.getImage().getArray()) 

 

self.assertLess(medianAfter, medianBefore) 

self.assertFloatsAlmostEqual(medianAfter, 3000.925, atol=1e-4) 

self.assertFloatsAlmostEqual(stdAfter, 3549.9885, atol=1e-4) 

 

deviation = np.abs(solution - config.fringeScale) 

self.assertTrue(np.all(deviation / rms < 1.0)) 

 

 

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

pass 

 

 

def setup_module(module): 

lsst.utils.tests.init() 

 

 

305 ↛ 306line 305 didn't jump to line 306, because the condition on line 305 was never trueif __name__ == "__main__": 

lsst.utils.tests.init() 

unittest.main()