Adding phase retrieval

[tobias-liaudat]

Summary

Closes #67. Closes #91. Closes #132.

Issue #66 requires the physical layer from #123.

This PR adds the phase retrieval capabilities including a new projection algorithm that takes into account the obscurations.

Added unit tests for the new projection function, tf_decompose_obscured_opd_basis, and the original PI_zernikes function.

Validation Test Reports

• The code was validated against the v1 version of WaveDiff, with the release v1.3.0 https://github.com/tobias-liaudat/wf-psf/tree/v1.3.0 using the same random seeds and getting the exact same metrics. The release v1.3.0 resolves Update Phase Retrieval code in old WaveDiff with Random Seed setting #91. Adding both metric log files as comparison:

  • metrics_wfv1_seed_v0.log
  • metrics_wfv2_seed_v0.log

• All unit tests passing (without requiring gpu).

• All code formatted with black.

Reviewer Checklist

Reviewers should tick the following boxes before approving and merging the PR.

• The PR targets the develop branch
• The PR is assigned to the developer
• The PR has appropriate labels
• The PR is included in appropriate projects and/or milestones
• The PR includes a clear description of the proposed changes
• If the PR addresses an open issue the description includes "closes #"
• The code and documentation style match the current standards
• Documentation has been added/updated consistently with the code
• All CI tests are passing
• API docs have been built and checked at least once (if relevant)
• All changed files have been checked and comments provided to the developer
• All of the reviewer's comments have been satisfactorily addressed by the developer
• All Validation tests for the reported error are passing
• I have reviewed the CI log to verify if any files require formatting with Black. If any files are found to be improperly formatted, I have provided comments indicating the need for formatting.