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.

Member Data Documentation

◆ _DefaultName

str lsst.ip.isr.vignette.VignetteTask._DefaultName = "isrVignette"

staticprotected

Definition at line 67 of file vignette.py.

◆ ConfigClass

lsst.ip.isr.vignette.VignetteTask.ConfigClass = VignetteConfig

static

Definition at line 66 of file vignette.py.

The documentation for this class was generated from the following file:

python/lsst/ip/isr/vignette.py

Public Member Functions