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

# This file is part of verify. 

# 

# 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/>. 

 

__all__ = ["PpdbMetricTask", "PpdbMetricConfig", "ConfigPpdbLoader"] 

 

import abc 

 

from lsst.pex.config import Config, ConfigurableField, ConfigurableInstance, \ 

ConfigDictField, ConfigChoiceField, FieldValidationError 

from lsst.pipe.base import Task, Struct, PipelineTaskConnections, \ 

connectionTypes 

from lsst.dax.ppdb import Ppdb, PpdbConfig 

 

from lsst.verify.gen2tasks import MetricTask 

 

 

class ConfigPpdbLoader(Task): 

"""A Task that takes a science task config and returns the corresponding 

Ppdb object. 

 

Parameters 

---------- 

*args 

**kwargs 

Constructor parameters are the same as for `lsst.pipe.base.Task`. 

""" 

_DefaultName = "configPpdb" 

ConfigClass = Config 

 

def __init__(self, **kwargs): 

super().__init__(**kwargs) 

 

def _getPpdb(self, config): 

"""Extract a Ppdb object from an arbitrary task config. 

 

Parameters 

---------- 

config : `lsst.pex.config.Config` or `None` 

A config that may contain a `lsst.dax.ppdb.PpdbConfig`. 

Behavior is undefined if there is more than one such member. 

 

Returns 

------- 

ppdb : `lsst.dax.ppdb.Ppdb`-like or `None` 

A `lsst.dax.ppdb.Ppdb` object or a drop-in replacement, or `None` 

if no `lsst.dax.ppdb.PpdbConfig` is present in ``config``. 

""" 

if config is None: 

return None 

if isinstance(config, PpdbConfig): 

return Ppdb(config) 

 

for field in config.values(): 

if isinstance(field, ConfigurableInstance): 

result = self._getPpdbFromConfigurableField(field) 

if result: 

return result 

elif isinstance(field, ConfigChoiceField.instanceDictClass): 

try: 

# can't test with hasattr because of non-standard getattr 

field.names 

except FieldValidationError: 

result = self._getPpdb(field.active) 

else: 

result = self._getPpdbFromConfigIterable(field.active) 

if result: 

return result 

elif isinstance(field, ConfigDictField.DictClass): 

result = self._getPpdbFromConfigIterable(field.values()) 

if result: 

return result 

elif isinstance(field, Config): 

# Can't test for `ConfigField` more directly than this 

result = self._getPpdb(field) 

if result: 

return result 

return None 

 

def _getPpdbFromConfigurableField(self, configurable): 

"""Extract a Ppdb object from a ConfigurableField. 

 

Parameters 

---------- 

configurable : `lsst.pex.config.ConfigurableInstance` or `None` 

A configurable that may contain a `lsst.dax.ppdb.PpdbConfig`. 

 

Returns 

------- 

ppdb : `lsst.dax.ppdb.Ppdb`-like or `None` 

A `lsst.dax.ppdb.Ppdb` object or a drop-in replacement, if a 

suitable config exists. 

""" 

if configurable is None: 

return None 

 

if configurable.ConfigClass == PpdbConfig: 

return configurable.apply() 

else: 

return self._getPpdb(configurable.value) 

 

def _getPpdbFromConfigIterable(self, configDict): 

"""Extract a Ppdb object from an iterable of configs. 

 

Parameters 

---------- 

configDict: iterable of `lsst.pex.config.Config` or `None` 

A config iterable that may contain a `lsst.dax.ppdb.PpdbConfig`. 

 

Returns 

------- 

ppdb : `lsst.dax.ppdb.Ppdb`-like or `None` 

A `lsst.dax.ppdb.Ppdb` object or a drop-in replacement, if a 

suitable config exists. 

""" 

if configDict: 

for config in configDict: 

result = self._getPpdb(config) 

if result: 

return result 

return None 

 

def run(self, config): 

"""Create a database consistent with a science task config. 

 

Parameters 

---------- 

config : `lsst.pex.config.Config` 

A config that should contain a `lsst.dax.ppdb.PpdbConfig`. 

Behavior is undefined if there is more than one such member. 

 

Returns 

------- 

result : `lsst.pipe.base.Struct` 

Result struct with components: 

 

``ppdb`` 

A database configured the same way as in ``config``, if one 

exists (`lsst.dax.ppdb.Ppdb` or `None`). 

""" 

return Struct(ppdb=self._getPpdb(config)) 

 

 

class PpdbMetricConnections( 

PipelineTaskConnections, 

dimensions=set(), 

defaultTemplates={"taskName": ""}): 

dbInfo = connectionTypes.Input( 

name="{taskName}_config", 

doc="The dataset from which a PPDB instance can be constructed by " 

"`dbLoader`. By default this is assumed to be a top-level " 

"config, such as 'processCcd_config'.", 

storageClass="Config", 

# One config for entire CmdLineTask run 

multiple=False, 

dimensions=set(), 

) 

 

 

class PpdbMetricConfig(MetricTask.ConfigClass, 

pipelineConnections=PpdbMetricConnections): 

"""A base class for PPDB metric task configs. 

""" 

dbLoader = ConfigurableField( 

target=ConfigPpdbLoader, 

doc="Task for loading a database from `dbInfo`. Its run method must " 

"take the dataset provided by `dbInfo` and return a Struct with a " 

"'ppdb' member." 

) 

 

 

class PpdbMetricTask(MetricTask): 

"""A base class for tasks that compute metrics from a prompt products 

database. 

 

Parameters 

---------- 

**kwargs 

Constructor parameters are the same as for 

`lsst.pipe.base.PipelineTask`. 

 

Notes 

----- 

This class should be customized by overriding `makeMeasurement` and 

`getOutputMetricName`. You should not need to override `run`. 

""" 

# Design note: makeMeasurement is an overrideable method rather than a 

# subtask to keep the configs for `MetricsControllerTask` as simple as 

# possible. This was judged more important than ensuring that no 

# implementation details of MetricTask can leak into 

# application-specific code. 

 

ConfigClass = PpdbMetricConfig 

 

def __init__(self, **kwargs): 

super().__init__(**kwargs) 

 

self.makeSubtask("dbLoader") 

 

@abc.abstractmethod 

def makeMeasurement(self, dbHandle, outputDataId): 

"""Compute the metric from database data. 

 

Parameters 

---------- 

dbHandle : `lsst.dax.ppdb.Ppdb` 

A database instance. 

outputDataId : any data ID type 

The subset of the database to which this measurement applies. 

May be empty to represent the entire dataset. 

 

Returns 

------- 

measurement : `lsst.verify.Measurement` or `None` 

The measurement corresponding to the input data. 

 

Raises 

------ 

MetricComputationError 

Raised if an algorithmic or system error prevents calculation of 

the metric. See `run` for expected behavior. 

""" 

 

def run(self, dbInfo, outputDataId={}): 

"""Compute a measurement from a database. 

 

Parameters 

---------- 

dbInfo 

The dataset (of the type indicated by the config) from 

which to load the database. 

outputDataId: any data ID type, optional 

The output data ID for the metric value. Defaults to the empty ID, 

representing a value that covers the entire dataset. 

 

Returns 

------- 

result : `lsst.pipe.base.Struct` 

Result struct with component: 

 

``measurement`` 

the value of the metric (`lsst.verify.Measurement` or `None`) 

 

Raises 

------ 

MetricComputationError 

Raised if an algorithmic or system error prevents calculation of 

the metric. 

 

Notes 

----- 

This implementation calls 

`~lsst.verify.tasks.PpdbMetricConfig.dbLoader` to acquire a database 

handle, then passes it and the value of ``outputDataId`` to 

`makeMeasurement`. The result of `makeMeasurement` is returned to 

the caller. 

""" 

db = self.dbLoader.run(dbInfo).ppdb 

 

if db is not None: 

measurement = self.makeMeasurement(db, outputDataId) 

else: 

measurement = None 

 

return Struct(measurement=measurement)