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

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

# This file is part of astro_metadata_translator. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

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

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

# for details of code ownership. 

# 

# Use of this source code is governed by a 3-clause BSD-style 

# license that can be found in the LICENSE file. 

 

import unittest 

import os.path 

 

from astro_metadata_translator import merge_headers, fix_header, HscTranslator 

from astro_metadata_translator.tests import read_test_file 

 

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

 

 

class HeadersTestCase(unittest.TestCase): 

 

def setUp(self): 

# Define reference headers 

self.h1 = dict( 

ORIGIN="LSST", 

KEY0=0, 

KEY1=1, 

KEY2=3, 

KEY3=3.1415, 

KEY4="a", 

) 

 

self.h2 = dict( 

ORIGIN="LSST", 

KEY0="0", 

KEY2=4, 

KEY5=42 

) 

self.h3 = dict( 

ORIGIN="AUXTEL", 

KEY3=3.1415, 

KEY2=50, 

KEY5=42, 

) 

self.h4 = dict( 

KEY6="New", 

KEY1="Exists", 

) 

 

# Add keys for sorting by time 

# Sorted order: h2, h1, h4, h3 

self.h1["MJD-OBS"] = 50000.0 

self.h2["MJD-OBS"] = 49000.0 

self.h3["MJD-OBS"] = 53000.0 

self.h4["MJD-OBS"] = 52000.0 

 

def test_fail(self): 

with self.assertRaises(ValueError): 

merge_headers([self.h1, self.h2], mode="wrong") 

 

with self.assertRaises(ValueError): 

merge_headers([]) 

 

def test_one(self): 

merged = merge_headers([self.h1], mode="drop") 

self.assertEqual(merged, self.h1) 

 

def test_merging_overwrite(self): 

merged = merge_headers([self.h1, self.h2], mode="overwrite") 

 

expected = { 

"MJD-OBS": self.h2["MJD-OBS"], 

"ORIGIN": self.h2["ORIGIN"], 

"KEY0": self.h2["KEY0"], 

"KEY1": self.h1["KEY1"], 

"KEY2": self.h2["KEY2"], 

"KEY3": self.h1["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h2["KEY5"], 

} 

self.assertEqual(merged, expected) 

 

merged = merge_headers([self.h1, self.h2, self.h3, self.h4], 

mode="overwrite") 

 

expected = { 

"MJD-OBS": self.h4["MJD-OBS"], 

"ORIGIN": self.h3["ORIGIN"], 

"KEY0": self.h2["KEY0"], 

"KEY1": self.h4["KEY1"], 

"KEY2": self.h3["KEY2"], 

"KEY3": self.h3["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h3["KEY5"], 

"KEY6": self.h4["KEY6"], 

} 

 

self.assertEqual(merged, expected) 

 

def test_merging_first(self): 

merged = merge_headers([self.h1, self.h2, self.h3, self.h4], 

mode="first") 

 

expected = { 

"MJD-OBS": self.h1["MJD-OBS"], 

"ORIGIN": self.h1["ORIGIN"], 

"KEY0": self.h1["KEY0"], 

"KEY1": self.h1["KEY1"], 

"KEY2": self.h1["KEY2"], 

"KEY3": self.h1["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h2["KEY5"], 

"KEY6": self.h4["KEY6"], 

} 

 

self.assertEqual(merged, expected) 

 

def test_merging_drop(self): 

merged = merge_headers([self.h1, self.h2, self.h3, self.h4], 

mode="drop") 

 

expected = { 

"KEY3": self.h1["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h2["KEY5"], 

"KEY6": self.h4["KEY6"], 

} 

 

self.assertEqual(merged, expected) 

 

# Sorting the headers should make no difference to drop mode 

merged = merge_headers([self.h1, self.h2, self.h3, self.h4], 

mode="drop", sort=True) 

self.assertEqual(merged, expected) 

 

# Now retain some headers 

merged = merge_headers([self.h1, self.h2, self.h3, self.h4], 

mode="drop", sort=False, first=["ORIGIN"], last=["KEY2", "KEY1"]) 

 

expected = { 

"KEY2": self.h3["KEY2"], 

"ORIGIN": self.h1["ORIGIN"], 

"KEY1": self.h4["KEY1"], 

"KEY3": self.h1["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h2["KEY5"], 

"KEY6": self.h4["KEY6"], 

} 

self.assertEqual(merged, expected) 

 

# Now retain some headers with sorting 

merged = merge_headers([self.h1, self.h2, self.h3, self.h4], 

mode="drop", sort=True, first=["ORIGIN"], last=["KEY2", "KEY1"]) 

 

expected = { 

"KEY2": self.h3["KEY2"], 

"ORIGIN": self.h2["ORIGIN"], 

"KEY1": self.h4["KEY1"], 

"KEY3": self.h1["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h2["KEY5"], 

"KEY6": self.h4["KEY6"], 

} 

self.assertEqual(merged, expected) 

 

def test_merging_append(self): 

# Try with two headers first 

merged = merge_headers([self.h1, self.h2], mode="append") 

 

expected = { 

"MJD-OBS": [self.h1["MJD-OBS"], self.h2["MJD-OBS"]], 

"ORIGIN": self.h1["ORIGIN"], 

"KEY0": [self.h1["KEY0"], self.h2["KEY0"]], 

"KEY1": self.h1["KEY1"], 

"KEY2": [self.h1["KEY2"], self.h2["KEY2"]], 

"KEY3": self.h1["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h2["KEY5"], 

} 

 

self.assertEqual(merged, expected) 

 

merged = merge_headers([self.h1, self.h2, self.h3, self.h4], 

mode="append") 

 

expected = { 

"MJD-OBS": [self.h1["MJD-OBS"], self.h2["MJD-OBS"], self.h3["MJD-OBS"], self.h4["MJD-OBS"]], 

"ORIGIN": [self.h1["ORIGIN"], self.h2["ORIGIN"], self.h3["ORIGIN"], None], 

"KEY0": [self.h1["KEY0"], self.h2["KEY0"], None, None], 

"KEY1": [self.h1["KEY1"], None, None, self.h4["KEY1"]], 

"KEY2": [self.h1["KEY2"], self.h2["KEY2"], self.h3["KEY2"], None], 

"KEY3": self.h3["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h3["KEY5"], 

"KEY6": self.h4["KEY6"], 

} 

 

self.assertEqual(merged, expected) 

 

def test_merging_overwrite_sort(self): 

merged = merge_headers([self.h1, self.h2], mode="overwrite", sort=True) 

 

expected = { 

"MJD-OBS": self.h1["MJD-OBS"], 

"ORIGIN": self.h1["ORIGIN"], 

"KEY0": self.h1["KEY0"], 

"KEY1": self.h1["KEY1"], 

"KEY2": self.h1["KEY2"], 

"KEY3": self.h1["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h2["KEY5"], 

} 

self.assertEqual(merged, expected) 

 

merged = merge_headers([self.h1, self.h2, self.h3, self.h4], 

mode="overwrite", sort=True) 

 

expected = { 

"MJD-OBS": self.h3["MJD-OBS"], 

"ORIGIN": self.h3["ORIGIN"], 

"KEY0": self.h1["KEY0"], 

"KEY1": self.h4["KEY1"], 

"KEY2": self.h3["KEY2"], 

"KEY3": self.h3["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h3["KEY5"], 

"KEY6": self.h4["KEY6"], 

} 

 

self.assertEqual(merged, expected) 

 

# Changing the order should not change the result 

merged = merge_headers([self.h4, self.h1, self.h3, self.h2], 

mode="overwrite", sort=True) 

 

self.assertEqual(merged, expected) 

 

def test_merging_first_sort(self): 

merged = merge_headers([self.h1, self.h2, self.h3, self.h4], 

mode="first", sort=True) 

 

expected = { 

"MJD-OBS": self.h2["MJD-OBS"], 

"ORIGIN": self.h2["ORIGIN"], 

"KEY0": self.h2["KEY0"], 

"KEY1": self.h1["KEY1"], 

"KEY2": self.h2["KEY2"], 

"KEY3": self.h1["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h2["KEY5"], 

"KEY6": self.h4["KEY6"], 

} 

 

self.assertEqual(merged, expected) 

 

def test_merging_append_sort(self): 

# Try with two headers first 

merged = merge_headers([self.h1, self.h2], mode="append", sort=True) 

 

expected = { 

"MJD-OBS": [self.h2["MJD-OBS"], self.h1["MJD-OBS"]], 

"ORIGIN": self.h1["ORIGIN"], 

"KEY0": [self.h2["KEY0"], self.h1["KEY0"]], 

"KEY1": self.h1["KEY1"], 

"KEY2": [self.h2["KEY2"], self.h1["KEY2"]], 

"KEY3": self.h1["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h2["KEY5"], 

} 

 

self.assertEqual(merged, expected) 

 

merged = merge_headers([self.h1, self.h2, self.h3, self.h4], 

mode="append", sort=True) 

 

expected = { 

"MJD-OBS": [self.h2["MJD-OBS"], self.h1["MJD-OBS"], self.h4["MJD-OBS"], self.h3["MJD-OBS"]], 

"ORIGIN": [self.h2["ORIGIN"], self.h1["ORIGIN"], None, self.h3["ORIGIN"]], 

"KEY0": [self.h2["KEY0"], self.h1["KEY0"], None, None], 

"KEY1": [None, self.h1["KEY1"], self.h4["KEY1"], None], 

"KEY2": [self.h2["KEY2"], self.h1["KEY2"], None, self.h3["KEY2"]], 

"KEY3": self.h3["KEY3"], 

"KEY4": self.h1["KEY4"], 

"KEY5": self.h3["KEY5"], 

"KEY6": self.h4["KEY6"], 

} 

 

self.assertEqual(merged, expected) 

 

# Order should not matter 

merged = merge_headers([self.h4, self.h3, self.h2, self.h1], 

mode="append", sort=True) 

self.assertEqual(merged, expected) 

 

 

class FixHeadersTestCase(unittest.TestCase): 

 

def test_basic_fix_header(self): 

"""Test that a header can be fixed if we specify a local path. 

""" 

 

header = read_test_file("fitsheader-decam-0160496.yaml", dir=os.path.join(TESTDIR, "data")) 

self.assertEqual(header["DETECTOR"], "S3-111_107419-8-3") 

 

# First fix header but using no search path (should work as no-op) 

fixed = fix_header(header) 

self.assertFalse(fixed) 

 

# Now using the test corrections directory 

fixed = fix_header(header, search_path=os.path.join(TESTDIR, "data", "corrections")) 

self.assertTrue(fixed) 

self.assertEqual(header["DETECTOR"], "NEW-ID") 

 

# Test that fix_header of unknown header is allowed 

header = {"SOMETHING": "UNKNOWN"} 

fixed = fix_header(header) 

self.assertFalse(fixed) 

 

def test_hsc_fix_header(self): 

"""Check that one of the known HSC corrections is being applied 

properly.""" 

header = {"EXP-ID": "HSCA00120800", 

"INSTRUME": "HSC", 

"DATA-TYP": "FLAT"} 

 

fixed = fix_header(header, translator_class=HscTranslator) 

self.assertTrue(fixed) 

self.assertEqual(header["DATA-TYP"], "OBJECT") 

 

# And that this header won't be corrected 

header = {"EXP-ID": "HSCA00120800X", 

"INSTRUME": "HSC", 

"DATA-TYP": "FLAT"} 

 

fixed = fix_header(header, translator_class=HscTranslator) 

self.assertFalse(fixed) 

self.assertEqual(header["DATA-TYP"], "FLAT") 

 

 

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

unittest.main()