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

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

# This file is part of meas_base. 

# 

# 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 os 

import numpy 

 

import lsst.geom 

import lsst.afw.table 

import lsst.daf.base 

import lsst.meas.base 

import lsst.utils.tests 

from lsst.meas.base.tests import (AlgorithmTestCase, ) 

from lsst.meas.base.sfm import SingleFramePluginConfig, SingleFramePlugin 

from lsst.meas.base.forcedMeasurement import ForcedPlugin 

from lsst.meas.base.pluginRegistry import register 

from lsst.meas.base import FlagDefinitionList, FlagHandler, MeasurementError 

 

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

 

 

class LoggingPluginConfig(SingleFramePluginConfig): 

"""Configuration for sample plugin. 

""" 

pass 

 

 

@register("test_LoggingPlugin") 

class LoggingPlugin(SingleFramePlugin): 

"""Sample Python plugin which has an associated log name. 

 

Notes 

----- 

The log name is provided to the plugin by the measurement task which is 

running it. This requires that the `hasLogName` attribute must be a member 

of the plugin class, and it must be `True`. 

""" 

hasLogName = True 

ConfigClass = LoggingPluginConfig 

 

@classmethod 

def getExecutionOrder(cls): 

return cls.FLUX_ORDER 

 

# The initializer for the class must accept an optional logName parameter. 

def __init__(self, config, name, schema, metadata, logName=None): 

SingleFramePlugin.__init__(self, config, name, schema, metadata, logName=logName) 

flagDefs = FlagDefinitionList() 

self.FAILURE = flagDefs.addFailureFlag() 

self.CONTAINS_NAN = flagDefs.add("flag_containsNan", "Measurement area contains a nan") 

self.flagHandler = FlagHandler.addFields(schema, name, flagDefs) 

self.instFluxKey = schema.addField(name + "_instFlux", "F", doc="flux") 

 

def measure(self, measRecord, exposure): 

"""Perform measurement. 

 

Notes 

----- 

The `measure` method is called by the measurement framework when `run` 

is called. If a `MeasurementError` is raised during this method, the 

`fail` method will be called to set the error flags. 

""" 

lsst.log.Log.getLogger(self.getLogName()).info("%s plugin measuring."%(self.name,)) 

# Sum the pixels inside the bounding box 

centerPoint = lsst.geom.Point2I(int(measRecord.getX()), int(measRecord.getY())) 

bbox = lsst.geom.Box2I(centerPoint, lsst.geom.Extent2I(1, 1)) 

instFlux = lsst.afw.image.ImageF(exposure.getMaskedImage().getImage(), bbox).getArray().sum() 

measRecord.set(self.instFluxKey, instFlux) 

 

# If there was a NaN inside the bounding box, the instFlux will still 

# be NaN 

if numpy.isnan(instFlux): 

raise MeasurementError(self.CONTAINS_NAN.doc, self.CONTAINS_NAN.number) 

 

def fail(self, measRecord, error=None): 

"""Handle measurement failures. 

 

Notes 

----- 

If measurement raises a `MeasurementError`, the error will be passed 

to the fail method by the measurement framework. If the error is not 

`None`, ``error.cpp`` should correspond to a specific error and the 

appropriate error flag will be set. 

""" 

if error is None: 

self.flagHandler.handleFailure(measRecord) 

else: 

self.flagHandler.handleFailure(measRecord, error.cpp) 

 

 

def directLog(log, file=None): 

"""Direct the log given to a file or to the console if ``file`` is `None`. 

""" 

props = "log4j.rootLogger=INFO, FA\n" 

if file is None: 

props += "log4j.appender.FA=ConsoleAppender\n" 

else: 

props += "log4j.appender.FA=FileAppender\n" 

props += "log4j.appender.FA.Append=false\n" 

props += "log4j.appender.FA.file=%s\n"%(file,) 

props += "log4j.appender.FA.Append=false\n" 

props += "log4j.appender.FA.layout=PatternLayout\n" 

props += "log4j.appender.FA.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss.SSS} %p %c %m %X%n\n" 

props += "log4j.logger.main.a=DEBUG\n" 

log.configure_prop(props) 

 

 

class RegisteredPluginsTestCase(AlgorithmTestCase, lsst.utils.tests.TestCase): 

"""Test all registered Plugins to see if their logName is set as expected. 

 

Those which have the ``hasLogName=True`` attribute will have a ``logName`` 

parameter passed to their ``__init__``, and should set the internal 

``_logName`` attribute. If they are wrapped C++ algorithms, the 

`getLogName` should also return same ``logName`` as the plugin. 

""" 

def testSingleFramePlugins(self): 

center = lsst.geom.Point2D(50, 50) 

bbox = lsst.geom.Box2I(lsst.geom.Point2I(0, 0), 

lsst.geom.Extent2I(100, 100)) 

dataset = lsst.meas.base.tests.TestDataset(bbox) 

dataset.addSource(1000000.0, center) 

registry = SingleFramePlugin.registry 

dependencies = registry.keys() 

task = self.makeSingleFrameMeasurementTask("base_SdssCentroid", dependencies=dependencies) 

exposure, catalog = dataset.realize(noise=100.0, schema=task.schema, randomSeed=0) 

task.log.setLevel(lsst.log.ERROR) 

task.run(catalog, exposure) 

for pluginName in dependencies: 

plugin = task.plugins[pluginName] 

if hasattr(plugin, "hasLogName") and plugin.hasLogName: 

self.assertEqual(plugin.getLogName(), task.getPluginLogName(pluginName)) 

# if the plugin is cpp, check the cpp Algorithm as well 

if hasattr(plugin, "cpp"): 

self.assertEqual(plugin.cpp.getLogName(), plugin.getLogName()) 

else: 

self.assertEqual(plugin.getLogName(), None) 

 

def testForcedPlugins(self): 

# Test all the ForcedPlugins registered to see if their logName is set 

# as expected. 

center = lsst.geom.Point2D(50, 50) 

bbox = lsst.geom.Box2I(lsst.geom.Point2I(0, 0), 

lsst.geom.Extent2I(100, 100)) 

dataset = lsst.meas.base.tests.TestDataset(bbox) 

dataset.addSource(1000000.0, center) 

registry = ForcedPlugin.registry 

dependencies = registry.keys() 

 

task = self.makeForcedMeasurementTask("base_SdssCentroid", dependencies=dependencies) 

measWcs = dataset.makePerturbedWcs(dataset.exposure.getWcs(), randomSeed=1) 

measDataset = dataset.transform(measWcs) 

exposure, truthCatalog = measDataset.realize(10.0, measDataset.makeMinimalSchema(), randomSeed=1) 

refCat = dataset.catalog 

refWcs = dataset.exposure.getWcs() 

measCat = task.generateMeasCat(exposure, refCat, refWcs) 

task.attachTransformedFootprints(measCat, refCat, exposure, refWcs) 

 

task.log.setLevel(lsst.log.ERROR) 

task.run(measCat, exposure, refCat, refWcs) 

for pluginName in dependencies: 

plugin = task.plugins[pluginName] 

if hasattr(plugin, "hasLogName") and plugin.hasLogName: 

self.assertEqual(plugin.getLogName(), task.getPluginLogName(pluginName)) 

# if the plugin is cpp, check the cpp Algorithm as well 

if hasattr(plugin, "cpp"): 

self.assertEqual(plugin.cpp.getLogName(), task.log.getName() + "." + pluginName) 

else: 

self.assertEqual(plugin.getLogName(), None) 

 

 

class LoggingPythonTestCase(AlgorithmTestCase, lsst.utils.tests.TestCase): 

"""Test one C++ and one Python plugin which have hasLogName=True. 

""" 

def setUp(self): 

bbox = lsst.geom.Box2I(lsst.geom.Point2I(0, 0), lsst.geom.Point2I(100, 100)) 

self.dataset = lsst.meas.base.tests.TestDataset(bbox) 

self.dataset.addSource(instFlux=1E5, centroid=lsst.geom.Point2D(25, 25)) 

config = lsst.meas.base.SingleFrameMeasurementConfig() 

config.slots.centroid = None 

config.slots.apFlux = None 

config.slots.calibFlux = None 

config.slots.gaussianFlux = None 

config.slots.modelFlux = None 

config.slots.psfFlux = None 

config.slots.shape = None 

config.slots.psfShape = None 

self.config = config 

 

def tearDown(self): 

del self.config 

del self.dataset 

 

def testLoggingPythonPlugin(self): 

algName = "test_LoggingPlugin" 

schema = self.dataset.makeMinimalSchema() 

self.config.plugins = [algName] 

task = lsst.meas.base.SingleFrameMeasurementTask(schema=schema, config=self.config) 

# test that the plugin's logName has been propagated to the plugin 

self.assertTrue(task.plugins[algName].getLogName(), task.getPluginLogName(algName)) 

log = lsst.log.Log.getLogger(task.getPluginLogName(algName)) 

with lsst.utils.tests.getTempFilePath(".log") as pluginLogName: 

directLog(log, pluginLogName) 

exposure, cat = self.dataset.realize(noise=0.0, schema=schema, randomSeed=2) 

task.run(cat, exposure) 

directLog(log, None) 

# direct back to console, closing log files 

with open(pluginLogName) as fin: 

lines = fin.read() 

# test that the sample plugin has correctly logged to where we 

# expected it to. 

self.assertTrue(lines.find("measuring") >= 0) 

 

def testLoggingCppPlugin(self): 

# PsfFlux is known to log an ``ERROR`` if a Psf is not attached 

algName = "base_PsfFlux" 

self.config.plugins = [algName] 

 

schema = self.dataset.makeMinimalSchema() 

task = lsst.meas.base.SingleFrameMeasurementTask(schema=schema, config=self.config) 

log = lsst.log.Log.getLogger(task.getPluginLogName(algName)) 

log.setLevel(lsst.log.ERROR) 

 

# test that the plugin's logName has been propagated to the plugin 

self.assertTrue(task.plugins[algName].getLogName(), task.getPluginLogName(algName)) 

self.assertTrue(task.plugins[algName].cpp.getLogName(), task.getPluginLogName(algName)) 

with lsst.utils.tests.getTempFilePath(".log") as pluginLogName: 

directLog(log, pluginLogName) 

exposure, cat = self.dataset.realize(noise=0.0, schema=schema, randomSeed=3) 

exposure.setPsf(None) 

# This call throws an error, so be prepared for it 

try: 

task.run(cat, exposure) 

except Exception: 

pass 

directLog(log, None) 

# direct back to console, closing log files 

with open(pluginLogName) as fin: 

lines = fin.read() 

# test that the sample plugin has correctly logged to where we 

# expected it to. 

self.assertTrue(lines.find("ERROR") >= 0) 

 

 

class SingleFrameTestCase(AlgorithmTestCase, lsst.utils.tests.TestCase): 

 

def setUp(self): 

# object in corner to trigger EDGE error 

self.center = lsst.geom.Point2D(5, 5) 

self.bbox = lsst.geom.Box2I(lsst.geom.Point2I(0, 0), 

lsst.geom.Extent2I(100, 100)) 

self.dataset = lsst.meas.base.tests.TestDataset(self.bbox) 

self.dataset.addSource(1000000.0, self.center) 

self.task = self.makeSingleFrameMeasurementTask("base_SdssCentroid") 

self.log = lsst.log.Log.getLogger(self.task.getPluginLogName("base_SdssCentroid")) 

self.exposure, self.catalog = self.dataset.realize(10.0, self.task.schema, randomSeed=4) 

 

def tearDown(self): 

del self.center 

del self.bbox 

del self.dataset 

del self.task 

del self.log 

del self.exposure 

del self.catalog 

 

def testSeparatePluginLogs(self): 

"""Check that the task log and the plugin log are truly separate. 

""" 

taskLogName = os.path.join(ROOT, 'testSeparatePluginLogs-task.log') 

directLog(self.task.log, taskLogName) 

self.task.log.info("Testing") 

with lsst.utils.tests.getTempFilePath(".log") as pluginLogName: 

directLog(self.log, pluginLogName) 

self.log.setLevel(lsst.log.DEBUG) 

self.task.run(self.catalog, self.exposure) 

# direct back to console, closing log files 

directLog(self.log, None) 

directLog(self.task.log, None) 

with open(taskLogName) as fin: 

lines = fin.read() 

os.unlink(taskLogName) 

self.assertTrue(lines.find("Testing") >= 0) 

with open(pluginLogName) as fin: 

lines = fin.read() 

self.assertTrue(lines.find("MeasurementError") >= 0) 

 

def testSetPluginLevel(self): 

"""Test setting the plugin log level. 

 

Specifically, we set it to the ``ERROR`` level. 

""" 

with lsst.utils.tests.getTempFilePath(".log") as pluginLogName: 

directLog(self.log, pluginLogName) 

self.log.setLevel(lsst.log.ERROR) 

self.task.run(self.catalog, self.exposure) 

# direct back to console, closing log files 

directLog(self.log, None) 

with open(pluginLogName) as fin: 

lines = fin.read() 

self.assertTrue(lines.find("MeasurementError") < 0) 

 

 

class ForcedTestCase(AlgorithmTestCase, lsst.utils.tests.TestCase): 

 

def setUp(self): 

# object in corner to trigger EDGE error 

self.center = lsst.geom.Point2D(0, 0) 

self.bbox = lsst.geom.Box2I(lsst.geom.Point2I(0, 0), 

lsst.geom.Extent2I(100, 100)) 

self.dataset = lsst.meas.base.tests.TestDataset(self.bbox) 

self.dataset.addSource(1000000.0, self.center) 

self.task = self.makeForcedMeasurementTask("base_SdssCentroid") 

self.log = lsst.log.Log.getLogger(self.task.getPluginLogName("base_SdssCentroid")) 

measWcs = self.dataset.makePerturbedWcs(self.dataset.exposure.getWcs(), randomSeed=5) 

measDataset = self.dataset.transform(measWcs) 

self.exposure, truthCatalog = measDataset.realize(10.0, measDataset.makeMinimalSchema(), randomSeed=5) 

self.refCat = self.dataset.catalog 

self.refWcs = self.dataset.exposure.getWcs() 

self.measCat = self.task.generateMeasCat(self.exposure, self.refCat, self.refWcs) 

self.task.attachTransformedFootprints(self.measCat, self.refCat, self.exposure, self.refWcs) 

 

def tearDown(self): 

del self.center 

del self.bbox 

del self.dataset 

del self.task 

del self.log 

del self.exposure 

del self.measCat 

del self.refCat 

del self.refWcs 

 

def testSeparatePluginLog(self): 

"""Check that the task log and the plugin log are truly separate. 

""" 

taskLogName = os.path.join(ROOT, 'testSeparatePluginLog-task.log') 

directLog(self.task.log, taskLogName) 

self.task.log.info("Testing") 

with lsst.utils.tests.getTempFilePath(".log") as pluginLogName: 

directLog(self.log, pluginLogName) 

self.log.setLevel(lsst.log.DEBUG) 

self.task.run(self.measCat, self.exposure, self.refCat, self.refWcs) 

# direct back to console, closing log files 

directLog(self.log, None) 

directLog(self.task.log, None) 

with open(taskLogName) as fin: 

lines = fin.read() 

os.unlink(taskLogName) 

self.assertTrue(lines.find("Testing") >= 0) 

with open(pluginLogName) as fin: 

lines = fin.read() 

self.assertTrue(lines.find("MeasurementError") >= 0) 

 

def testSetPluginLevel(self): 

"""Test setting the plugin log level. 

 

Specifically, we set it to the ``ERROR`` level. 

""" 

with lsst.utils.tests.getTempFilePath(".log") as pluginLogName: 

directLog(self.log, pluginLogName) 

self.log.setLevel(lsst.log.ERROR) 

self.task.run(self.measCat, self.exposure, self.refCat, self.refWcs) 

# direct back to console, closing log files 

directLog(self.log, None) 

with open(pluginLogName) as fin: 

lines = fin.read() 

self.assertTrue(lines.find("MeasurementError") < 0) 

 

 

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

pass 

 

 

def setup_module(module): 

lsst.utils.tests.init() 

 

 

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

lsst.utils.tests.init() 

unittest.main()