07. List of helper functions in PyZDDE
Here is a list of extra functions available in PyZDDE beyond the data items defined in the ZEMAX manual for extensions. There are two types of helper functions -- general helper functions for common tasks and the ipz functions for better interactive use.
Please beware that this page is not updated that often. If you have forked/cloned/downloaded PyZDDE, you can check for the extra functions by running the script checkDataItemCompleteness.py in the directory PyZDDE\Test.
zSetPrimaryWave
zGetPrimaryWave
zGetNumField
zGetNumSurf
zGetNumWave
zGetImageSpaceNA
zOptimize2
zDDEClose
zSetTolRow
zGetTimeout
zSpiralSpot
zGetSeidelAberration
zLensScale (not complete yet)
zDDEInit
zSetMacroPath
zGetFieldTuple
zSetWaveTuple
zGetWaveTuple
zSetFieldTuple
zCalculateHiatus
zSetTimeout
zExecuteZPLMacro
zGetPupilMagnification
zGetPOP
zSetPOPSettings
zModifyPOPSettings
The ipz functions are geared for interactive use in IPython notebook.
ipzCaptureWindow
ipzCaptureWindowLQ
ipzGetTextWindow
ipzGetFirst
ipzGetPupil
ipzGetSystemAper
ipzGetLDE
ipzGetSurfaceData
This work by PyZDDE contributors is licensed under a Creative Commons Attribution 4.0 International License.
Based on a work at https://github.com/indranilsinharoy/PyZDDE.
