Public Member Functions |
Static Public Attributes |
Static Protected Attributes |
List of all members
lsst.ip.isr.vignette.VignetteTask Class Reference
Inheritance diagram for lsst.ip.isr.vignette.VignetteTask:
Public Member Functions | |
| run (self, exposure=None, doUpdateMask=True, maskPlane="NO_DATA", vignetteValue=None, log=None, doUpdatePolygon=True) | |
Static Public Attributes | |
| ConfigClass = VignetteConfig | |
Static Protected Attributes | |
| str | _DefaultName = "isrVignette" |
Detailed Description
Define a simple circular vignette pattern and optionally update mask plane.
Definition at line 62 of file vignette.py.
Member Function Documentation
◆ run()
| lsst.ip.isr.vignette.VignetteTask.run | ( | self, | |
| exposure = None, | |||
| doUpdateMask = True, | |||
| maskPlane = "NO_DATA", | |||
| vignetteValue = None, | |||
| log = None, | |||
| doUpdatePolygon = True ) |
Generate circular vignette pattern.
Parameters
----------
exposure : `lsst.afw.image.Exposure`, optional
Exposure to construct, apply, and optionally mask vignette for.
doUpdateMask : `bool`, optional
If true, the mask will be updated to mask the vignetted region.
maskPlane : `str`, optional
Mask plane to assign vignetted pixels to.
vignetteValue : `float` or `None`, optional
Value to assign to the image array pixels within the ``polygon``
region. If `None`, image pixel values are not replaced.
log : `logging.Logger`, optional
Log object to write to.
doUpdatePolygon : `bool`, optional
If true, the valid polygon will be updated.
Returns
-------
polygon : `lsst.afw.geom.Polygon`
Polygon defining the boundary of the vignetted region.
Definition at line 69 of file vignette.py.
77 ):
78 """Generate circular vignette pattern.
79
80 Parameters
81 ----------
82 exposure : `lsst.afw.image.Exposure`, optional
83 Exposure to construct, apply, and optionally mask vignette for.
84 doUpdateMask : `bool`, optional
85 If true, the mask will be updated to mask the vignetted region.
86 maskPlane : `str`, optional
87 Mask plane to assign vignetted pixels to.
88 vignetteValue : `float` or `None`, optional
89 Value to assign to the image array pixels within the ``polygon``
90 region. If `None`, image pixel values are not replaced.
91 log : `logging.Logger`, optional
92 Log object to write to.
93 doUpdatePolygon : `bool`, optional
94 If true, the valid polygon will be updated.
95
96 Returns
97 -------
98 polygon : `lsst.afw.geom.Polygon`
99 Polygon defining the boundary of the vignetted region.
100 """
101 theta = np.linspace(0, 2*np.pi, num=self.config.numPolygonPoints, endpoint=False)
102 x = self.config.radius*np.cos(theta) + self.config.xCenter
103 y = self.config.radius*np.sin(theta) + self.config.yCenter
104 points = np.array([x, y]).transpose()
106 if exposure is None:
107 return fpPolygon
108
109 # Exposure was provided, so attach the validPolygon associated with the
110 # vignetted region.
111 validPolygon = setValidPolygonCcdIntersect(exposure, fpPolygon, log=log, setPolygon=doUpdatePolygon)
112
113 if doUpdateMask:
114 maskVignettedRegion(
115 exposure,
116 validPolygon,
117 maskPlane=maskPlane,
118 vignetteValue=vignetteValue,
119 log=log,
120 )
121
122 return fpPolygon
123
124
Member Data Documentation
◆ _DefaultName
|
staticprotected |
Definition at line 67 of file vignette.py.
◆ ConfigClass
|
static |
Definition at line 66 of file vignette.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/ip_isr/gc24b5d6ed1+9f17e571f4/python/lsst/ip/isr/vignette.py
Generated on Thu Nov 27 2025 09:15:14 for LSST Applications by
1.13.2