WfAlgorithm#

class lsst.ts.wep.estimation.WfAlgorithm#

Bases: ABC

Base class for wavefront estimation algorithms

Parameters:

...

Attributes Summary

history

requiresPairs

Whether the algorithm requires pairs to estimate Zernikes.

Methods Summary

estimateZk(I1[, I2, obs, nollIndices, ...])

Return the wavefront Zernike coefficients in meters.

Attributes Documentation

history#
requiresPairs#

Whether the algorithm requires pairs to estimate Zernikes.

Methods Documentation

estimateZk(I1, I2=None, obs=None, nollIndices=(np.int64(4), np.int64(5), np.int64(6), np.int64(7), np.int64(8), np.int64(9), np.int64(10), np.int64(11), np.int64(12), np.int64(13), np.int64(14), np.int64(15), np.int64(16), np.int64(17), np.int64(18), np.int64(19), np.int64(20), np.int64(21), np.int64(22)), instrument=None, startWithIntrinsic=True, returnWfDev=False, units='m', saveHistory=False)#

Return the wavefront Zernike coefficients in meters.

Parameters:

  • I1 (DonutStamp) – An Image object containing an intra- or extra-focal donut image.

  • I2 (DonutStamp, optional) – A second image, on the opposite side of focus from I1. (the default is None)

  • obs (ObservingConditions or None, optional) – Per-observation telescope pointing state (rotator angle, altitude). (the default is None)

  • nollIndices (Sequence, optional) – List, tuple, or array of Noll indices for which you wish to estimate Zernike coefficients. Note these values must be unique, ascending, and >= 4. (the default is indices 4-22)

  • instrument (Instrument, optional) – The Instrument object associated with the DonutStamps. (the default is the default Instrument)

  • startWithIntrinsic (bool, optional) – Whether to start the Zernike estimation process from the intrinsic Zernikes rather than zero. (the default is True)

  • returnWfDev (bool, optional) – If False, the full OPD is returned. If True, the wavefront deviation is returned. The wavefront deviation is defined as the OPD - intrinsic Zernikes. (the default is False)

  • units (str, optional) – Units in which the Zernike amplitudes are returned. Options are “m”, “nm”, “um”, or “arcsecs”. (the default is “m”)

  • saveHistory (bool, optional) – Whether to save the algorithm history in the self.history attribute. If True, then self.history contains information about the most recent time the algorithm was run. (the default is False)

Return type:

Tuple[ndarray, dict]

Returns:

  • np.ndarray – Zernike coefficients estimated from the image (or pair of images)

  • dict – Metadata containing extra output from wavefront estimation algorithm.