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

# This file is part of ip_isr. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

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

import numpy 

 

import lsst.geom 

import lsst.afw.geom as afwGeom 

 

from lsst.pex.config import Config, Field 

from lsst.pipe.base import Task 

 

 

class VignetteConfig(Config): 

""" 

Settings to define vignetteing pattern 

""" 

xCenter = Field( 

dtype=float, 

doc="Center of vignetting pattern, in focal plane x coordinates.", 

default=0.0, 

) 

yCenter = Field( 

dtype=float, 

doc="Center of vignetting pattern, in focal plane y coordinates.", 

default=0.0, 

) 

44 ↛ exitline 48 didn't finish the lambda on line 48 radius = Field( 

dtype=float, 

doc="Radius of vignetting pattern, in focal plane coordinates.", 

default=100.0, 

check=lambda x: x >= 0 

) 

numPolygonPoints = Field( 

dtype=int, 

doc="Number of points used to define the vignette polygon.", 

default=100, 

) 

doWriteVignettePolygon = Field( 

dtype=bool, 

doc="Persist polygon used to define vignetted region?", 

default=False, 

) 

 

 

class VignetteTask(Task): 

"""Define a simple circular vignette pattern. 

""" 

ConfigClass = VignetteConfig 

_DefaultName = "isrVignette" 

 

def run(self, exposure): 

"""Generate circular vignette pattern. 

 

Parameters 

---------- 

exposure : `lsst.afw.image.Exposure` 

Exposure to construct vignette for. 

 

Returns 

------- 

polygon : `lsst.afw.Geom.Polygon` 

Polygon defining the boundary of the vignetted region. 

""" 

 

if self.config.doWriteVignettePolygon: 

theta = numpy.linspace(0, 2*numpy.pi, num=self.config.numPolygonPoints, endpoint=False) 

x = self.config.radius*numpy.cos(theta) + self.config.xCenter 

y = self.config.radius*numpy.sin(theta) + self.config.yCenter 

points = numpy.array([x, y]).transpose() 

polygon = afwGeom.Polygon([lsst.geom.Point2D(x1, y1) for x1, y1 in reversed(points)]) 

return polygon 

else: 

return None