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

# 

# LSST Data Management System 

# 

# This product includes software developed by the 

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

# 

# See COPYRIGHT file at the top of the source tree. 

# 

# 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 LSST License Statement and 

# the GNU General Public License along with this program. If not, 

# see <https://www.lsstcorp.org/LegalNotices/>. 

# 

 

import shutil 

import unittest 

import tempfile 

import yaml 

 

import astropy.units as u 

from astropy.tests.helper import quantity_allclose 

 

from lsst.utils.tests import TestCase 

from lsst.verify import Measurement, Metric, Name, Blob, BlobSet, Datum 

from butler_utils import make_test_butler, make_dataset_type 

 

 

class MeasurementTestCase(TestCase): 

"""Test lsst.verify.measurment.Measurement class.""" 

 

def setUp(self): 

self.pa1 = Metric( 

'validate_drp.PA1', 

"The maximum rms of the unresolved source magnitude distribution " 

"around the mean value (repeatability).", 

'mmag', 

tags=['photometric', 'LPM-17'], 

reference_doc='LPM-17', 

reference_url='http://ls.st/lpm-17', 

reference_page=21) 

 

self.blob1 = Blob('Blob1') 

self.blob1['datum1'] = Datum(5 * u.arcsec, 'Datum 1') 

self.blob1['datum2'] = Datum(28. * u.mag, 'Datum 2') 

 

self.blob2 = Blob('Blob2') 

self.blob2['datumN'] = Datum(11 * u.dimensionless_unscaled, 'Count') 

 

def test_PA1_measurement_with_metric(self): 

"""Standard metric with a given Metric instance.""" 

measurement = Measurement(self.pa1, 0.002 * u.mag, blobs=[self.blob1], 

notes={'filter_name': 'r'}) 

measurement.link_blob(self.blob2) 

 

measurement2 = Measurement(self.pa1, 0.002 * u.mag) 

 

self.assertTrue(quantity_allclose(measurement.quantity, 0.002 * u.mag)) 

self.assertIsInstance(measurement.metric_name, Name) 

self.assertEqual(measurement.metric_name, Name('validate_drp.PA1')) 

self.assertEqual(measurement.metric, self.pa1) 

self.assertNotEqual(measurement.identifier, measurement2.identifier) 

 

# Test blob access 

self.assertIn('Blob1', measurement.blobs) 

self.assertIn('Blob2', measurement.blobs) 

 

# Test Datum representation 

datum = measurement.datum 

self.assertTrue(quantity_allclose(datum.quantity, 0.002 * u.mag)) 

self.assertEqual(datum.label, str(self.pa1.name)) 

self.assertEqual(datum.description, str(self.pa1.description)) 

 

# Test notes (MeasurementNotes) 

self.assertEqual(measurement.notes['filter_name'], 'r') 

# Add a note 

measurement.notes['camera'] = 'MegaCam' 

self.assertEqual(measurement.notes['camera'], 'MegaCam') 

self.assertEqual(len(measurement.notes), 2) 

self.assertIn('camera', measurement.notes) 

self.assertIn('filter_name', measurement.notes) 

# Prefixed keys 

self.assertIn('validate_drp.PA1.camera', measurement.notes) 

# test iteration 

iterkeys = set([key for key in measurement.notes]) 

self.assertEqual(len(iterkeys), 2) 

self.assertEqual(set(iterkeys), set(measurement.notes.keys())) 

itemkeys = set() 

for key, value in measurement.notes.items(): 

self.assertEqual(measurement.notes[key], value) 

itemkeys.add(key) 

self.assertEqual(itemkeys, iterkeys) 

# Test update 

measurement.notes.update({'photometric': True, 'facility': 'CFHT'}) 

self.assertIn('photometric', measurement.notes) 

# Test delete 

del measurement.notes['photometric'] 

self.assertNotIn('photometric', measurement.notes) 

 

# Test serialization 

json_doc = measurement.json 

# Units should be cast to those of the metric 

self.assertEqual(json_doc['unit'], 'mmag') 

self.assertFloatsAlmostEqual(json_doc['value'], 2.0) 

self.assertEqual(json_doc['identifier'], measurement.identifier) 

self.assertIsInstance(json_doc['blob_refs'], list) 

self.assertIn(self.blob1.identifier, json_doc['blob_refs']) 

self.assertIn(self.blob2.identifier, json_doc['blob_refs']) 

# No extras, so should not be serialized 

self.assertNotIn(measurement.extras.identifier, json_doc['blob_refs']) 

 

# Test deserialization 

new_measurement = Measurement.deserialize( 

blobs=BlobSet([self.blob1, self.blob2]), 

**json_doc) 

# shim in original notes; normally these are deserialized via the 

# Job object. 

new_measurement.notes.update(measurement.notes) 

self.assertEqual(measurement, new_measurement) 

self.assertEqual(measurement.identifier, new_measurement.identifier) 

self.assertIn('Blob1', measurement.blobs) 

self.assertIn('Blob2', measurement.blobs) 

 

def test_PA1_measurement_without_metric(self): 

"""Test a measurement without a Metric instance.""" 

measurement = Measurement('validate_drp.PA1', 0.002 * u.mag) 

 

self.assertIsInstance(measurement.metric_name, Name) 

self.assertEqual(measurement.metric_name, Name('validate_drp.PA1')) 

self.assertIsNone(measurement.metric) 

 

json_doc = measurement.json 

# Units are not converted 

self.assertEqual(json_doc['unit'], 'mag') 

self.assertFloatsAlmostEqual(json_doc['value'], 0.002) 

 

new_measurement = Measurement.deserialize(**json_doc) 

self.assertEqual(measurement, new_measurement) 

self.assertEqual(measurement.identifier, new_measurement.identifier) 

 

def test_PA1_deferred_metric(self): 

"""Test a measurement when the Metric instance is added later.""" 

measurement = Measurement('PA1', 0.002 * u.mag) 

 

self.assertIsNone(measurement.metric) 

self.assertEqual(measurement.metric_name, Name(metric='PA1')) 

 

# Try adding in a metric with the wrong units to existing quantity 

other_metric = Metric('testing.other', 'Incompatible units', 'arcsec') 

with self.assertRaises(TypeError): 

measurement.metric = other_metric 

 

# Add metric in; the name should also update 

measurement.metric = self.pa1 

self.assertEqual(measurement.metric, self.pa1) 

self.assertEqual(measurement.metric_name, self.pa1.name) 

 

def test_PA1_deferred_quantity(self): 

"""Test a measurement where the quantity is added later.""" 

measurement = Measurement(self.pa1) 

json_doc = measurement.json 

self.assertIsNone(json_doc['unit']) 

self.assertIsNone(json_doc['value']) 

 

with self.assertRaises(TypeError): 

# wrong units 

measurement.quantity = 5 * u.arcsec 

 

measurement.quantity = 5 * u.mmag 

quantity_allclose(measurement.quantity, 5 * u.mmag) 

 

def test_creation_with_extras(self): 

"""Test creating a measurement with an extra.""" 

measurement = Measurement( 

self.pa1, 5. * u.mmag, 

extras={'extra1': Datum(10. * u.arcmin, 'Extra 1')}) 

 

self.assertIn(str(self.pa1.name), measurement.blobs) 

self.assertIn('extra1', measurement.extras) 

 

json_doc = measurement.json 

self.assertIn(measurement.extras.identifier, json_doc['blob_refs']) 

 

blobs = BlobSet([b for k, b in measurement.blobs.items()]) 

new_measurement = Measurement.deserialize(blobs=blobs, **json_doc) 

self.assertIn('extra1', new_measurement.extras) 

self.assertEqual(measurement, new_measurement) 

self.assertEqual(measurement.identifier, new_measurement.identifier) 

 

def test_deferred_extras(self): 

"""Test adding extras to an existing measurement.""" 

measurement = Measurement(self.pa1, 5. * u.mmag) 

 

self.assertIn(str(self.pa1.name), measurement.blobs) 

 

measurement.extras['extra1'] = Datum(10. * u.arcmin, 'Extra 1') 

self.assertIn('extra1', measurement.extras) 

 

def test_quantity_coercion(self): 

# strings can't be changed into a Quantity 

with self.assertRaises(TypeError): 

Measurement('test_metric', quantity='hello') 

# objects can't be a Quantity 

with self.assertRaises(TypeError): 

Measurement('test_metric', quantity=int) 

m = Measurement('test_metric', quantity=5) 

self.assertEqual(m.quantity, 5) 

m = Measurement('test_metric', quantity=5.1) 

self.assertEqual(m.quantity, 5.1) 

 

def test_str(self): 

metric = 'test.cmodel_mag' 

value = 1235 * u.mag 

m = Measurement(metric, value) 

self.assertEqual(str(m), "test.cmodel_mag: 1235.0 mag") 

 

def _check_yaml_round_trip(self, old_measurement): 

persisted = yaml.dump(old_measurement) 

new_measurement = yaml.safe_load(persisted) 

 

self.assertEqual(old_measurement, new_measurement) 

# These fields don't participate in Measurement equality 

self.assertEqual(old_measurement.identifier, 

new_measurement.identifier) 

self.assertEqual(old_measurement.blobs, 

new_measurement.blobs) 

self.assertEqual(old_measurement.extras, 

new_measurement.extras) 

 

def test_yamlpersist_basic(self): 

measurement = Measurement('validate_drp.PA1', 0.002 * u.mag) 

self._check_yaml_round_trip(measurement) 

 

def test_yamlpersist_complex(self): 

measurement = Measurement( 

self.pa1, 

5. * u.mmag, 

notes={'filter_name': 'r'}, 

blobs=[self.blob1], 

extras={'extra1': Datum(10. * u.arcmin, 'Extra 1')} 

) 

self._check_yaml_round_trip(measurement) 

 

def test_butler(self): 

CAMERA_ID = "NotACam" 

MAP_ID = "map" 

TRACT_ID = 5 

PATCH_IDS = [42, 43] 

 

root = tempfile.mkdtemp() 

self.addCleanup(shutil.rmtree, root, ignore_errors=True) 

butler = make_test_butler( 

root, 

{ 

"instrument": [{"name": CAMERA_ID}], 

"skymap": [{"name": MAP_ID, "hash": bytes()}], 

"tract": [{"id": TRACT_ID, "skymap": MAP_ID}], 

"patch": [{"id": num, 

"tract": TRACT_ID, 

"skymap": MAP_ID, 

"cell_x": 0, "cell_y": i} 

for i, num in enumerate(PATCH_IDS)], 

}) 

metric_coarse = "verify.dummyMetric" 

make_dataset_type( 

butler, 

self._get_dataset_name(metric_coarse), 

set(), 

"MetricValue") 

metric_fine = "verify.tractableMetric" 

make_dataset_type( 

butler, 

self._get_dataset_name(metric_fine), 

{"instrument", "skymap", "patch", "tract"}, 

"MetricValue") 

 

initial_data = { 

None: Measurement(metric_coarse, 0.052 * u.mag), 

PATCH_IDS[0]: Measurement(metric_fine, 0.2 * u.arcsec), 

PATCH_IDS[1]: Measurement(metric_fine, 0.5 * u.arcsec), 

} 

for patch, value in initial_data.items(): 

# Expect data ID keywords to be ignored for coarse metric 

butler.put( 

value, self._get_dataset_name(value.metric_name), 

instrument=CAMERA_ID, skymap=MAP_ID, tract=TRACT_ID, 

patch=patch) 

 

for patch, value in initial_data.items(): 

dataset_name = self._get_dataset_name(value.metric_name) 

if patch is None: 

unpersisted = butler.get(dataset_name) 

else: 

unpersisted = butler.get( 

dataset_name, 

instrument=CAMERA_ID, skymap=MAP_ID, tract=TRACT_ID, 

patch=patch) 

self.assertEqual(unpersisted, value) 

 

@staticmethod 

def _get_dataset_name(metric_name): 

"""Get the dataset type corresponding to a metric. 

 

Parameters 

---------- 

metric_name : `lsst.verify.Name` or `str` 

The name of the metric to store or retrieve. 

 

Returns 

------- 

dataset_type : `str` 

The name of the corresponding dataset type. 

""" 

raw_name = "metricvalue_%s" % metric_name 

# avoid confusion with compound datasets 

return raw_name.replace(".", "_") 

 

 

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

unittest.main()