vignetteExposure

lsst.cp.pipe.vignetteExposure(exposure, polygon=None, doUpdateMask=True, maskPlane='NO_DATA', doSetValue=False, vignetteValue=0.0, log=None)

Apply vignetted polygon to image pixels.

Parameters:

exposure : lsst.afw.image.Exposure

Image to be updated.

doUpdateMask : bool, optional

Update the exposure mask for vignetted area?

maskPlane : str, optional

Mask plane to assign.

doSetValue : bool, optional

Set image value for vignetted area?

vignetteValue : float, optional

Value to assign.

log : lsst.log.Log, optional

Log to write to.

Raises:

RuntimeError

Raised if no valid polygon exists.