Brief Installation instructions
The straightforward way to install the library is to use the
following command for the pip package installer:
pip install zernpy
For updating the already installed 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 for more details about the package.
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 abstraction) and ZernPSF class (calculation 2D PSF for formed by the microscopic systems associated with the phase profile described by a Zernike polynomial) please follow the link to the API Dictionary on the navigation tab.
Development Note
This page, along with the "About" page, are also used to showcase my skills in frontend development. This one was styled using Tailwind classes. Thus, not all content and functionality on these pages are meant solely to reveal the features of the implemented 'zernpy' library.
Originally, this page had been developed using pure CSS styling. After finishing the dedicated development branch, almost all styling on this page is achieved by using Tailwind classes added through CDN.
Definition of a Zernike polynomial using various indexing schemes
Specify below the index (indices) for Zernike polynomial specification (see all listed schemes here).