Welcome!
Installation instructions
The straightforward way to install the library - to use the following command for the pip package installer:
pip install zernpy
For updating the already install package use the command:
pip install --upgrade zernpy or pip install -U zernpy
The requirements for installation: Python version >= 3.8, libraries numpy, matplotlib and scipy.
Check the webpage of this library on the PyPi package index.
Import and class initialization
The basic import command for accessing Zernike polynomial class: from zernpy import ZernPol
Initialization of the ZernPol class instance: zp = ZernPol(m=-2, n=2)
This instance gives an access to the calculation methods related to the Zernike polynomials properties.
Other acceptable initialization parameters names: osa_index / noll_index / fringe_index or
for shortness osa / noll / fringe, e.g.:
zp = ZernPol(osa_index=3) or zp = ZernPol(osa=3)
Calculation methods
For getting information about this library, please, refer to the API Dictionary tab and README section from
page, or on the
repository.
For accessing the full list of implemented methods for ZernPol class (Zernike polynomial) and ZernPSF class
(calculation 2D PSF for formed by the microscopic systems associated with the phase profile described by the Zernike polynomial)
please follow the link to the API Dictionary on the left navigation tab.
This and "About" pages are also used for honing my skills in Frontend development.
Thus, not everything on this page is intended solely to reveal the features of the implemented library.