lsst.afw.cameraGeom.pupil.PupilFactory Class Reference

Public Member Functions
	__init__ (self, visitInfo, pupilSize, npix)
	getPupil (self, point)

Public Attributes
	visitInfo
	pupilSize
	npix
	pupilScale
	u
	v

Protected Member Functions
	_fullPupil (self)
	_cutCircleInterior (self, pupil, p0, r)
	_cutCircleExterior (self, pupil, p0, r)
	_cutRay (self, pupil, p0, angle, thickness)
	_centerPupil (self, pupil)

Static Protected Member Functions
	_pointLineDistance (p0, p1, p2)

Detailed Description

Pupil obscuration function factory for use with Fourier optics.

Parameters
----------
visitInfo : `lsst.afw.image.VisitInfo`
    Visit information for a particular exposure.
pupilSize : `float`
    Size in meters of constructed Pupil array.
    Note that this may be larger than the actual diameter of the
    illuminated pupil to accommodate zero-padding.
npix : `int`
    Constructed Pupils will be npix x npix.

Definition at line 49 of file pupil.py.

Constructor & Destructor Documentation

__init__()

lsst.afw.cameraGeom.pupil.PupilFactory.__init__	(		self,
			visitInfo,
			pupilSize,
			npix )

Definition at line 64 of file pupil.py.

    def __init__(self, visitInfo, pupilSize, npix):
        self.visitInfo = visitInfo
        self.pupilSize = pupilSize
        self.npix = npix
        self.pupilScale = pupilSize/npix
        u = (np.arange(npix, dtype=np.float64) - (npix - 1)/2) * self.pupilScale
        self.u, self.v = np.meshgrid(u, u)
 

Member Function Documentation

_centerPupil()

lsst.afw.cameraGeom.pupil.PupilFactory._centerPupil ( self, pupil )

protected

Center the illuminated portion of the pupil in array.

Parameters
----------
pupil : `Pupil`
    Pupil to modify in place

Definition at line 178 of file pupil.py.

    def _centerPupil(self, pupil):
        """Center the illuminated portion of the pupil in array.
 
        Parameters
        ----------
        pupil : `Pupil`
            Pupil to modify in place
        """
        def center(arr, axis):
            smash = np.sum(arr, axis=axis)
            w = np.where(smash)[0]
            return int(0.5*(np.min(w)+np.max(w)))
        ycenter = center(pupil.illuminated, 0)
        xcenter = center(pupil.illuminated, 1)
        ytarget = pupil.illuminated.shape[0]//2
        xtarget = pupil.illuminated.shape[1]//2
        pupil.illuminated = np.roll(np.roll(pupil.illuminated,
                                            xtarget-xcenter,
                                            axis=0),
                                    ytarget-ycenter,
                                    axis=1)

_cutCircleExterior()

lsst.afw.cameraGeom.pupil.PupilFactory._cutCircleExterior ( self, pupil, p0, r )

protected

Cut out the exterior of a circular region from a Pupil.

Parameters
----------
pupil : `Pupil`
    Pupil to modify in place
p0 : `pair`` of `float`
    2-tuple indicating region center.
r : `float`
    Circular region radius.

Definition at line 140 of file pupil.py.

    def _cutCircleExterior(self, pupil, p0, r):
        """Cut out the exterior of a circular region from a Pupil.
 
        Parameters
        ----------
        pupil : `Pupil`
            Pupil to modify in place
        p0 : `pair`` of `float`
            2-tuple indicating region center.
        r : `float`
            Circular region radius.
        """
        r2 = (self.u - p0[0])**2 + (self.v - p0[1])**2
        pupil.illuminated[r2 > r**2] = False
 

_cutCircleInterior()

lsst.afw.cameraGeom.pupil.PupilFactory._cutCircleInterior ( self, pupil, p0, r )

protected

Cut out the interior of a circular region from a Pupil.

Parameters
----------
pupil : `Pupil`
    Pupil to modify in place.
p0 : `pair`` of `float`
    2-tuple indicating region center.
r : `float`
    Circular region radius.

Definition at line 125 of file pupil.py.

    def _cutCircleInterior(self, pupil, p0, r):
        """Cut out the interior of a circular region from a Pupil.
 
        Parameters
        ----------
        pupil : `Pupil`
            Pupil to modify in place.
        p0 : `pair`` of `float`
            2-tuple indicating region center.
        r : `float`
            Circular region radius.
        """
        r2 = (self.u - p0[0])**2 + (self.v - p0[1])**2
        pupil.illuminated[r2 < r**2] = False
 

_cutRay()

lsst.afw.cameraGeom.pupil.PupilFactory._cutRay ( self, pupil, p0, angle, thickness )

protected

Cut out a ray from a Pupil.

Parameters
----------
pupil : `Pupil`
    Pupil to modify in place.
p0 : `pair`` of `float`
    2-tuple indicating ray starting point.
angle : `pair` of `float`
    Ray angle measured CCW from +x.
thickness : `float`
    Thickness of cutout.

Definition at line 155 of file pupil.py.

    def _cutRay(self, pupil, p0, angle, thickness):
        """Cut out a ray from a Pupil.
 
        Parameters
        ----------
        pupil : `Pupil`
            Pupil to modify in place.
        p0 : `pair`` of `float`
            2-tuple indicating ray starting point.
        angle : `pair` of `float`
            Ray angle measured CCW from +x.
        thickness : `float`
            Thickness of cutout.
        """
        angleRad = angle.asRadians()
        # the 1 is arbitrary, just need something to define another point on
        # the line
        p1 = (p0[0] + 1, p0[1] + np.tan(angleRad))
        d = PupilFactory._pointLineDistance((self.u, self.v), p0, p1)
        pupil.illuminated[(d < 0.5*thickness)
                          & ((self.u - p0[0])*np.cos(angleRad)
                             + (self.v - p0[1])*np.sin(angleRad) >= 0)] = False
 

_fullPupil()

lsst.afw.cameraGeom.pupil.PupilFactory._fullPupil ( self )

protected

Make a fully-illuminated Pupil.

Returns
-------
pupil : `Pupil`
    The illuminated pupil.

Definition at line 114 of file pupil.py.

    def _fullPupil(self):
        """Make a fully-illuminated Pupil.
 
        Returns
        -------
        pupil : `Pupil`
            The illuminated pupil.
        """
        illuminated = np.ones(self.u.shape, dtype=bool)
        return Pupil(illuminated, self.pupilSize, self.pupilScale)
 

_pointLineDistance()

lsst.afw.cameraGeom.pupil.PupilFactory._pointLineDistance ( p0, p1, p2 )

staticprotected

Compute the right-angle distance between the points given by `p0`
and the line that passes through `p1` and `p2`.

Parameters
----------
p0 : `tuple` of `numpy.ndarray`
    2-tuple of numpy arrays (x, y focal plane coordinates)
p1 : ``pair`` of `float`
    x,y focal plane coordinates
p2 : ``pair`` of `float`
    x,y focal plane coordinates

Returns
-------
distances : `numpy.ndarray`
    Numpy array of distances; shape congruent to p0[0].

Definition at line 89 of file pupil.py.

    def _pointLineDistance(p0, p1, p2):
        """Compute the right-angle distance between the points given by `p0`
        and the line that passes through `p1` and `p2`.
 
        Parameters
        ----------
        p0 : `tuple` of `numpy.ndarray`
            2-tuple of numpy arrays (x, y focal plane coordinates)
        p1 : ``pair`` of `float`
            x,y focal plane coordinates
        p2 : ``pair`` of `float`
            x,y focal plane coordinates
 
        Returns
        -------
        distances : `numpy.ndarray`
            Numpy array of distances; shape congruent to p0[0].
        """
        x0, y0 = p0
        x1, y1 = p1
        x2, y2 = p2
        dy21 = y2 - y1
        dx21 = x2 - x1
        return np.abs(dy21*x0 - dx21*y0 + x2*y1 - y2*x1)/np.hypot(dy21, dx21)
 

getPupil()

lsst.afw.cameraGeom.pupil.PupilFactory.getPupil	(		self,
			point )

Calculate a Pupil at a given point in the focal plane.

Parameters
----------
point : `lsst.geom.Point2D`
  The focal plane coordinates.

Returns
-------
pupil : `Pupil`
    The Pupil at ``point``.

Definition at line 72 of file pupil.py.

    def getPupil(self, point):
        """Calculate a Pupil at a given point in the focal plane.
 
        Parameters
        ----------
        point : `lsst.geom.Point2D`
          The focal plane coordinates.
 
        Returns
        -------
        pupil : `Pupil`
            The Pupil at ``point``.
        """
        raise NotImplementedError(
            "PupilFactory not implemented for this camera")
 

Member Data Documentation

npix

lsst.afw.cameraGeom.pupil.PupilFactory.npix

Definition at line 67 of file pupil.py.

pupilScale

lsst.afw.cameraGeom.pupil.PupilFactory.pupilScale

Definition at line 68 of file pupil.py.

pupilSize

lsst.afw.cameraGeom.pupil.PupilFactory.pupilSize

Definition at line 66 of file pupil.py.

u

lsst.afw.cameraGeom.pupil.PupilFactory.u

Definition at line 70 of file pupil.py.

v

lsst.afw.cameraGeom.pupil.PupilFactory.v

Definition at line 70 of file pupil.py.

visitInfo

lsst.afw.cameraGeom.pupil.PupilFactory.visitInfo

Definition at line 65 of file pupil.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/python/lsst/afw/cameraGeom/pupil.py