lsst.ip.isr.vignette.VignetteTask Class Reference

Inheritance diagram for lsst.ip.isr.vignette.VignetteTask:

Public Member Functions
def	run (self, exposure)

Static Public Attributes
	ConfigClass = VignetteConfig

Detailed Description

Define a simple circular vignette pattern.

Definition at line 62 of file vignette.py.

Member Function Documentation

run()

def lsst.ip.isr.vignette.VignetteTask.run	(		self,
			exposure
	)

Generate circular vignette pattern.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to construct vignette for.

Returns
-------
polygon : `lsst.afw.Geom.Polygon`
    Polygon defining the boundary of the vignetted region.

Definition at line 68 of file vignette.py.

    def run(self, exposure):
        """Generate circular vignette pattern.
 
        Parameters
        ----------
        exposure : `lsst.afw.image.Exposure`
            Exposure to construct vignette for.
 
        Returns
        -------
        polygon : `lsst.afw.Geom.Polygon`
            Polygon defining the boundary of the vignetted region.
        """
 
        if self.config.doWriteVignettePolygon:
            theta = numpy.linspace(0, 2*numpy.pi, num=self.config.numPolygonPoints, endpoint=False)
            x = self.config.radius*numpy.cos(theta) + self.config.xCenter
            y = self.config.radius*numpy.sin(theta) + self.config.yCenter
            points = numpy.array([x, y]).transpose()
            polygon = afwGeom.Polygon([lsst.geom.Point2D(x1, y1) for x1, y1 in reversed(points)])
            return polygon
        else:
            return None

Member Data Documentation

ConfigClass

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

static

Definition at line 65 of file vignette.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/ip_isr/22.0.1-20-g32debb5+b8044ec9de/python/lsst/ip/isr/vignette.py