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

# 

# 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 for running measurement code. 

 

The rest of `ap_verify` should access `measurements` through the functions 

defined here, rather than depending on individual measurement functions. 

""" 

 

__all__ = ["measureFromButlerRepo"] 

 

import copy 

from lsst.verify.compatibility import MetricsControllerTask 

from lsst.ap.pipe import ApPipeTask 

from .association import measureNumberNewDiaObjects, \ 

measureNumberUnassociatedDiaObjects, \ 

measureFractionUpdatedDiaObjects, \ 

measureNumberSciSources, \ 

measureFractionDiaSourcesToSciSources, \ 

measureTotalUnassociatedDiaObjects 

 

 

def measureFromMetadata(metadata): 

"""Compute all known metrics on Task metadata. 

 

Metrics and measurement information are registered in the ``ap_verify`` 

configuration file under the ``measurements`` label. 

 

Parameters 

---------- 

metadata : `lsst.daf.base.PropertySet` 

The metadata to search for measurements. 

 

Returns 

------- 

measurements : iterable of `lsst.verify.Measurement` 

all the measurements derived from ``metadata``. May be empty. 

 

Raises 

------ 

RuntimeError 

the ``ap_verify`` configuration file exists, but does not contain the 

expected data under ``measurements`` 

""" 

result = [] 

 

measurement = measureNumberNewDiaObjects( 

metadata, 'apPipe:associator', 'ap_association.numNewDiaObjects') 

if measurement is not None: 

result.append(measurement) 

measurement = measureFractionUpdatedDiaObjects( 

metadata, 'apPipe:associator', 'ap_association.fracUpdatedDiaObjects') 

if measurement is not None: 

result.append(measurement) 

measurement = measureNumberUnassociatedDiaObjects( 

metadata, 'apPipe:associator', 'ap_association.numUnassociatedDiaObjects') 

if measurement is not None: 

result.append(measurement) 

return result 

 

 

def measureFromButlerRepo(butler, rawDataId): 

"""Create measurements from a butler repository. 

 

Parameters 

---------- 

butler : `lsst.daf.persistence.Butler` 

A butler opened to the repository to read. 

rawDataId : `lsst.daf.persistence.DataId` or `dict` 

Butler identifier naming the data given to ap_pipe. 

 

Returns 

------- 

measurements : iterable of `lsst.verify.Measurement` 

all the measurements derived from ``metadata``. May be empty. 

""" 

result = [] 

 

dataId = copy.copy(rawDataId) 

# Workaround for bug where Butler tries to load HDU 

# even when template doesn't have one 

if "hdu" in dataId: 

del dataId["hdu"] 

 

timingConfig = MetricsControllerTask.ConfigClass() 

timingConfig.jobFileTemplate = "ap_verify.metricTask{id}.{dataId}.verify.json" 

_runMetricTasks(timingConfig, butler, dataId) 

 

measurement = measureNumberSciSources( 

butler, dataId, "ip_diffim.numSciSources") 

if measurement is not None: 

result.append(measurement) 

 

measurement = measureFractionDiaSourcesToSciSources( 

butler, dataId, "ip_diffim.fracDiaSourcesToSciSources") 

if measurement is not None: 

result.append(measurement) 

 

config = butler.get(ApPipeTask._DefaultName + '_config') 

result.extend(measureFromPpdb(config.ppdb)) 

 

metadata = butler.get(ApPipeTask._DefaultName + '_metadata', dataId=dataId) 

result.extend(measureFromMetadata(metadata)) 

return result 

 

 

def _runMetricTasks(config, butler, dataId): 

"""Run MetricControllerTask on a single dataset. 

 

Parameters 

---------- 

config : `lsst.verify.compatibility.MetricsControllerConfig` 

The config for running `~lsst.verify.compatibility.MetricsControllerTask`. 

butler : `lsst.daf.persistence.Butler` 

A butler opened to ap_verify's output repository. 

dataId : `lsst.daf.persistence.DataId` or `dict` 

The data ID for this run of ``ap_verify``. 

""" 

allMetricTasks = MetricsControllerTask(config) 

 

# Don't particularly want calexps, but they tend to have compatible 

# data IDs with other processed data types 

processedDatarefs = butler.subset('calexp', dataId=dataId) 

allMetricTasks.runDataRefs(processedDatarefs) 

 

 

def measureFromPpdb(configurable): 

"""Make measurements on a ppdb database containing the results of 

source association. 

 

configurable : `lsst.pex.config.ConfigurableInstance` 

A configurable object for a `lsst.dax.ppdb.Ppdb` or similar type. 

""" 

result = [] 

ppdb = configurable.apply() 

measurement = measureTotalUnassociatedDiaObjects( 

ppdb, "ap_association.totalUnassociatedDiaObjects") 

if measurement is not None: 

result.append(measurement) 

 

return result