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

# This file is part of ctrl_mpexec. 

# 

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

 

__all__ = ['SingleQuantumExecutor'] 

 

# ------------------------------- 

# Imports of standard modules -- 

# ------------------------------- 

import logging 

from itertools import chain 

 

# ----------------------------- 

# Imports for other modules -- 

# ----------------------------- 

from lsst.log import Log 

from lsst.pipe.base import ButlerQuantumContext 

 

# ---------------------------------- 

# Local non-exported definitions -- 

# ---------------------------------- 

 

_LOG = logging.getLogger(__name__.partition(".")[2]) 

 

 

class SingleQuantumExecutor: 

"""Executor class which runs one Quantum at a time. 

 

Parameters 

---------- 

butler : `~lsst.daf.butler.Butler` 

Data butler. 

taskFactory : `~lsst.pipe.base.TaskFactory` 

Instance of a task factory. 

""" 

def __init__(self, butler, taskFactory): 

self.butler = butler 

self.taskFactory = taskFactory 

 

def execute(self, taskClass, config, quantum): 

"""Execute PipelineTask on a single Quantum. 

 

Parameters 

---------- 

taskClass : `type` 

Sub-class of `~lsst.pipe.base.PipelineTask`. 

config : `~lsst.pipe.base.PipelineTaskConfig` 

Configuration object for this task 

quantum : `~lsst.daf.butler.Quantum` 

Single Quantum instance. 

""" 

self.setupLogging(taskClass, config, quantum) 

self.updateQuantumInputs(quantum) 

task = self.makeTask(taskClass, config) 

self.runQuantum(task, quantum) 

 

def setupLogging(self, taskClass, config, quantum): 

"""Configure logging system for execution of this task. 

 

Ths method can setup logging to attach task- or 

quantum-specific information to log messages. Potentially this can 

take into accout some info from task configuration as well. 

 

Parameters 

---------- 

taskClass : `type` 

Sub-class of `~lsst.pipe.base.PipelineTask`. 

config : `~lsst.pipe.base.PipelineTaskConfig` 

Configuration object for this task 

quantum : `~lsst.daf.butler.Quantum` 

Single Quantum instance. 

""" 

# include input dataIds into MDC 

dataIds = set(ref.dataId for ref in chain.from_iterable(quantum.predictedInputs.values())) 

if dataIds: 

if len(dataIds) == 1: 

Log.MDC("LABEL", str(dataIds.pop())) 

else: 

Log.MDC("LABEL", '[' + ', '.join([str(dataId) for dataId in dataIds]) + ']') 

 

def makeTask(self, taskClass, config): 

"""Make new task instance. 

 

Parameters 

---------- 

taskClass : `type` 

Sub-class of `~lsst.pipe.base.PipelineTask`. 

config : `~lsst.pipe.base.PipelineTaskConfig` 

Configuration object for this task 

 

Returns 

------- 

task : `~lsst.pipe.base.PipelineTask` 

Instance of ``taskClass`` type. 

""" 

# call task factory for that 

return self.taskFactory.makeTask(taskClass, config, None, self.butler) 

 

def updateQuantumInputs(self, quantum): 

"""Update quantum with extra information. 

 

Some methods may require input DatasetRefs to have non-None 

``dataset_id``, but in case of intermediate dataset it may not be 

filled during QuantumGraph construction. This method will retrieve 

missing info from registry. 

 

Parameters 

---------- 

quantum : `~lsst.daf.butler.Quantum` 

Single Quantum instance. 

""" 

butler = self.butler 

for refs in quantum.predictedInputs.values(): 

for ref in refs: 

if ref.id is None: 

storedRef = butler.registry.find(butler.collection, ref.datasetType, ref.dataId) 

if storedRef is None: 

raise ValueError( 

f"Cannot find {ref.datasetType.name} with id {ref.dataId} " 

f"in collection {butler.collection}." 

) 

ref._id = storedRef.id 

_LOG.debug("Updated dataset ID for %s", ref) 

 

def runQuantum(self, task, quantum): 

"""Execute task on a single quantum. 

 

Parameters 

---------- 

task : `~lsst.pipe.base.PipelineTask` 

Task object. 

quantum : `~lsst.daf.butler.Quantum` 

Single Quantum instance. 

""" 

# Create a butler that operates in the context of a quantum 

butlerQC = ButlerQuantumContext(self.butler, quantum) 

 

# Get the input and output references for the task 

connectionInstance = task.config.connections.ConnectionsClass(config=task.config) 

inputRefs, outputRefs = connectionInstance.buildDatasetRefs(quantum) 

# Call task runQuantum() method. Any exception thrown by the task 

# propagates to caller. 

task.runQuantum(butlerQC, inputRefs, outputRefs)