Coverage for tests/test_translation.py: 16%

110 statements  

« prev     ^ index     » next       coverage.py v6.4.4, created at 2022-09-07 09:25 +0000

1# This file is part of astro_metadata_translator. 

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 LICENSE file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

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

10# license that can be found in the LICENSE file. 

11 

12import os.path 

13import unittest 

14 

15from astropy.time import Time 

16 

17from astro_metadata_translator import FitsTranslator, ObservationInfo, StubTranslator 

18 

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

20 

21 

22class InstrumentTestTranslator(FitsTranslator, StubTranslator): 

23 """Simple FITS-like translator to test the infrastructure""" 

24 

25 # Needs a name to be registered 

26 name = "TestTranslator" 

27 

28 # Indicate the instrument this class understands 

29 supported_instrument = "SCUBA_test" 

30 

31 # Some new mappings, including an override 

32 _trivial_map = { 

33 "telescope": "TELCODE", 

34 "exposure_id": "EXPID", 

35 "relative_humidity": "HUMIDITY", 

36 "detector_name": "DETNAME", 

37 "observation_id": "OBSID", 

38 } 

39 

40 # Add translator method to test joining 

41 def to_physical_filter(self): 

42 return self._join_keyword_values(["DETNAME", "HUMIDITY"], delim="_") 

43 

44 

45class MissingMethodsTranslator(FitsTranslator): 

46 """Translator class that does not implement all the methods.""" 

47 

48 pass 

49 

50 

51class TranslatorTestCase(unittest.TestCase): 

52 def setUp(self): 

53 # Known simple header 

54 self.header = { 

55 "TELESCOP": "JCMT", 

56 "TELCODE": "LSST", 

57 "INSTRUME": "SCUBA_test", 

58 "DATE-OBS": "2000-01-01T01:00:01.500", 

59 "DATE-END": "2000-01-01T02:00:01.500", 

60 "OBSGEO-X": "-5464588.84421314", 

61 "OBSGEO-Y": "-2493000.19137644", 

62 "OBSGEO-Z": "2150653.35350771", 

63 "OBSID": "20000101_00002", 

64 "EXPID": "22", # Should cast to a number 

65 "DETNAME": 76, # Should cast to a string 

66 "HUMIDITY": "55", # Should cast to a float 

67 "BAZ": "bar", 

68 } 

69 

70 def test_manual_translation(self): 

71 

72 header = self.header 

73 translator = FitsTranslator(header) 

74 

75 # Treat the header as standard FITS 

76 self.assertFalse(FitsTranslator.can_translate(header)) 

77 self.assertEqual(translator.to_telescope(), "JCMT") 

78 self.assertEqual(translator.to_instrument(), "SCUBA_test") 

79 self.assertEqual(translator.to_datetime_begin(), Time(header["DATE-OBS"], format="isot")) 

80 

81 # This class will issue warnings 

82 with self.assertLogs("astro_metadata_translator") as cm: 

83 

84 class InstrumentTestTranslatorExtras(InstrumentTestTranslator): 

85 """Version of InstrumentTestTranslator with unexpected 

86 fields.""" 

87 

88 name = "InstrumentTestTranslatorExtras" 

89 _trivial_map = {"foobar": "BAZ"} 

90 _const_map = {"format": "HDF5"} 

91 

92 self.assertIn("Unexpected trivial", cm.output[0]) 

93 self.assertIn("Unexpected constant", cm.output[1]) 

94 

95 # Use the special test translator instead 

96 translator = InstrumentTestTranslatorExtras(header) 

97 self.assertTrue(InstrumentTestTranslator.can_translate(header)) 

98 self.assertEqual(translator.to_telescope(), "LSST") 

99 self.assertEqual(translator.to_instrument(), "SCUBA_test") 

100 self.assertEqual(translator.to_format(), "HDF5") 

101 self.assertEqual(translator.to_foobar(), "bar") 

102 

103 def test_translator(self): 

104 header = self.header 

105 

106 # Specify a translation class 

107 with self.assertWarns(UserWarning): 

108 # Since the translator is incomplete it should issue warnings 

109 v1 = ObservationInfo(header, translator_class=InstrumentTestTranslator) 

110 self.assertEqual(v1.instrument, "SCUBA_test") 

111 self.assertEqual(v1.telescope, "LSST") 

112 self.assertEqual(v1.exposure_id, 22) 

113 self.assertIsInstance(v1.exposure_id, int) 

114 self.assertEqual(v1.detector_name, "76") 

115 self.assertEqual(v1.relative_humidity, 55.0) 

116 self.assertIsInstance(v1.relative_humidity, float) 

117 self.assertEqual(v1.physical_filter, "76_55") 

118 

119 # Now automated class 

120 with self.assertWarns(UserWarning): 

121 # Since the translator is incomplete it should issue warnings 

122 v1 = ObservationInfo(header) 

123 self.assertEqual(v1.instrument, "SCUBA_test") 

124 self.assertEqual(v1.telescope, "LSST") 

125 

126 location = v1.location.to_geodetic() 

127 self.assertAlmostEqual(location.height.to("m").to_value(), 4123.0, places=1) 

128 

129 # Check that headers have been removed 

130 new_hdr = v1.stripped_header() 

131 self.assertNotIn("INSTRUME", new_hdr) 

132 self.assertNotIn("OBSGEO-X", new_hdr) 

133 self.assertIn("TELESCOP", new_hdr) 

134 

135 # Check the list of cards that were used 

136 used = v1.cards_used 

137 self.assertIn("INSTRUME", used) 

138 self.assertIn("OBSGEO-Y", used) 

139 self.assertNotIn("TELESCOP", used) 

140 

141 # Stringification 

142 summary = str(v1) 

143 self.assertIn("datetime_begin", summary) 

144 

145 # Create with a subset of properties 

146 v2 = ObservationInfo( 

147 header, 

148 translator_class=InstrumentTestTranslator, 

149 subset={"telescope", "datetime_begin", "exposure_group"}, 

150 ) 

151 

152 self.assertEqual(v2.telescope, v1.telescope) 

153 self.assertEqual(v2.datetime_begin, v2.datetime_begin) 

154 self.assertIsNone(v2.datetime_end) 

155 self.assertIsNone(v2.location) 

156 self.assertIsNone(v2.observation_id) 

157 

158 def test_corrections(self): 

159 """Apply corrections before translation.""" 

160 header = self.header 

161 

162 # Specify a translation class 

163 with self.assertWarns(UserWarning): 

164 # Since the translator is incomplete it should issue warnings 

165 v1 = ObservationInfo( 

166 header, 

167 translator_class=InstrumentTestTranslator, 

168 search_path=[os.path.join(TESTDIR, "data", "corrections")], 

169 ) 

170 

171 # These values should match the expected translation 

172 self.assertEqual(v1.instrument, "SCUBA_test") 

173 self.assertEqual(v1.detector_name, "76") 

174 self.assertEqual(v1.relative_humidity, 55.0) 

175 self.assertIsInstance(v1.relative_humidity, float) 

176 self.assertEqual(v1.physical_filter, "76_55") 

177 

178 # These two should be the "corrected" values 

179 self.assertEqual(v1.telescope, "AuxTel") 

180 self.assertEqual(v1.exposure_id, 42) 

181 

182 def test_failures(self): 

183 header = {} 

184 

185 with self.assertRaises(TypeError): 

186 ObservationInfo(header, translator_class=ObservationInfo) 

187 

188 with self.assertRaises(ValueError): 

189 ObservationInfo( 

190 header, translator_class=InstrumentTestTranslator, subset={"definitely_not_known"} 

191 ) 

192 

193 with self.assertRaises(ValueError): 

194 ObservationInfo( 

195 header, translator_class=InstrumentTestTranslator, required={"definitely_not_known"} 

196 ) 

197 

198 with self.assertLogs("astro_metadata_translator"): 

199 with self.assertWarns(UserWarning): 

200 ObservationInfo(header, translator_class=InstrumentTestTranslator, pedantic=False) 

201 

202 with self.assertRaises(KeyError): 

203 with self.assertWarns(UserWarning): 

204 ObservationInfo(header, translator_class=InstrumentTestTranslator, pedantic=True) 

205 

206 with self.assertLogs("astro_metadata_translator"): 

207 with self.assertWarns(UserWarning): 

208 ObservationInfo( 

209 header, translator_class=InstrumentTestTranslator, pedantic=False, filename="testfile1" 

210 ) 

211 

212 with self.assertRaises(KeyError): 

213 with self.assertWarns(UserWarning): 

214 ObservationInfo( 

215 header, translator_class=InstrumentTestTranslator, pedantic=True, filename="testfile2" 

216 ) 

217 

218 with self.assertRaises(NotImplementedError): 

219 with self.assertLogs("astro_metadata_translator", level="WARN"): 

220 ObservationInfo(header, translator_class=MissingMethodsTranslator) 

221 

222 with self.assertRaises(KeyError): 

223 with self.assertWarns(UserWarning): 

224 with self.assertLogs("astro_metadata_translator", level="WARN"): 

225 ObservationInfo( 

226 header, 

227 translator_class=InstrumentTestTranslator, 

228 pedantic=False, 

229 required={"boresight_airmass"}, 

230 ) 

231 

232 

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

234 unittest.main()