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

# 

# LSST Data Management System 

# Copyright 2016 LSST Corporation. 

# 

# This product includes software developed by the 

# LSST Project (http://www.lsst.org/). 

# 

# 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 LSST License Statement and 

# the GNU General Public License along with this program. If not, 

# see <http://www.lsstcorp.org/LegalNotices/>. 

# 

 

import numpy as np 

 

import lsst.pex.config as pexConfig 

import lsst.pipe.base as pipeBase 

import lsst.afw.geom as afwGeom 

import lsst.afw.image as afwImage 

from lsst.ip.diffim.dcrModel import DcrModel 

 

__all__ = ["GetCoaddAsTemplateTask", "GetCoaddAsTemplateConfig", 

"GetCalexpAsTemplateTask", "GetCalexpAsTemplateConfig"] 

 

 

class GetCoaddAsTemplateConfig(pexConfig.Config): 

templateBorderSize = pexConfig.Field( 

dtype=int, 

default=10, 

doc="Number of pixels to grow the requested template image to account for warping" 

) 

coaddName = pexConfig.Field( 

doc="coadd name: typically one of 'deep', 'goodSeeing', or 'dcr'", 

dtype=str, 

default="deep", 

) 

numSubfilters = pexConfig.Field( 

doc="Number of subfilters in the DcrCoadd, used only if ``coaddName``='dcr'", 

dtype=int, 

default=3, 

) 

warpType = pexConfig.Field( 

doc="Warp type of the coadd template: one of 'direct' or 'psfMatched'", 

dtype=str, 

default="direct", 

) 

 

 

class GetCoaddAsTemplateTask(pipeBase.Task): 

"""Subtask to retrieve coadd for use as an image difference template. 

 

This is the default getTemplate Task to be run as a subtask by 

``pipe.tasks.ImageDifferenceTask``. The main method is ``run()``. 

It assumes that coadds reside in the repository given by sensorRef. 

""" 

 

ConfigClass = GetCoaddAsTemplateConfig 

_DefaultName = "GetCoaddAsTemplateTask" 

 

def run(self, exposure, sensorRef, templateIdList=None): 

"""Retrieve and mosaic a template coadd exposure that overlaps the exposure 

 

Parameters 

---------- 

exposure: `lsst.afw.image.Exposure` 

an exposure for which to generate an overlapping template 

sensorRef : TYPE 

a Butler data reference that can be used to obtain coadd data 

templateIdList : TYPE, optional 

list of data ids (unused) 

 

Returns 

------- 

result : `struct` 

return a pipeBase.Struct: 

 

- ``exposure`` : a template coadd exposure assembled out of patches 

- ``sources`` : None for this subtask 

""" 

skyMap = sensorRef.get(datasetType=self.config.coaddName + "Coadd_skyMap") 

expWcs = exposure.getWcs() 

expBoxD = afwGeom.Box2D(exposure.getBBox()) 

expBoxD.grow(self.config.templateBorderSize) 

ctrSkyPos = expWcs.pixelToSky(expBoxD.getCenter()) 

tractInfo = skyMap.findTract(ctrSkyPos) 

self.log.info("Using skyMap tract %s" % (tractInfo.getId(),)) 

skyCorners = [expWcs.pixelToSky(pixPos) for pixPos in expBoxD.getCorners()] 

patchList = tractInfo.findPatchList(skyCorners) 

 

if not patchList: 

raise RuntimeError("No suitable tract found") 

self.log.info("Assembling %s coadd patches" % (len(patchList),)) 

 

# compute coadd bbox 

coaddWcs = tractInfo.getWcs() 

coaddBBox = afwGeom.Box2D() 

for skyPos in skyCorners: 

coaddBBox.include(coaddWcs.skyToPixel(skyPos)) 

coaddBBox = afwGeom.Box2I(coaddBBox) 

self.log.info("exposure dimensions=%s; coadd dimensions=%s" % 

(exposure.getDimensions(), coaddBBox.getDimensions())) 

 

# assemble coadd exposure from subregions of patches 

coaddExposure = afwImage.ExposureF(coaddBBox, coaddWcs) 

coaddExposure.maskedImage.set(np.nan, afwImage.Mask.getPlaneBitMask("NO_DATA"), np.nan) 

nPatchesFound = 0 

coaddFilter = None 

coaddPsf = None 

for patchInfo in patchList: 

patchSubBBox = patchInfo.getOuterBBox() 

patchSubBBox.clip(coaddBBox) 

patchArgDict = dict( 

datasetType=self.getCoaddDatasetName() + "_sub", 

bbox=patchSubBBox, 

tract=tractInfo.getId(), 

patch="%s,%s" % (patchInfo.getIndex()[0], patchInfo.getIndex()[1]), 

numSubfilters=self.config.numSubfilters, 

) 

if patchSubBBox.isEmpty(): 

self.log.info("skip tract=%(tract)s, patch=%(patch)s; no overlapping pixels" % patchArgDict) 

continue 

 

if self.config.coaddName == 'dcr': 

if not sensorRef.datasetExists(subfilter=0, **patchArgDict): 

self.log.warn("%(datasetType)s, tract=%(tract)s, patch=%(patch)s," 

" numSubfilters=%(numSubfilters)s, subfilter=0 does not exist" 

% patchArgDict) 

continue 

self.log.info("Constructing DCR-matched template for patch %s" % patchArgDict) 

dcrModel = DcrModel.fromDataRef(sensorRef, **patchArgDict) 

coaddPatch = dcrModel.buildMatchedExposure(bbox=patchSubBBox, 

wcs=coaddWcs, 

visitInfo=exposure.getInfo().getVisitInfo()) 

else: 

if not sensorRef.datasetExists(**patchArgDict): 

self.log.warn("%(datasetType)s, tract=%(tract)s, patch=%(patch)s does not exist" 

% patchArgDict) 

continue 

self.log.info("Reading patch %s" % patchArgDict) 

coaddPatch = sensorRef.get(**patchArgDict) 

nPatchesFound += 1 

coaddExposure.maskedImage.assign(coaddPatch.maskedImage, coaddPatch.getBBox()) 

if coaddFilter is None: 

coaddFilter = coaddPatch.getFilter() 

 

# Retrieve the PSF for this coadd tract, if not already retrieved 

if coaddPsf is None and coaddPatch.hasPsf(): 

coaddPsf = coaddPatch.getPsf() 

 

if nPatchesFound == 0: 

raise RuntimeError("No patches found!") 

 

if coaddPsf is None: 

raise RuntimeError("No coadd Psf found!") 

 

coaddExposure.setPsf(coaddPsf) 

coaddExposure.setFilter(coaddFilter) 

return pipeBase.Struct(exposure=coaddExposure, 

sources=None) 

 

def getCoaddDatasetName(self): 

"""Return coadd name for given task config 

 

Returns 

------- 

CoaddDatasetName : `string` 

 

TODO: This nearly duplicates a method in CoaddBaseTask (DM-11985) 

""" 

warpType = self.config.warpType 

suffix = "" if warpType == "direct" else warpType[0].upper() + warpType[1:] 

return self.config.coaddName + "Coadd" + suffix 

 

 

class GetCalexpAsTemplateConfig(pexConfig.Config): 

doAddCalexpBackground = pexConfig.Field( 

dtype=bool, 

default=True, 

doc="Add background to calexp before processing it." 

) 

 

 

class GetCalexpAsTemplateTask(pipeBase.Task): 

"""Subtask to retrieve calexp of the same ccd number as the science image SensorRef 

for use as an image difference template. 

 

To be run as a subtask by pipe.tasks.ImageDifferenceTask. 

Intended for use with simulations and surveys that repeatedly visit the same pointing. 

This code was originally part of Winter2013ImageDifferenceTask. 

""" 

 

ConfigClass = GetCalexpAsTemplateConfig 

_DefaultName = "GetCalexpAsTemplateTask" 

 

def run(self, exposure, sensorRef, templateIdList): 

"""Return a calexp exposure with based on input sensorRef. 

 

Construct a dataId based on the sensorRef.dataId combined 

with the specifications from the first dataId in templateIdList 

 

Parameters 

---------- 

exposure : `lsst.afw.image.Exposure` 

exposure (unused) 

sensorRef : TYPE 

a Butler data reference 

templateIdList : TYPE 

list of data ids, which should contain a single item. 

If there are multiple items, only the first is used. 

 

Returns 

------- 

result : `struct` 

 

return a pipeBase.Struct: 

 

- ``exposure`` : a template calexp 

- ``sources`` : source catalog measured on the template 

""" 

 

if len(templateIdList) == 0: 

raise RuntimeError("No template supplied! Please supply a template visit id.") 

if len(templateIdList) > 1: 

self.log.warn("Multiple template visits supplied. Getting template from first visit: %s" % 

(templateIdList[0]['visit'])) 

 

templateId = sensorRef.dataId.copy() 

templateId.update(templateIdList[0]) 

 

self.log.info("Fetching calexp (%s) as template." % (templateId)) 

 

butler = sensorRef.getButler() 

template = butler.get(datasetType="calexp", dataId=templateId) 

if self.config.doAddCalexpBackground: 

templateBg = butler.get(datasetType="calexpBackground", dataId=templateId) 

mi = template.getMaskedImage() 

mi += templateBg.getImage() 

 

if not template.hasPsf(): 

raise pipeBase.TaskError("Template has no psf") 

 

templateSources = butler.get(datasetType="src", dataId=templateId) 

return pipeBase.Struct(exposure=template, 

sources=templateSources)