LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
vignette.py
Go to the documentation of this file.
1 # This file is part of ip_isr.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (https://www.lsst.org).
6 # See the COPYRIGHT file at the top-level directory of this distribution
7 # for details of code ownership.
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <https://www.gnu.org/licenses/>.
21 import numpy
22 
23 import lsst.geom
24 import lsst.afw.geom as afwGeom
25 
26 from lsst.pex.config import Config, Field
27 from lsst.pipe.base import Task
28 
29 
31  """
32  Settings to define vignetteing pattern
33  """
34  xCenter = Field(
35  dtype=float,
36  doc="Center of vignetting pattern, in focal plane x coordinates.",
37  default=0.0,
38  )
39  yCenter = Field(
40  dtype=float,
41  doc="Center of vignetting pattern, in focal plane y coordinates.",
42  default=0.0,
43  )
44  radius = Field(
45  dtype=float,
46  doc="Radius of vignetting pattern, in focal plane coordinates.",
47  default=100.0,
48  check=lambda x: x >= 0
49  )
50  numPolygonPoints = Field(
51  dtype=int,
52  doc="Number of points used to define the vignette polygon.",
53  default=100,
54  )
55  doWriteVignettePolygon = Field(
56  dtype=bool,
57  doc="Persist polygon used to define vignetted region?",
58  default=False,
59  )
60 
61 
63  """Define a simple circular vignette pattern.
64  """
65  ConfigClass = VignetteConfig
66  _DefaultName = "isrVignette"
67 
68  def run(self, exposure):
69  """Generate circular vignette pattern.
70 
71  Parameters
72  ----------
73  exposure : `lsst.afw.image.Exposure`
74  Exposure to construct vignette for.
75 
76  Returns
77  -------
78  polygon : `lsst.afw.Geom.Polygon`
79  Polygon defining the boundary of the vignetted region.
80  """
81 
82  if self.configconfig.doWriteVignettePolygon:
83  theta = numpy.linspace(0, 2*numpy.pi, num=self.configconfig.numPolygonPoints, endpoint=False)
84  x = self.configconfig.radius*numpy.cos(theta) + self.configconfig.xCenter
85  y = self.configconfig.radius*numpy.sin(theta) + self.configconfig.yCenter
86  points = numpy.array([x, y]).transpose()
87  polygon = afwGeom.Polygon([lsst.geom.Point2D(x1, y1) for x1, y1 in reversed(points)])
88  return polygon
89  else:
90  return None
Cartesian polygons.
Definition: Polygon.h:59