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

# 

# LSST Data Management System 

# Copyright 2008, 2009, 2010 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/>. 

# 

 

__all__ = ["CatalogStarSelectorConfig", "CatalogStarSelectorTask"] 

 

import numpy as np 

 

from lsst.meas.algorithms import BaseSourceSelectorTask, sourceSelectorRegistry 

from lsst.pipe.base import Struct 

import lsst.pex.config as pexConfig 

import lsst.afw.display.ds9 as ds9 

 

 

class CatalogStarSelectorConfig(BaseSourceSelectorTask.ConfigClass): 

fluxLim = pexConfig.RangeField( 

doc="specify the minimum psfFlux for good Psf Candidates", 

dtype=float, 

default=0.0, 

min=0.0, 

) 

fluxMax = pexConfig.RangeField( 

doc="specify the maximum psfFlux for good Psf Candidates (ignored if == 0)", 

dtype=float, 

default=0.0, 

min=0.0, 

) 

badFlags = pexConfig.ListField( 

doc="List of flags which cause a source to be rejected as bad", 

dtype=str, 

default=[ 

"base_PixelFlags_flag_edge", 

"base_PixelFlags_flag_interpolatedCenter", 

"base_PixelFlags_flag_saturatedCenter", 

], 

) 

 

 

class CheckSource: 

"""A functor to check whether a source has any flags set that should cause it to be labeled bad.""" 

 

def __init__(self, table, fluxLim, fluxMax, badFlags): 

self.keys = [table.getSchema().find(name).key for name in badFlags] 

self.keys.append(table.getCentroidFlagKey()) 

self.fluxLim = fluxLim 

self.fluxMax = fluxMax 

 

def __call__(self, source): 

for k in self.keys: 

if source.get(k): 

return False 

if self.fluxLim is not None and source.getPsfInstFlux() < self.fluxLim: # ignore faint objects 

return False 

if self.fluxMax != 0.0 and source.getPsfInstFlux() > self.fluxMax: # ignore bright objects 

return False 

return True 

 

# \addtogroup LSST_task_documentation 

# \{ 

# \page CatalogStarSelectorTask 

# \ref CatalogStarSelectorTask_ "CatalogStarSelectorTask" 

# \copybrief CatalogStarSelectorTask 

# \} 

 

 

@pexConfig.registerConfigurable("catalog", sourceSelectorRegistry) 

class CatalogStarSelectorTask: 

"""!Select stars based on a reference catalog 

 

@anchor CatalogStarSelectorTask_ 

 

@section meas_astrom_catalogStarSelector_Contents Contents 

 

- @ref meas_astrom_catalogStarSelector_Purpose 

- @ref meas_astrom_catalogStarSelector_Initialize 

- @ref meas_astrom_catalogStarSelector_IO 

- @ref meas_astrom_catalogStarSelector_Config 

- @ref meas_astrom_catalogStarSelector_Debug 

 

@section meas_astrom_catalogStarSelector_Purpose Description 

 

Select stars using a match list: select sources where the matching reference object is unresolved, 

plus the source passes the following tests: 

- no flag from config.badFlags is set 

- psf flux >= config.fluxLim 

- psf flux <= config.fluxMax (not checked if fluxMax == 0) 

 

@section meas_astrom_catalogStarSelector_Initialize Task initialisation 

 

@copydoc \_\_init\_\_ 

 

@section meas_astrom_catalogStarSelector_IO Invoking the Task 

 

Like all star selectors, the main method is `run`. Unlike most star selectors, 

this one requires the `matches` argument (the `usesMatches` property is true). 

 

@section meas_astrom_catalogStarSelector_Config Configuration parameters 

 

See @ref CatalogStarSelectorConfig 

 

@section meas_astrom_catalogStarSelector_Debug Debug variables 

 

CatalogStarSelectorTask has a debug dictionary with the following keys: 

<dl> 

<dt>display 

<dd>bool; if True display debug information 

<dt>pauseAtEnd 

<dd>bool; if True wait after displaying everything and wait for user input 

</dl> 

 

For example, put something like: 

@code{.py} 

import lsstDebug 

def DebugInfo(name): 

di = lsstDebug.getInfo(name) # N.b. lsstDebug.Info(name) would call us recursively 

if name.endswith("catalogStarSelector"): 

di.display = True 

 

return di 

 

lsstDebug.Info = DebugInfo 

@endcode 

into your `debug.py` file and run your task with the `--debug` flag. 

""" 

ConfigClass = CatalogStarSelectorConfig 

usesMatches = True # `run` and `selectStars` require the `matches` argument 

 

def selectSources(self, sourceCat, matches=None, exposure=None): 

"""Return a selection of sources based on reference catalog matches. 

 

Parameters 

---------- 

sourceCat : `lsst.afw.table.SourceCatalog` 

Catalog of sources to select from. 

This catalog must be contiguous in memory. 

matches : `list` of `lsst.afw.table.ReferenceMatch` 

A match vector as produced by meas_astrom; required. 

exposure : `lsst.afw.image.Exposure` or None 

The exposure the catalog was built from; used for debug display. 

 

Return 

------ 

struct : `lsst.pipe.base.Struct` 

The struct contains the following data: 

 

- selected : `numpy.ndarray` of `bool`` 

Boolean array of sources that were selected, same length as 

sourceCat. 

""" 

import lsstDebug 

debugInfo = lsstDebug.Info(__name__) 

display = debugInfo.display 

pauseAtEnd = debugInfo.pauseAtEnd # pause when done 

 

if matches is None: 

raise RuntimeError("CatalogStarSelectorTask requires matches") 

 

mi = exposure.getMaskedImage() 

 

if display: 

frame = 1 

ds9.mtv(mi, frame=frame, title="PSF candidates") 

 

isGoodSource = CheckSource(sourceCat, self.config.fluxLim, self.config.fluxMax, self.config.badFlags) 

good = np.array([isGoodSource(record) for record in sourceCat]) 

 

with ds9.Buffering(): 

for ref, source, d in matches: 

if not ref.get("resolved"): 

if not isGoodSource(source): 

symb, ctype = "+", ds9.RED 

else: 

symb, ctype = "+", ds9.GREEN 

 

if display: 

ds9.dot(symb, source.getX() - mi.getX0(), source.getY() - mi.getY0(), 

size=4, frame=frame, ctype=ctype) 

 

if display and pauseAtEnd: 

input("Continue? y[es] p[db] ") 

 

return Struct(selected=good)