|
def | run (self, exposure=None, doUpdateMask=True, maskPlane="NO_DATA", vignetteValue=None, log=None) |
|
Define a simple circular vignette pattern and optionally update mask
plane.
Definition at line 69 of file vignette.py.
◆ run()
def lsst.ip.isr.vignette.VignetteTask.run |
( |
|
self, |
|
|
|
exposure = None , |
|
|
|
doUpdateMask = True , |
|
|
|
maskPlane = "NO_DATA" , |
|
|
|
vignetteValue = None , |
|
|
|
log = None |
|
) |
| |
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.
Returns
-------
polygon : `lsst.afw.geom.Polygon`
Polygon defining the boundary of the vignetted region.
Definition at line 76 of file vignette.py.
◆ ConfigClass
The documentation for this class was generated from the following file: