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

# 

# This file is part of ap_verify. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (http://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 <http://www.gnu.org/licenses/>. 

# 

 

"""Interface between `ap_verify` and `ap_pipe`. 

 

This module handles calling `ap_pipe` and converting any information 

as needed. It also attempts to collect measurements step-by-step, so 

that a total pipeline failure still allows some measurements to be 

recovered. 

""" 

 

__all__ = ["ApPipeParser", "MeasurementStorageError", "runApPipe"] 

 

import argparse 

import os 

import re 

 

import json 

 

import lsst.log 

import lsst.daf.persistence as dafPersist 

import lsst.ap.pipe as apPipe 

from lsst.verify import Job 

 

 

# borrowed from validate_drp 

def _extract_instrument_from_butler(butler): 

"""Extract the last part of the mapper name from a Butler repo. 

'lsst.obs.lsstSim.lsstSimMapper.LsstSimMapper' -> 'LSSTSIM' 

'lsst.obs.cfht.megacamMapper.MegacamMapper' -> 'CFHT' 

'lsst.obs.decam.decamMapper.DecamMapper' -> 'DECAM' 

'lsst.obs.hsc.hscMapper.HscMapper' -> 'HSC' 

""" 

camera = butler.get('camera') 

instrument = camera.getName() 

return instrument.upper() 

 

 

class ApPipeParser(argparse.ArgumentParser): 

"""An argument parser for data needed by ``ap_pipe`` activities. 

 

This parser is not complete, and is designed to be passed to another parser 

using the `parent` parameter. 

""" 

 

def __init__(self): 

# Help and documentation will be handled by main program's parser 

argparse.ArgumentParser.__init__(self, add_help=False) 

self.add_argument('--id', dest='dataId', required=True, 

help='An identifier for the data to process. ' 

'May not support all features of a Butler dataId; ' 

'see the ap_pipe documentation for details.') 

self.add_argument("-j", "--processes", default=1, type=int, 

help="Number of processes to use. Not yet implemented.") 

 

 

class MeasurementStorageError(RuntimeError): 

pass 

 

 

def _updateMetrics(metadata, job): 

"""Update a Job object with the measurements created from running a task. 

 

The metadata shall be searched for the locations of Job dump files from 

the most recent run of a task and its subtasks; the contents of these 

files shall be added to `job`. This method is a temporary workaround 

for the `verify` framework's limited persistence support, and will be 

removed in a future version. 

 

Parameters 

---------- 

metadata : `lsst.daf.base.PropertySet` 

The full metadata from running a task(s). Assumed to contain keys of 

the form "<standard task prefix>.verify_json_path" that maps to the 

absolute file location of that task's serialized measurements. 

All other metadata fields are ignored. 

job : `lsst.verify.Job` 

The Job object to which to add measurements. This object shall be 

left in a consistent state if this method raises exceptions. 

 

Raises 

------ 

lsst.ap.verify.pipeline_driver.MeasurementStorageError 

Raised if a "verify_json_path" key does not map to a string, or serialized 

measurements could not be located or read from disk. 

""" 

try: 

keys = metadata.names(topLevelOnly=False) 

files = [metadata.getAsString(key) for key in keys if key.endswith('verify_json_path')] 

 

for measurementFile in files: 

with open(measurementFile) as f: 

taskJob = Job.deserialize(**json.load(f)) 

job += taskJob 

except (IOError, TypeError) as e: 

raise MeasurementStorageError('Task metadata could not be read; possible downstream bug') from e 

 

 

def runApPipe(metricsJob, workspace, parsedCmdLine): 

"""Run `ap_pipe` on this object's dataset. 

 

Parameters 

---------- 

metricsJob : `lsst.verify.Job` 

The Job object to which to add any metric measurements made. 

workspace : `lsst.ap.verify.workspace.Workspace` 

The abstract location containing input and output repositories. 

parsedCmdLine : `argparse.Namespace` 

Command-line arguments, including all arguments supported by `ApPipeParser`. 

 

Raises 

------ 

lsst.ap.verify.pipeline_driver.MeasurementStorageError 

Raised if measurements were made, but `metricsJob` could not be updated 

with all of them. This exception may suppress exceptions raised by 

the pipeline itself. 

""" 

log = lsst.log.Log.getLogger('ap.verify.pipeline_driver.runApPipe') 

 

dataId = _parseDataId(parsedCmdLine.dataId) 

# After processes are implemented, remove the flake exception 

processes = parsedCmdLine.processes # noqa: F841 

 

# Insert job metadata including dataId 

metricsJob.meta.update({'instrument': _extract_instrument_from_butler(workspace.workButler)}) 

metricsJob.meta.update(dataId) 

 

pipeline = apPipe.ApPipeTask(workspace.workButler, config=_getConfig(workspace)) 

try: 

for dataRef in dafPersist.searchDataRefs(workspace.workButler, datasetType='raw', 

dataId=dataId): 

pipeline.runDataRef(dataRef) 

pipeline.writeMetadata(dataRef) 

log.info('Pipeline complete') 

finally: 

# Recover any metrics from completed pipeline steps, even if the pipeline fails 

_updateMetrics(pipeline.getFullMetadata(), metricsJob) 

 

 

def _getConfig(workspace): 

"""Return the config for running ApPipeTask on this workspace. 

 

Parameters 

---------- 

workspace : `lsst.ap.verify.workspace.Workspace` 

A Workspace whose config directory may contain an 

`~lsst.ap.pipe.ApPipeTask` config. 

 

Returns 

------- 

config : `lsst.ap.pipe.ApPipeConfig` 

The config for running `~lsst.ap.pipe.ApPipeTask`. 

""" 

overrideFile = apPipe.ApPipeTask._DefaultName + ".py" 

# TODO: may not be needed depending on resolution of DM-13887 

mapper = dafPersist.Butler.getMapperClass(workspace.dataRepo) 

packageDir = lsst.utils.getPackageDir(mapper.getPackageName()) 

 

config = apPipe.ApPipeTask.ConfigClass() 

# Equivalent to task-level default for ap_verify 

 

# ApVerify will use the sqlite hooks for the Ppdb. 

config.ppdb.db_url = "sqlite:///" + workspace.dbLocation 

config.ppdb.isolation_level = "READ_UNCOMMITTED" 

 

for path in [ 

os.path.join(packageDir, 'config'), 

os.path.join(packageDir, 'config', mapper.getCameraName()), 

workspace.configDir, 

]: 

overridePath = os.path.join(path, overrideFile) 

if os.path.exists(overridePath): 

config.load(overridePath) 

return config 

 

 

def _deStringDataId(dataId): 

''' 

Replace a dataId's values with numbers, where appropriate. 

 

Parameters 

---------- 

dataId : `dict` from `str` to any 

The dataId to be cleaned up. 

''' 

integer = re.compile(r'^\s*[+-]?\d+\s*$') 

for key, value in dataId.items(): 

if isinstance(value, str) and integer.match(value) is not None: 

dataId[key] = int(value) 

 

 

def _parseDataId(rawDataId): 

"""Convert a dataId from a command-line string to a dict. 

 

Parameters 

---------- 

rawDataId : `str` 

A string in a format like "visit=54321 ccdnum=7". 

 

Returns 

------- 

dataId : `dict` from `str` to any type 

A dataId ready for passing to Stack operations. 

""" 

dataIdItems = re.split('[ +=]', rawDataId) 

dataId = dict(zip(dataIdItems[::2], dataIdItems[1::2])) 

_deStringDataId(dataId) 

return dataId