CircularAperture

class poppy.CircularAperture(name=None, radius=<Quantity 1. m>, pad_factor=1.0, planetype=PlaneType.unspecified, gray_pixel=True, **kwargs)[source]

Bases: AnalyticOpticalElement

Defines an ideal circular pupil aperture

Parameters:
namestring

Descriptive name

radiusfloat

Radius of the pupil, in meters. Default is 1.0

gray_pixelbool

Apply gray pixel approximation to return fractional transmission for edge pixels that are only partially within this aperture?

pad_factorfloat, optional

Amount to oversize the wavefront array relative to this pupil. This is in practice not very useful, but it provides a straightforward way of verifying during code testing that the amount of padding (or size of the circle) does not make any numerical difference in the final result.

planetypePlaneType, optional

Plane type for this optic. Default is PlaneType.unspecified.

Methods Summary

get_transmission(wave)

Compute the transmission inside/outside of the aperture.

Methods Documentation

get_transmission(wave)[source]

Compute the transmission inside/outside of the aperture.