ParameterizedWFE

class poppy.ParameterizedWFE(name='Parameterized Distortion', coefficients=None, radius=<Quantity 1. m>, basis_factory=None, **kwargs)

Bases: WavefrontError

Define an optical element in terms of its distortion as decomposed into a set of orthonormal basis functions (e.g. Zernikes, Hexikes, etc.). Included basis functions are normalized such that user-provided coefficients correspond to meters RMS wavefront aberration for that basis function.

Parameters:

coefficientsiterable of numbers

The contribution of each term to the final distortion, in meters RMS wavefront error. The coefficients are interpreted as indices in the order of Noll et al. 1976: the first term corresponds to j=1, second to j=2, and so on.

radiusfloat

Pupil radius, in meters. Defines the region of the input wavefront array over which the distortion terms will be evaluated. For non-circular pupils, this should be the circle circumscribing the actual pupil shape.

basis_factorycallable

basis_factory will be called with the arguments nterms, rho, theta, and outside.

nterms specifies how many terms to compute, starting with the j=1 term in the Noll indexing convention for nterms = 1 and counting up.

rho and theta are square arrays holding the rho and theta coordinates at each pixel in the pupil plane. rho is normalized such that rho == 1.0 for pixels at radius meters from the center.

outside contains the value to assign pixels outside the radius rho == 1.0. (Always 0.0, but provided for compatibility with zernike.zernike_basis and zernike.hexike_basis.)

Methods Summary

get_opd(wave)

Construct the optical path difference array for a wavefront error source as evaluated across the pupil for an input wavefront wave

Methods Documentation

get_opd(wave)

Construct the optical path difference array for a wavefront error source as evaluated across the pupil for an input wavefront wave

Parameters:

waveWavefront

Wavefront object with a coordinates method that returns (y, x) coordinate arrays in meters in the pupil plane