lsst.afw  22.0.1-41-g501672927+21a6849c81
Public Member Functions | Public Attributes | List of all members
lsst.afw.cameraGeom.pupil.PupilFactory Class Reference

Public Member Functions

def __init__ (self, visitInfo, pupilSize, npix)
 
def getPupil (self, point)
 

Public Attributes

 visitInfo
 
 pupilSize
 
 npix
 
 pupilScale
 
 v
 

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__()

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

Definition at line 64 of file pupil.py.

Member Function Documentation

◆ getPupil()

def 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.

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.

◆ 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: