lsst.ip.isr.vignette Namespace Reference

Classes
class	VignetteConfig
class	VignetteTask

Functions
	setValidPolygonCcdIntersect (ccdExposure, fpPolygon, log=None, setPolygon=True)
	maskVignettedRegion (exposure, polygon, maskPlane="NO_DATA", vignetteValue=None, log=None)

Function Documentation

maskVignettedRegion()

lsst.ip.isr.vignette.maskVignettedRegion	(		exposure,
			polygon,
			maskPlane = "NO_DATA",
			vignetteValue = None,
			log = None )

Add mask bit to image pixels according to vignetted polygon region.

NOTE: this function could be used to mask and replace pixels associated
with any polygon in the exposure pixel coordinates.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Image whose mask plane is to be updated.
polygon : `lsst.afw.geom.Polygon`
    Polygon region defining the vignetted region in the pixel coordinates
    of ``exposure``.
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.

Raises
------
RuntimeError
    Raised if no valid polygon exists.

Definition at line 171 of file vignette.py.

setValidPolygonCcdIntersect()

lsst.ip.isr.vignette.setValidPolygonCcdIntersect	(		ccdExposure,
			fpPolygon,
			log = None,
			setPolygon = True )

Set valid polygon on ccdExposure associated with focal plane polygon.

The ccd exposure's valid polygon is the intersection of fpPolygon,
a valid polygon in focal plane coordinates, and the ccd corners,
in ccd pixel coordinates.

Parameters
----------
ccdExposure : `lsst.afw.image.Exposure`
    Exposure to process.
fpPolygon : `lsst.afw.geom.Polygon`
    Polygon in focal plane coordinates.
log : `logging.Logger`, optional
    Log object to write to.
setPolygon : `bool`, optional
    Actually set the polygon, or just return it?

Returns
-------
validPolygon : `lsst.afw.geom.Polygon`
    Valid polygon with the intersection.

Definition at line 125 of file vignette.py.