lsst.cp.pipe  22.0.0-15-gcbf119a+5bcef16d7b
Classes | Functions
lsst.cp.pipe.cpCombine Namespace Reference

Classes

class  CalibStatsConfig
 
class  CalibStatsTask
 
class  CalibCombineConnections
 
class  CalibCombineConfig
 
class  CalibCombineTask
 
class  CalibCombineByFilterConnections
 
class  CalibCombineByFilterConfig
 
class  CalibCombineByFilterTask
 

Functions

def VignetteExposure (exposure, polygon=None, doUpdateMask=True, maskPlane='BAD', doSetValue=False, vignetteValue=0.0, log=None)
 

Function Documentation

◆ VignetteExposure()

def lsst.cp.pipe.cpCombine.VignetteExposure (   exposure,
  polygon = None,
  doUpdateMask = True,
  maskPlane = 'BAD',
  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.

Definition at line 558 of file cpCombine.py.